colouring-montreal/CONTRIBUTING.md
2023-04-14 14:13:38 +01:00

1.3 KiB

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 used branch fix/681-land-use-edit referencing #681
  • PR 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) when referring to a specific deployment.
  • with "Colouring Cities" when referring to the wider CCRP.