archive-gh-me/openglobus
1
0
Fork 0
mirror of https://github.com/openglobus/openglobus.git synced 2025-12-08 19:25:27 +00:00
Code Issues Projects Releases Wiki Activity
openglobus/CONTRIBUTING.md
omahs b6ecaa8645
fix typo
2023-10-19 08:56:26 +02:00

1.1 KiB
Raw Blame History

Contributing to OpenGlobus

  1. Contributing Code
  2. Making Pull Requests
  3. Reporting Bugs
  4. Improving Documentation

Contributing Code

Everyone is welcome to contribute to OpenGlobus.

Please use an editor config from here: https://github.com/openglobus/openglobus/blob/master/.editorconfig

Making pull requests

  1. Branch must looks like this: feature/<issue_id>_<custom_name> or bugfix/<issue_id>_<custom_name>

  2. Each commit must start with an issue ID like this #<issue_id>, so be sure that the issue exists.

  3. Finally, all checks in PR must be approved and PR link must be added in the issue comments.

  4. Please, make all checks are fine:

    • npm test passes
    • npm run api passes
    • npm run lint passes
    • npm run build still works

Reporting Bugs

Feel free to report bug in the issues, please be more specific in the description. No need to put a point in the end of an issue sentence, it is a header!

Improving Documentation

  • TODO how to contribute to api docs