Browse code

incorporate feedback from https://github.com/dotcloud/docker/issues/42

John Costa authored on 2013/03/26 22:17:44
Showing 2 changed files
... ...
@@ -11,3 +11,4 @@ Ken Cochrane
11 11
 Charles Hooper
12 12
 Guillaume Charmes
13 13
 Daniel Mizyrycki
14
+John Costa
... ...
@@ -215,11 +215,25 @@ Please take a moment to check that an issue doesn't already exist documenting yo
215 215
 If it does, it never hurts to add a quick "+1" or "I have this problem too". This will help prioritize the most common problems and requests.
216 216
 
217 217
 
218
-### Write tests
218
+### Conventions
219 219
 
220
-Golang has a great testing suite built in: use it! Take a look at existing tests for inspiration.
220
+Fork the repo and make changes on your fork in a feature branch.
221 221
 
222
+- If it's a bugfix branch, name it XXX-something where XXX is the number of the issue
223
+- If it's a feature branch, create an enhancement issue to announce your intentions, and name it XXX-something where XXX is the number of the issue.
222 224
 
225
+Submit unit tests for your changes.  Golang has a great testing suite built in: use it! Take a look at existing tests for inspiration. Run the full test suite against your change and the master.
226
+
227
+Submit any relevant updates or additions to documentation.
228
+
229
+Add clean code:
230
+
231
+- Universally formatted code promotes ease of writing, reading, and maintenance.  We suggest using gofmt before commiting your changes.  There's a git pre-commit hook made for doing so.
232
+- curl -o .git/hooks/pre-commit https://raw.github.com/edsrzf/gofmt-git-hook/master/fmt-check && chmod +x .git/hooks/pre-commit
233
+
234
+Pull requests descriptions should be as clear as possible and include a referenced to all the issues that they address.
235
+
236
+Add your name to the AUTHORS file.
223 237
 
224 238
 Setting up a dev environment
225 239
 ----------------------------