Files
bumble_mirror/docs/mkdocs/src/development/contributing.md
Gilles Boccon-Gibod c2959dadb4 formatting and linting automation
Squashed commits:
[cd479ba] formatting and linting automation
[7fbfabb] formatting and linting automation
[c4f9505] fix after rebase
[f506ad4] rename job
[441d517] update doc (+7 squashed commits)
[2e1b416] fix invoke and github action
[6ae5bb4] doc for git blame
[44b5461] add GitHub action
[b07474f] add docs
[4cd9a6f] more linter fixes
[db71901] wip
[540dc88] wip
2022-12-15 23:07:17 -08:00

950 B

CONTRIBUTING TO THE PROJECT

To contribute some code to the project, you will need to submit a GitHub Pull Request (a.k.a PR). Please familiarize yourself with how that works (see GitHub Pull Requests)

You should follow the project's code style, and pre-check your code before submitting a PR. The GitHub project is set up with some Actions that will check that a PR passes at least the basic tests and complies with the coding style, but it is still recommended to check that for yourself before submitting a PR. To run the basic checks (essentially: running the tests, the linter, and the formatter), use the project.pre-commit invoke command, and address any issues found:

$ invoke project.pre-commit