|
21 | 21 | auto-reformat the code, check type annotations, run unit tests, check code coverage, and lint the code.
|
22 | 22 | 3. If you're writing a new feature, try to add it to the end to end test.
|
23 | 23 | 1. If adding support for a new OpenAPI feature, add it somewhere in `end_to_end_tests/openapi.json`
|
24 |
| - 2. Regenerate the "golden record" with `task regen`. This is a client generated from the OpenAPI document used for end to end testing. |
25 |
| - 3. Check the changes to `end_to_end_tests/golden-record` to confirm only what you intended to change did change and that the changes look correct. |
26 |
| -4. Run the end to end tests with `task e2e`. This will generate a client against `end_to_end_tests/openapi.json` and |
27 |
| - compare it with `end_to_end_tests/golden-record`. The test will fail if **anything is different**. The end to end |
28 |
| - test is not included in `task check` as it takes longer to run and doesn't provide very useful feedback in the |
29 |
| - event of failure. If this test does fail, the easiest way to check what's wrong is to run `task regen` and check |
30 |
| - the diff of `golden-record`. |
| 24 | + 2. Regenerate the "golden records" with `task regen` and `task regen_custom`. These are clients generated from the OpenAPI document used for end to end testing. |
| 25 | + 3. Check the changes to `end_to_end_tests/golden-record` and `end_to_end_tests/golden-record-custom` to confirm only what you intended to change did change and that the changes look correct. |
| 26 | +4. Run the end to end tests with `task e2e`. This will generate clients against `end_to_end_tests/openapi.json` and |
| 27 | + compare them with the golden records. The tests will fail if **anything is different**. The end to end |
| 28 | + tests are not included in `task check` as they take longer to run and don't provide very useful feedback in the |
| 29 | + event of failure. If an e2e test does fail, the easiest way to check what's wrong is to run `task regen` and/or |
| 30 | + `task regen_custom` and check the diffs. You can also use `task re` which will run `regen`, `regen_custom` and `e2e` |
| 31 | + in that order. |
31 | 32 | 5. Include a summary of your changes in `CHANGELOG.md`. If there isn't an "Unreleased" version in the CHANGELOG yet,
|
32 | 33 | go ahead and add one.
|
33 | 34 |
|
|
0 commit comments