Version Details
@@ -16,15 +32,21 @@ ### Style Guide ❯ Added the initial style guide [introduction][src-introdcution], information about the [structural split of changes][src-structural-split], [bad practices][src-structural-split-bad-practices] and the main chapter about [commit messages][src-commit-messages] with the [summary][src-commit-messages-summary], [body][src-commit-messages-body] and [footer][src-commit-messages-footer] elements and their [structure][src-commit-messages-structure]. (#1 in PR #2) +[arcver]: https://github.com/arcticicestudio/arcver [checkstyle-github]: https://github.com/checkstyle/checkstyle [checkstyle-jetbrains-plugin]: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea [checkstyle-version]: https://github.com/checkstyle/checkstyle/releases/tag/checkstyle-8.0 +[gitflow]: http://nvie.com/posts/a-successful-git-branching-model/ [scrot-ide-setup-intellij-checkstyle-activate]: https://raw.githubusercontent.com/arcticicestudio/styleguide-java/develop/src/assets/scrot-ide-setup-intellij-checkstyle-activate.png -[src-introdcution]: https://github.com/arcticicestudio/styleguide-git#introduction -[src-structural-split]: https://github.com/arcticicestudio/styleguide-git#structural-split-of-changes -[src-structural-split-bad-practices]: https://github.com/arcticicestudio/styleguide-git#bad-practices +[src-branch-naming]: https://github.com/arcticicestudio/styleguide-git#branch-naming +[src-branch-naming-core]: https://github.com/arcticicestudio/styleguide-git#core-branches +[src-branch-naming-story]: https://github.com/arcticicestudio/styleguide-git#story-branches [src-commit-messages]: https://github.com/arcticicestudio/styleguide-git#commit-messages -[src-commit-messages-structure]: https://github.com/arcticicestudio/styleguide-git#elements-and-their-structure -[src-commit-messages-summary]: https://github.com/arcticicestudio/styleguide-git#message-summary [src-commit-messages-body]: https://github.com/arcticicestudio/styleguide-git#message-body [src-commit-messages-footer]: https://github.com/arcticicestudio/styleguide-git#message-footer +[src-commit-messages-structure]: https://github.com/arcticicestudio/styleguide-git#elements-and-their-structure +[src-commit-messages-summary]: https://github.com/arcticicestudio/styleguide-git#message-summary +[src-introdcution]: https://github.com/arcticicestudio/styleguide-git#introduction +[src-structural-split]: https://github.com/arcticicestudio/styleguide-git#structural-split-of-changes +[src-structural-split-bad-practices]: https://github.com/arcticicestudio/styleguide-git#bad-practices +[src-tags]: https://github.com/arcticicestudio/styleguide-git#tags diff --git a/README.md b/README.md index ff6bc55..e7431cb 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@
The Arctic Ice Studio Git Style Guide.
--- -To present [Git commits](https://git-scm.com/docs/git-commit) in an organized, standardized, and easy-to-read manner, this official style guide describes how the content should be structured, organized, spelled and formatted in all Arctic Ice Studio projects. +To present Git [commits](https://git-scm.com/docs/git-commit) and [branches](https://git-scm.com/docs/git-branch) in an organized, standardized, and easy-to-read manner, this official style guide describes how the content should be structured, spelled and formatted in all Arctic Ice Studio projects. There are only some strict rules but mostly guidelines since we are more interested in content than formatting and the review process may help contributors to conform to this guide later on. @@ -75,10 +77,53 @@ This metadata block **must contain the GitHub issue ID** and is **separated from **Multiple issues are separated by a comma** and **additional references** can be added in the next lines. -## Development +## Branch Naming + +> A branch should reflect the story of the commits it contains using a valuable and useful name to clarify its purpose during the development lifecycle and the persistency in the history. + +Arctic Ice Studio follows the [gitflow][gitflow] branching model with the deviations and additional conventions described below. + +Branches are an important major component for building open source projects regardless of the size. A well maintained branch merge story in the history will help to increase the long-term overall quality. + +### Core Branches + +The two infinite development lifecycle core branches must be lowercase named `master` and `develop`. + +### Story Branches + +The lowercase name of a limited development lifecycle story branch must reflect the *type* separated by a slash from the *issue ID* and followed by the short and descriptive *title* using hypen delimiters. + +`