From a5054184a172da0b9abd2470946bb15ab5fb0516 Mon Sep 17 00:00:00 2001 From: John Costa Date: Thu, 28 Mar 2013 16:32:31 -0400 Subject: [PATCH] move documentation changes to reStructuredText docs under website. https://github.com/dotcloud/docker/issues/42 --- docs/sources/contributing/contributing.rst | 24 +++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/sources/contributing/contributing.rst b/docs/sources/contributing/contributing.rst index d7f0258439..689c4207ce 100644 --- a/docs/sources/contributing/contributing.rst +++ b/docs/sources/contributing/contributing.rst @@ -51,8 +51,26 @@ documenting your bug report or improvement proposal. 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. -Write tests +Conventions ~~~~~~~~~~~ -Golang has a great testing suite built in: use it! Take a look at -existing tests for inspiration. +Fork the repo and make changes on your fork in a feature branch: + +- If it's a bugfix branch, name it XXX-something where XXX is the number of the issue +- 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. + +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. + +Submit any relevant updates or additions to documentation. + +Add clean code: + +- Universally formatted code promotes ease of writing, reading, and maintenance. We suggest using gofmt before committing your changes. There's a git pre-commit hook made for doing so. +- curl -o .git/hooks/pre-commit https://raw.github.com/edsrzf/gofmt-git-hook/master/fmt-check && chmod +x .git/hooks/pre-commit + +Pull requests descriptions should be as clear as possible and include a +referenced to all the issues that they address. + +Add your name to the AUTHORS file.