To make Colouring Cities a better and more collaborative platform, we strongly encourage all of our partners to keep their code as unified with the Core Platform as possible. This will help ensure consistency and enable data sharing between the various Colouring Cities projects, and will also allow us all to continue to improve the Core Platform.
By using Forks, GitHub will maintain a link between your project and the Core platform. This will allow you to see any changes that are made to the Core repository and easily synchronise those changes into your own code, as shown below (as well as allowing you to contribute some of your code back to the Core platform).
We recommend that you create a "Fork" of the colouring-core to create the repository for your Colouring Cities project, and then customise the code from the core platform to suit the needs of your projects.
This can be done by going to the Core Repository, clicking the 'Fork' button, as show below and then following the instructions.
On your project repository, you will then see that your project is forked from Colouring Core, and you will also be notified when changes are made to the Core platform, as shown in the example below.
You can click on "Sync Fork" and then "Update Branch" to pull the latest changes from Colouring Core into your own project.
When it comes to customising the Colouring Core platform for use in your country/city, we want to make this as easy as possible, while still maintaining the brand identity of the platform.
Where possible, customisations should be made using configuration files, rather than by modifying the source code. More information on the current configuration file setup can be found here. Please let us know (ideally by creating issues on the Core repository ) if there are other elements that you would like us to add into this configuration framework.