mirror of
https://github.com/enzet/map-machine.git
synced 2025-05-02 03:37:08 +02:00
33 lines
1.6 KiB
Text
33 lines
1.6 KiB
Text
\1 {Contributing} {contributing}
|
|
|
|
Thank you for your interest in the Map Machine project. Since the primary goal of the project is to cover as many tags as possible, the project is crucially depend on contributions as OpenStreetMap itself.
|
|
|
|
\2 {Suggest a tag to support} {}
|
|
|
|
Please, create an issue with \m {icon} label.
|
|
|
|
/*
|
|
\2 {Add an icon} {}
|
|
*/
|
|
|
|
\2 {Report a bug} {}
|
|
|
|
Please, create an issue with \m {bug} and \m {generator} labels.
|
|
|
|
\2 {Fix a typo in documentation} {}
|
|
|
|
This action is not that easy as it supposed to be. We use \ref {http://github.com/enzet/Moire} {Moire} markup and converter to automatically generate documentation for GitHub, website, and \ref {http://wiki.openstreetmap.org/} {OpenStreetMap wiki}. That's why editing Markdown files is not allowed. To fix a typo, open corresponding Moire file in \m {doc} directory (e.g. \m {doc/readme.moi} for \m {README.md}), modify it, and run \m {python map_machine/moire_manager.py}.
|
|
|
|
\2 {Modify the code} {}
|
|
|
|
First of all, configure your workspace.
|
|
|
|
\list
|
|
{Install formatter, linter and test system\: \m {pip install black flake8 pytest}.}
|
|
{Be sure to run \m {git config --local core.hooksPath data/githooks} to enable Git hooks.}
|
|
|
|
\3 {Code style} {code-style}
|
|
|
|
We use \ref {http://github.com/psf/black} {Black} code formatter with maximum 80 characters line lenght for all Python files within the project. Reformat a file is as simple as \m {black -l 80 \formal {file name}}.
|
|
|
|
If you create new Python file, make sure you add \m {__author__ = "\formal {first name} \formal {second name}"} and \m {__email__ = "\formal {author e-mail}"} string variables.
|