diff options
-rw-r--r-- | CONTRIBUTING.md | 24 |
1 files changed, 21 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d11904f3..11d559a04 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,17 @@ # Contributing -Welcome to Navit! If you are interested in contributing to the [Navit code repo](README.md) +Welcome to Navit! We welcome contributions! + +If you are interested in contributing to the [Navit code repo](README.md) then checkout the [Wiki](https://wiki.navit-project.org/index.php/Main_Page) +and our [ReadTheDocs space](https://navit.readthedocs.io) When pushing a pull request, please make sure you follow our: * [programming guidelines](https://wiki.navit-project.org/index.php/Programming_guidelines) * [commit message guidelines](https://wiki.navit-project.org/index.php/Commit_guidelines) For more information on our development process, see: https://wiki.navit-project.org/index.php/Development + ## Submitting patches 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: @@ -18,17 +22,31 @@ Make sure you are familar with our (development tips)[https://wiki.navit-project If you found a bug, please open a [GitHub issue](https://github.com/navit-gps/navit/issues) 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 +### Contibuting via a Pull Request + +The easiest way to get started is to fork Navit, work on the feature and submit a pull request. - * Fork the [Github repository](https://github.com/navit-gps/navit) and clone it using `git clone` +Prepare your repository: + * Fork the [Github repository](https://github.com/navit-gps/navit) and clone it using `git clone` (note that we use the `trunk` + branch as our branch of reference for developments) + * always use a separate branch for your improvement: ` git checkout -b <name of your branch>` + +Enhance Navit: * Find the bug (and please address only one issue per patch!) and try to fix it + * always document new functions according to the doxygen standard discussed in the [programming guidelines](https://wiki.navit-project.org/index.php/Programming_guidelines) * Test test test if still compiles and the behaviour is as expected * Think about possible side effects (as performance, different settings, ...) + +Submit your work: * Get the newest Git Navit version (see [this documentation](https://help.github.com/en/articles/syncing-a-fork) on how to sync your fork) and apply your changes once more * Test if everything still works fine + * double check that you are on the correct branch with git status + * commit your change using our [commit message guidelines](https://wiki.navit-project.org/index.php/Commit_guidelines) + * push your branch (`git push origin <name of your branch>`) * [Create a pull request](https://help.github.com/articles/creating-a-pull-request/) on github * Wait to verify that all the tests in our CI finish successfully +If at some point you want to get write access to our repository, just [contact us](https://wiki.navit-project.org/index.php/Contacts). ### Review |