Skip to content

Commit 0a106eb

Browse files
committed
clarify how to run checks
1 parent 53ed97e commit 0a106eb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

Diff for: CONTRIBUTING.md

+6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,13 @@
1616
## Writing Code
1717

1818
1. Write some code and make sure it's covered by unit tests. All unit tests are in the `tests` directory and the file structure should mirror the structure of the source code in the `openapi_python_client` directory.
19+
20+
### Run Checks and Tests
21+
1922
2. When in a Poetry shell (`poetry shell`) run `task check` in order to run most of the same checks CI runs. This will auto-reformat the code, check type annotations, run unit tests, check code coverage, and lint the code.
23+
24+
### Rework end to end tests
25+
2026
3. If you're writing a new feature, try to add it to the end to end test.
2127
1. If adding support for a new OpenAPI feature, add it somewhere in `end_to_end_tests/openapi.json`
2228
2. Regenerate the "golden records" with `task regen`. This client is generated from the OpenAPI document used for end to end testing.

0 commit comments

Comments
 (0)