Skip to content

Commit

Permalink
CONTRIBUTING: update for format requirements
Browse files Browse the repository at this point in the history
  • Loading branch information
dbungert committed Jul 25, 2023
1 parent 5b91e36 commit 3e1173f
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -4,7 +4,10 @@ see:

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

0 comments on commit 3e1173f

Please sign in to comment.