@@ -24,22 +24,20 @@ This will install the repo version of
2424` graphene-pydantic ` and then install the development dependencies. Once that
2525has completed, you can start developing.
2626
27- ## Contributor License Agreement
27+ ### Running tests
2828
29+ To run the tests locally, you can simply run ` pytest ` .
2930
30- We require all contributors to sign the [ Upside CLA] ( ./CONTRIBUTOR_LICENSE_AGREEMENT.md ) .
31+ In CI, we run tests using [ nox] ( https://nox.thea.codes/en/stable/index.html ) ,
32+ which runs the test multiple times using different package versions. Run
33+ ` poetry run nox ` to run the entire test suite.
3134
32- In simple terms, the CLA affirms that the work you're contributing is original,
33- that you grant Upside permission to use that work (including license to any
34- patents necessary), and that Upside may relicense your work for our commercial
35- products if necessary. Note that this description is a summary and the specific
36- legal terms should be read directly in the CLA.
35+ ### Pre-commit, linting
3736
38- The CLA does not change the terms of the standard open source license used by
39- our software. You are still free to use our projects within your own projects or
40- businesses, republish modified source, and more. Please reference the license of
41- this project to learn more.
37+ We use [ pre-commit] ( https://pre-commit.com/ ) to manage git pre-commit hooks. This
38+ will fail linting locally so you can see errors before they run in CI. Run ` pre-commit install `
39+ to install the hooks.
4240
43- To sign the CLA, open a pull request as usual. If you haven't signed the CLA
44- yet, we cannot merge any pull request until the CLA is signed. You only need to
45- sign the CLA once .
41+ To run them manually, run ` pre-commit run --all-files ` .
42+
43+ To skip them when committing, run ` git commit ` with the ` --no-verify ` flag .
0 commit comments