Skip to content

Commit b98c0c7

Browse files
committed
feat: Simplify contribution template + pr scripts to run
- Add a single script that runs the commands we want contributions to run. - Revamp the contribution template by: - Using HTML comments to guide the author, reducing the need to delete the text - Converting the type of change to be a flat list, allowing authors to delete all except the one they want - Updated the checklist items to allow items that are unnecessary to still be checked
1 parent a64e80d commit b98c0c7

File tree

2 files changed

+22
-17
lines changed

2 files changed

+22
-17
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,38 @@
11
## Description
2-
[Provide a detailed description of the changes in this PR]
2+
<!-- Provide a detailed description of the changes in this PR -->
33

44
## Related Issues
5-
[Link to related issues using #issue-number format]
5+
6+
<!-- Link to related issues using #issue-number format -->
67

78
## Documentation PR
8-
[Link to related associated PR in the agent-docs repo]
9+
10+
<!-- Link to related associated PR in the agent-docs repo -->
911

1012
## Type of Change
11-
- Bug fix
12-
- New feature
13-
- Breaking change
14-
- Documentation update
15-
- Other (please describe):
1613

17-
[Choose one of the above types of changes]
14+
<!-- Choose one of the following types of changes, delete the rest -->
1815

16+
Bug fix
17+
New feature
18+
Breaking change
19+
Documentation update
20+
Other (please describe):
1921

2022
## Testing
21-
[How have you tested the change?]
2223

23-
* `hatch fmt --linter`
24-
* `hatch fmt --formatter`
25-
* `hatch test --all`
26-
* Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
24+
How have you tested the change? Verify that the changes do not break functionality or introduce warnings in consuming repositories: agents-docs, agents-tools, agents-cli
2725

26+
- [ ] I ran `hatch run prepare`
2827

2928
## Checklist
3029
- [ ] I have read the CONTRIBUTING document
31-
- [ ] I have added tests that prove my fix is effective or my feature works
30+
- [ ] I have added any necessary tests that prove my fix is effective or my feature works
3231
- [ ] I have updated the documentation accordingly
33-
- [ ] I have added an appropriate example to the documentation to outline the feature
32+
- [ ] I have added an appropriate example to the documentation to outline the feature, or no new docs are needed
3433
- [ ] My changes generate no new warnings
3534
- [ ] Any dependent changes have been merged and published
3635

36+
----
37+
3738
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

pyproject.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,11 @@ test = [
165165
test-integ = [
166166
"hatch test tests-integ {args}"
167167
]
168-
168+
prepare = [
169+
"hatch fmt --linter",
170+
"hatch fmt --formatter",
171+
"hatch test --all"
172+
]
169173

170174
[tool.mypy]
171175
python_version = "3.10"

0 commit comments

Comments
 (0)