From bfbf3f4434d989eab2198f31c665289fcb5b51a0 Mon Sep 17 00:00:00 2001 From: Tom Gallacher Date: Fri, 14 Oct 2016 12:25:04 +0100 Subject: [PATCH] Introducing a contribution guide --- CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5ff7e8bf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +## Development Workflow + +### Small Feature Development + +Contributors who have write access to the repository will practise continuous +delivery (CD as known from now on in this document). + +We will define CD in this document as a method of developing a feature per commit +with an encapsulating test that proves that the functionality is working, the +contributor will test their code locally and if all is passing will push to *master*. + +For contributors that do not have write access, follow the same conventions but +open a Pull Request instead. + +### Large changesets + +When larger changes need to be made, or the work that is carried out spans multiple +components / services of the application at the same time a single commit will +not suffice. + +In this scenario, the contributor should open a pull request instead. + +## Commit messages + +Follow [Git blessed](http://chris.beams.io/posts/git-commit/) + +1. Separate subject from body with a blank line +2. Limit the subject line to 50 characters +3. Capitalize the subject line +4. Do not end the subject line with a period +5. Use the imperative mood in the subject line +6. Wrap the body at 72 characters +7. Use the body to explain what and why vs. how