Skip to content

Latest commit

 

History

History
95 lines (61 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

95 lines (61 loc) · 3.24 KB

Contributing

Thank you for your interest in contributing to Organic Maps!

How Can I Contribute?

There are many ways to contribute.

Donate

See https://organicmaps.app/donate/

Bug Reports

The simplest way to contribute is to submit an issue. Please 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 the Organic Maps app on a device, use the built-in "Report a bug" option: 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].

Feature Requests

If you have some ideas or want to request a new feature, please start a discussion thread.

Translations

If you want to improve app translations or add more search synonyms, please update strings.txt file, run ./tools/unix/generate_localizations.sh and create a Pull Request.

Use ./tools/python/strings/google_translate.py to generate initial strings for all languages:

cd tools/python/strings
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
./google_translate.py "Hello"

Code Contributions

Please follow instructions in INSTALL.md to set up your development environment. Create and submit a Pull Request with your changes.

Process

Pull Requests

All contributions to Organic Maps source code should be submitted via github pull requests. Each pull request is reviewed by OMaps maintainers, to ensure consistent code style and quality. Sometimes the review process even for smallest commits can be very thorough. Please follow the developer guidelines.

Legal Requirements

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.

Code of Conduct

The Organic Maps community abides by the CNCF code of conduct.

Guidelines

Questions?

For any questions about developing Organic Maps and relevant services - virtually about anything related, please contact us, we'll be happy to help.