Skip to content

Latest commit

 

History

History
61 lines (36 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

61 lines (36 loc) · 1.94 KB
Raw

Contributing

This project is licensed under GPL v3, see LICENSE.txt for more details.

All contributions are welcome, but must follow this guide.

Translations

See: https://crowdin.com/project/abc-map

Before starting

Ensure that your idea is a need that will be shared by other people.

Ensure that your idea cannot fit in a custom data processing module

Open an issue to discuss it and to avoid unnecessary or duplicate work.

If not already done, please check the bottomless well too !

Please read the documentation/ folder before. Don't worry, it's a quick read. You will learn how to set up your workstation and to start Abc-Map locally.

Getting started 🏁

  • Fork and clone Abc-Map
  • Create a new branch, e.g: feature/better-drawing-tools, fix/user-authentication
  • Let the code genius speak

For details, have a look at Forking Workflow.

Before submitting code

  • Try it, smarten it
  • Add automated tests (unit tests and/or integration tests)
  • Proofread it

Submit your code

Create a Merge Request, target this repository, master branch.

Pipeline will not pass on a Gitlab shared runner (see https://gitlab.com/abc-map/abc-map/-/issues/4), please ensure that at least all tests pass.

Master branch is production ready

All code merged in master must be ready to deploy.

In order to make this possible, all contributions must be carefully reviewed. A code review must include:

  • Meticulous proofreading and understanding of code
  • Manual tests of features
  • Automated test inspection

What practices are discouraged ?

  • Dead code, useless code, commented code
  • Non functional code
  • Add a dependency that a function can replace

Since no one is paid yet, code reviews take time.