CONTRIBUTING: update for format requirements

This commit is contained in:
Dan Bungert 2023-07-21 16:53:47 -06:00
parent f5de7dd030
commit 93a34a64fa
1 changed files with 7 additions and 4 deletions

View File

@ -4,7 +4,10 @@ see:
* Contributors will need to have signed the * Contributors will need to have signed the
[CLA](https://ubuntu.com/legal/contributors/agreement). [CLA](https://ubuntu.com/legal/contributors/agreement).
* Prerequisites for running tests locally can be installed with `make aptdeps`. * Format, lint, unit, integration, and API tests should be passing.
* Lint, unit, integration, and API tests should be passing. To simulate that * format - either run `make format` or `pre-commit install`.
locally please run `make lint check`. This is a close approximation to what See [pre-commit](https://pre-commit.com/#install) for more details on that
is run in CI today. tool.
* all the rest - `make lint check`.
Prerequisites for running these locally can be installed with
`make aptdeps`.