diff options
| author | Matthew Somerville <matthew@mysociety.org> | 2015-10-23 12:55:38 +0100 |
|---|---|---|
| committer | Matthew Somerville <matthew@mysociety.org> | 2015-10-23 17:32:35 +0100 |
| commit | ac39951581a0eefe069c8a707bb89977227d0bce (patch) | |
| tree | 4efe78f010421296d0b0ff059357d9b3cb26b79d /CONTRIBUTING.md | |
| parent | da52879e407ffa683567e349c744f30171065a76 (diff) | |
Version 1.7.v1.7
Include new contributing document.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..6682044c6 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing to FixMyStreet + +Thanks for contributing to FixMyStreet! Here is a quick summary of where to +find information: + +* [Documentation](http://fixmystreet.org) – including development installation +with Vagrant or manually, and information on customisation; +* [Coding standards](https://mysociety.github.io/coding-standards.html); +* [Ticket management](https://waffle.io/mysociety/fixmystreet) – please see +below for details on our workflow; +* [Community help](http://fixmystreet.org/community/) – if you are having +trouble, we have a number of places you can ask for assistance. + +Workflow +-------- + +* Icebox – Untriaged tickets, or those that are on the back burner; +* Backlog – Tickets we would like to do at some point; +* Current – Scheduled to be done in the current sprint; +* In progress – Currently being worked on; +* Reviewing – Work has been done and is awaiting review or being reviewed; +* Reviewed – The PR has been reviewed, and so needs either more work (and then + put back in Reviewing for further review), or to be merged and deployed; +* Done – Tickets placed here will be automatically closed. + +If you are working on a ticket or reviewing a pull request, try and assign it +to yourself so others know it is taken. + +Workflow tips +------------- + +If you create a new branch that starts with “NNN-” or “NNN_” or has “#NNN” +anywhere in it, where NNN is a GitHub issue number, then pushing that branch +will automatically move an issue to In progress. + +When you create a pull request, if it fixes a current issue put +“Fixes/closes/resolves #NNN” in the PR title/description, and then the PR will +be linked with the issue. If it is only linked to an issue, but +doesn’t fix it, put “connect/connects/connected to #NNN” in the details. + +New PRs from collaborators will appear in Reviewing, and new PRs from +non-collaborators will appear in Current (so that they are hopefully seen and +triaged quickly). |