Thank you for your interest in contributing to Organic Maps (OM)!
There are many ways to contribute and OM needs a variety of talents: software engineers, graphic designers, translators, UI/UX experts, marketing/PR, etc.
See https://organicmaps.app/donate/
The simplest way to contribute is to submit an issue. Please check if there are no similar issues already submitted by someone else, and give developers as much information as possible: OS and application versions, list of actions leading to a bug, a log file produced by the app.
When using Organic Maps app on a device, use the built-in "Report a bug" option: on Android it creates a new e-mail with a log file attached. Your issue will be processed much faster if you send it to [email protected]. Enabling logs in Organic Maps settings on Android before sending the bug report also helps us a lot with debugging.
If you have some ideas or want to request a new feature, please start a discussion thread.
OM is available in 35 languages already, but some of them are incomplete and existing translations need regular updates as the app evolves. See translations instructions for details.
We strive to have a functional, cohesive and pleasant to the eye map rendering style. There is always something to improve, adding new map features, fine tuning the colour palette etc. And every time we add a new map feature/POI we need a good and free-to-use icon.
See styles and icons instructions for details.
Please follow instructions in INSTALL.md to set up your development environment and check the developer's guidelines. You will find a list of issues for new contributors here to help you get started with simple tasks. If you want to focus on the most important issues, please check this label or our Milestones.
Sometimes it's better to discuss and confirm your vision of the fix or implementation before working on an issue. Our main focus is on simplicity and convenience for everyone, not only for geeks.
We do not assign issues to first-time contributors. Any such request notifies our contributors and the development team, and creates unnecessary noise that distracts us from the work. Just make a PR - and it will be reviewed.
Reading everything in the docs folder of the repository is recommended.
All contributions to Organic Maps repository should be submitted via Github pull requests and signed-off with the Developers Certificate of Origin.
Each pull request is reviewed by OM maintainers to ensure its quality. Sometimes the review process even for smallest commits can be very thorough.
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
To contribute you must assure that you have read and are following the rules stated in the Developers Certificate of Origin (DCO). We have borrowed this procedure from the Linux kernel project to improve tracking of who did what, and for legal reasons.
To sign-off a patch, just add a line in the commit message saying:
Signed-off-by: Some Developer <[email protected]>
Git has a flag that can sign a commit for you. An example using it is:
git commit -s -m 'An example commit message'
Use your real name or on some rare cases a company email address, but we disallow pseudonyms or anonymous contributions.
The OM community abides by the CNCF code of conduct.
Please learn how to use git rebase to amend your commits
and have a clean history for your changes/branches.
Do not close/recreate Pull Requests if you want to edit commits. Use git rebase and git commit --amend,
or any git tool with a graphical interface (Fork for Mac is quite good) to make clean,
logical commits, properly signed with DCO.
- Directories structure
- C++ Style Guide.
- Java Style Guide.
- Objective-C Style Guide.
- Pull Request Guide.
- How to write a commit message.
For any questions about developing OM and relevant services - virtually about anything related, please contact us, we'll be happy to help.