Submitting patches

We are happy that you would like to participate and help the Team improve Navit. To make this teamwork productive for all, we will guide you through this process:

Preparations

Make sure you are familiar with our Developer Overview, the codebase, and our guidelines. If you found a bug, please open a GitHub issue and include all relevant details so others can verify it and help isolate the defective code. Indicate that you intend to submit a patch.

Process

  1. Clone the codebase via GitHub

  2. Find the bug (address only one issue per patch) and fix it

  3. Run scripts/ci_sanity_check.sh and test your changes

  4. Consider possible side effects (performance, different settings, etc.)

  5. Pull the latest Git Navit version and re-apply your changes

  6. Test that everything still works

  7. Create a pull request on GitHub

Review

It may take some time for someone to review the pull request (you can ping via Contacts). If your changes are complex, raise new ideas, or still have minor issues, we may discuss them and ask you to submit an updated version.

See also