a_adli/colouring-montreal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Mike Simpson 2023-04-14 14:13:38 +01:00 committed by GitHub
parent 63f7bd4e70
commit bed7b43fd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
CONTRIBUTING.md
View File

@ -1,14 +1,17 @@
## Branch naming ## Branch naming
Branch names should indicate type of work. For fixes also related issue should be mentioned. 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`. The format is `fix/123-short-description`, `feature/description` or `feature/123-short-description`.
For example For example
* [PR 648](https://github.com/colouring-cities/colouring-core/pull/684) used branch `fix/681-land-use-edit` referencing [#681](https://github.com/colouring-cities/colouring-core/issues/681) * [PR 648](https://github.com/colouring-cities/colouring-core/pull/684) used branch `fix/681-land-use-edit` referencing [#681](https://github.com/colouring-cities/colouring-core/issues/681)
* [PR 625](https://github.com/colouring-cities/colouring-core/pull/625) used branch `feature/verification` * [PR 625](https://github.com/colouring-cities/colouring-core/pull/625) used branch `feature/verification`
## Commits ## Commits
Commit messages should start from an upper case. So `Change public ownership sources field to array` is preferred over `change public ownership sources field to array`. Commit messages should start from an upper case. So `Change public ownership sources field to array` is preferred over `change public ownership sources field to array`.
## 'Generifying' the Platform
We are still in the process of moving from the Colouring London prototype to the Colouring Cities Core platform. If you notice any london-specific text or variables in the Core code, we would be grateful if you could flag those up, either by raising an issue so that we can fix them or by fixing them yourself and creating a Pull Request.
Ideally, any references to London should be replaced, either:
- with the City Name parameter (specified in [docs/configuring-colouring-cities](docs/configuring-colouring-cities.md)) when referring to a specific deployment.
- with "Colouring Cities" when referring to the wider CCRP.