Permalink
Browse files

add commit message section

  • Loading branch information...
1 parent 043cd82 commit bbbfe808bde439f4836a8306a9164bf49e6ab518 @JamesChevalier JamesChevalier committed Dec 7, 2012
Showing with 15 additions and 1 deletion.
  1. +15 −1 git.md
View
16 git.md
@@ -1,9 +1,23 @@
# Using git
-This assumes the repository has a `staging` branch, which was created off the `master` branch.
+## Git Commit Messages
+
+* If the commit involves migrations, precede the commit message with `(M)`
+* End each commit with a reference to the ticket number, if applicable, in the format `refs #5555`
+* Keep Gem updates in separate commits
+* For Gem update commits, the commit message format is:
+
+```
+gem update:
+
+[gem-name] to [version]
+[gem-name] to [version]
+```
## Git Branch Usage
+This assumes the repository has a `staging` branch, which was created off the `master` branch.
+
1. Create a new branch for your feature, off of the `master` branch. Ideally, this branch name would follow a `name-ticketnumber` format, like `slider-navigation-4856`
2. Develop new features/fixes in this new `name-ticketnumber` branch
3. When you need your feature on staging, checkout the `staging` branch, and merge in your `name-ticketnumber` branch

0 comments on commit bbbfe80

Please sign in to comment.