Merge pull request #692 from colouring-london/feature/document_style

Document naming style
This commit is contained in:
Mateusz Konieczny 2021-11-12 15:17:04 +01:00 committed by GitHub
commit bddcab296a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

14
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,14 @@
## Branch naming
Branch names should indicate type of work. For fixes also related issue should be mentioned.
The format is `fix/123-short-description`, `feature/description` or `feature/123-short-description`.
For example
* [PR 648](https://github.com/colouring-london/colouring-london/pull/684) used branch `fix/681-land-use-edit` referencing [#681](https://github.com/colouring-london/colouring-london/issues/681)
* [PR 625](https://github.com/colouring-london/colouring-london/pull/625) used branch `feature/verification`
## Commits
Commit messages should start from an upper case. So `Change public ownership sources field to array` is preferred oved `change public ownership sources field to array`.