From 16df818dbb6a11e2a2b0c80bd38163f862f28181 Mon Sep 17 00:00:00 2001 From: Mateusz Konieczny Date: Sun, 7 Nov 2021 20:22:56 +0100 Subject: [PATCH] Document naming style --- CONTRIBUTING.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..5375755e --- /dev/null +++ b/CONTRIBUTING.md @@ -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`.