Skip to content

Commit 54b6ab2

Browse files
committed
Update contrib readme
Signed-off-by: Jing Chen <[email protected]>
1 parent 2ffa89a commit 54b6ab2

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/contrib.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ PDL executes nightly runs for Run Examples, which searches for all the `.pdl` pr
8585
8686
If you wish to make a contribution to PDL and modify or add any PDL program to the repo, it is important that you provide the new expected results for those files so that the Run Examples nightly test does not break.
8787
88-
### Local dev
88+
#### Local dev
8989
9090
Under `check`, you can provide a list of files that you want to run Pytest against. If you leave it empty (`check: ` or `check: []`), then by default, Pytest will be executed against all files in the repo, except for those under `skip`. For local development, it is useful to only test against a subset of files so that Pytest executes faster.
9191
@@ -97,18 +97,18 @@ Run this Pytest command for Run Examples, which is the same command for the nigh
9797
pytest --capture=tee-sys -rfE -s tests/test_examples_run.py --disable-pytest-warnings
9898
```
9999
100-
### Opening a pull request
100+
#### Opening a pull request
101101
102102
A slight variation in the Python version and OS environment can cause a different LLM response, thus Run Examples might fail because it uses exact string matching for PDL outputs. You can utilize the `update_results` when opening a PR to capture the expected results in the GH Actions environment.
103103
104104
When you open a pull request (PR) against the `main` branch, a series of status checks will be executed. Specificially, three Run Examples test will be initiated against the files you have added and modified.
105105
106-
- If in the PR, `update_results: false`, Pytest will be executed against those files
106+
- If in the PR, `update_results: false`,
107107
- If Pytest fails, you can manually examine the failures and add the results to your PR
108-
- If in the PR, `update_results: true`, Pytest will be executed against those files.
108+
- If in the PR, `update_results: true`,
109109
- If Pytest fails, a GH-Actions bot will push a commit with the new results produced in the GH environment to your PR
110-
- Additionally, another commit will push `update_results: false`.
111-
- If you need to make other changes to your PR, make sure to pull the new changes first.
110+
- Additionally, another commit will push `update_results: false`. This is to ensure that for the nightly test, different results are not committed
111+
- If you need to make other changes to your PR, make sure to pull the new changes first
112112
113113
Your PR should always set `update_results: false` before merging.
114114

0 commit comments

Comments
 (0)