Skip to content

Commit e7013a3

Browse files
dlwh-golemdlwh
andauthored
docs: require pre-commit in fix_issue workflow (#3378)
Refs #3358 The fix-issue recipe required tests and CI monitoring but did not explicitly require running pre-commit before upload. This let issue-fix runs complete their checklist while skipping the repo lint/format gate. This updates `docs/recipes/fix_issue.md` to require `./infra/pre-commit.py --all-files --fix` in both the Testing section and the task checklist. Co-authored-by: dlwh-golem <[email protected]>
1 parent facbf8b commit e7013a3

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

docs/recipes/fix_issue.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ beginning work. Your tests will be minimal and refrain from using mocks.
9494
* You use an existing test file in @tests/ if appropriate.
9595
* You never use mocks when testing.
9696
* You keep tests simple and minimal. You do not test obvious behavior like "object has an attr".
97+
* You run `./infra/pre-commit.py --all-files --fix` and resolve all reported issues before uploading.
9798
* You will test using `uv run pytest -m 'not slow'` before uploading
9899
* You will ensure _all_ tests pass.
99100

@@ -129,6 +130,7 @@ The tasks for this recipe:
129130
- [ ] Create branch for the changes
130131
- [ ] Write a test case as needed for changes
131132
- [ ] Implement changes until all tests pass
133+
- [ ] Run `./infra/pre-commit.py --all-files --fix` and resolve all issues
132134
- [ ] Upload branch to github
133135
- [ ] Open pull request
134136
- [ ] Verify CI checks pass and address any failures (by polling gh pr view)

0 commit comments

Comments
 (0)