Skip to content

Contributing

This site documents city_metrix as a user of the package. If you want to contribute new layers, metrics, or city boundaries to the project, see the full Developer Guide in the repository, which covers:

  • The package structure and how layers/metrics fit together internally.
  • Step-by-step instructions for adding a new data layer.
  • Step-by-step instructions for adding a new indicator/metric.
  • How to add new cities to the shared boundaries dataset.
  • Running the test suite.

For pull request process and review guidelines, see PR Review and the main README.