Everyone is welcome to contribute to OpenGlobus.
Please use an editor config from here: https://github.com/openglobus/openglobus/blob/master/.editorconfig
-
Branch must looks like this:
feature/<issue_id>_<custom_name>
orbugfix/<issue_id>_<custom_name>
-
Each commit must start with an issue ID like this
#<issue_id>
, so be sure that the issue is exists. -
Finally, all checks in PR must be approved and PR link must be added in the issue comments.
-
Please, make all checks are fine:
-
npm test
passes -
npm run api
passes -
npm run lint
passes -
npm run build
still works
-
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!
- TODO how to contribute to api docs