Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

21 lines (14 loc) · 1.55 KB
Raw

Thanks for using OSMnx and for considering contributing to it!

If you've found an error:

  • read the error message and documentation
  • search through the open issues and closed issues first
  • if the problem is with a dependency of this project, open an issue on the dependency's repo
  • if the problem is with OSMnx and you can fix it simply, please submit a PR
  • if the problem persists, please open an issue in the issue tracker filling out all sections of the template, including a minimal working example to reproduce the problem

If you have a feature proposal or want to contribute:

  • post your proposal on the issue tracker so we can review it together (some proposals may not be a good fit for the project)
  • fork the repo, make your change (adhering to OSMnx's existing coding, commenting, and docstring styles), test it, and submit a PR
  • respond to code review

If this is a general question rather than an error or feature proposal:

Every piece of software is a work in progress. This project is the result of many hours of work contributed freely by myself and the many people that build the projects it depends on. Thank you for contributing!