Submitting patches

From Navit's Wiki
Revision as of 12:19, 23 October 2013 by Usul (talk | contribs) (my first ideas about the topic)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

We are very happy that you like to participate and help the team to improve Navit :) To make this teamwork a pleasure for all, we will try to guide you trough this process:

preparations

Make sure you are familar with our development, learned about the codebase and our guidelines. If you found a bug, please open a Trac ticket and bring up all details so others can check them and help you on isolating the defective code. Point out that you like to submit a patch.

process

  1. Checkout the codebase via SVN
  2. Find the bug (and please address only one issue per patch!) and try to fix it
  3. Test test test if still compiles and the behaviour is as aspected
  4. Think about possible sideeffects (as performance, different settings, ...)
  5. get the newest SVN Navit version and apply your changes once more
  6. Test if everything still works fine
  7. create an SVN diff patch file
  8. attach them to your Trac ticket
  9. add 'patches' keyword to the ticket

review

It might take some time, till somebody reviews the patch (maybe give a ping via Contacts). If your changes are more complex, catch up new ideas, or still has some minor problems, it might be discussed and we will please you to submit an updated version/adapt your changes.

So that's it, you helped Navit to go one step forward. Thank you very much :)

See also