We want to make contributing to this project as approachable and transparent as possible.
pgRouting has adopted a Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.
We use GitHub to sync code to and from our internal repository. We'll use GitHub to track issues and feature requests, as well as accept pull requests.
We actively welcome your pull requests.
- Fork the repo and create your branch from
develop. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- “sign off” your commits to indicate that you agree to the terms of the DCO.
Before we can include your contribution in the pgRouting project, you need to give us your permission. To indicate that you agree to the terms of the DCO, you “sign off” your contribution by adding a line with your name and e-mail address to every Git commit message:
git commit --signoff
We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. If possible please provide a minimal demo of the problem.
Start reading our code and you'll get the hang of it. We optimize for readability: This is open source software. Consider the people who will read your code, and make it look nice for them.
- We indent using four spaces (soft tabs)
- We use cpplint for linting C/C++ code.
By contributing to pgRouting, you agree that your contributions will be licensed
under the license indicated in the repositories LICENSE file.
This document was adapted from the open-source contribution guidelines for Facebook's Draft