Add branch naming guidelines
@@ -48,7 +48,7 @@ $ /gradlew -Pversion=0.2.0-rc.4-SNAPSHOT publishToMavenLocal
1. [Fork](https://github.com/MarquezProject/marquez-java/fork) and clone the repository
2. Make sure all tests pass locally: `./gradlew test`
-3. Create a new branch: `git checkout -b my-cool-new-branch`
+3. Create a new [branch](#branching): `git checkout -b feature/my-cool-new-feature`
4. Make change on your cool new branch
5. Write a test for your change
6. Make sure `.java` files are formatted: `./gradlew spotlessJavaCheck`
@@ -65,6 +65,30 @@ To ensure your pull request is accepted, follow these guidelines:
* [Keep diffs small](https://graysonkoonce.com/stacked-pull-requests-keeping-github-diffs-small) and self-contained
* If your change fixes a bug, please [link the issue](https://help.github.com/articles/closing-issues-using-keywords) in your pull request description
+# Branching
+
+* Use a _group_ at the beginning of your branch names
+
+ ```
+ wip Work on a feature is still in progress
+ feature Add or expand a feature
+ bug Fix a bug
+ ```
+
+ _For example_:
+
+ ```
+ wip/my-cool-new-wip-feature
+ feature/my-cool-new-feature
+ feature/my-other-cool-new-feature
+ bug/my-bug-fix
+ bug/my-other-bug-fix
+ ```
+
+* Choose _short_ and _descriptive_ branch names
+* Use dashes (`-`) to separate _words_ in branch names
+* Use _lowercase_ in branch names
+
# Resources
* [How to Contribute to Open Source](https://opensource.guide/how-to-contribute)
