Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 3.3 KB
Raw

Submit a new issue only if you are sure it is a missing feature or a bug. Otherwise, discuss the topic first. For new translations or fixes to existing translations, please refer to this documentation.

Issues for newcomers are tagged with 'good first issue' and documentation issues are tagged with 'documentation'.

We love pull requests. Here's a quick guide:

  1. Fork the repo and create a branch for your new feature or bug fix.

  2. Run the tests. We only take pull requests with passing tests: mvn clean test verify

  3. Add at least one test for your change. Only refactoring and documentation changes require no new tests. Also make sure you submit a change specific to exactly one issue. If you have ideas for multiple changes please create separate pull requests.

  4. Make the test(s) pass.

  5. Push to your fork and submit a pull request. A button should appear on your fork its github page afterwards.

License Agreement

For contributions like pull requests, bug fixes and translations please read the GraphHopper License Agreement, which includes our contributor covenant code of conduct. Send us an email with the signed print out of this CLA. Or, if you prefer the faster electronically method via signaturit.com, please send us an email with a request for this - keep in mind that this requires storing your Email there. The same applies if you want to sign a CLA for your whole company.

Note, our CLA does not influence your rights on your contribution but it makes sure for others that you agree to the Apache License, Version 2. After this you'll appear in the contributors list and your pull request can also be discussed technically.

Read more in this issue why it is not that easy to make this CLA-signing process simpler for first-time contributors and maintainers.

For companies that would like that their developers work for us, we need an additional corporate CLA signed.

Code formatting

We use IntelliJ defaults and a very similar configuration for NetBeans defined in the root pom.xml. For eclipse there is this configuration. Also for other IDEs it should be simple to match:

  • Java indent is 4 spaces
  • Line width is 100 characters
  • The rest is left to Java coding standards but disable "auto-format on save" to prevent unnecessary format changes.
  • Currently we do not care about import section that much, avoid changing it
  • Unix line endings (should be handled via git)
  • See discussion in #770

And in case we didn't emphasize it enough: we love tests!