From bed7b43fd9ac549df8c0efb8fa0d841cb507eff6 Mon Sep 17 00:00:00 2001 From: Mike Simpson Date: Fri, 14 Apr 2023 14:13:38 +0100 Subject: [PATCH] Update CONTRIBUTING.md --- CONTRIBUTING.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 562e2b4d..ab72ceab 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,14 +1,17 @@ ## 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-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` ## 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`. + +## '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.