Skip to content

Commit fc68878

Browse files
committed
feat: add pull request description template
1 parent d1ed0e9 commit fc68878

1 file changed

Lines changed: 124 additions & 0 deletions

File tree

Lines changed: 124 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
## Description
2+
3+
<!-- Provide a clear and concise description of your changes -->
4+
5+
## Type of Change
6+
7+
<!-- Mark the relevant option with an [x] -->
8+
9+
- [ ] Bug fix (non-breaking change that fixes an issue)
10+
- [ ] New feature (non-breaking change that adds functionality)
11+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
12+
- [ ] Documentation update
13+
- [ ] Refactoring (no functional changes)
14+
- [ ] Performance improvement
15+
- [ ] Test coverage improvement
16+
17+
## Related Issues
18+
19+
<!-- Link any related issues using #issue_number -->
20+
21+
Closes #
22+
23+
## Changes Made
24+
25+
<!-- List the main changes in this PR -->
26+
27+
-
28+
-
29+
-
30+
31+
## SPEC Compliance
32+
33+
<!-- If this PR relates to the TOON spec, indicate which sections are affected -->
34+
35+
- [ ] This PR implements/fixes spec compliance
36+
- [ ] Spec section(s) affected:
37+
- [ ] Spec version:
38+
39+
## Testing
40+
41+
<!-- Describe the tests you added or ran -->
42+
43+
- [ ] All existing tests pass
44+
- [ ] Added new tests for changes
45+
- [ ] Tested on Python 3.8
46+
- [ ] Tested on Python 3.9
47+
- [ ] Tested on Python 3.10
48+
- [ ] Tested on Python 3.11
49+
- [ ] Tested on Python 3.12
50+
51+
### Test Output
52+
53+
```bash
54+
# Paste test output here
55+
```
56+
57+
## Code Quality
58+
59+
<!-- Confirm code quality checks -->
60+
61+
- [ ] Ran `ruff check src/toon_format tests` - no issues
62+
- [ ] Ran `ruff format src/toon_format tests` - code formatted
63+
- [ ] Ran `mypy src/toon_format` - no critical errors
64+
- [ ] All tests pass: `pytest tests/ -v`
65+
66+
## Checklist
67+
68+
<!-- Mark completed items with an [x] -->
69+
70+
- [ ] My code follows the project's coding standards (PEP 8, line length 100)
71+
- [ ] I have added type hints to new code
72+
- [ ] I have added tests that prove my fix/feature works
73+
- [ ] New and existing tests pass locally
74+
- [ ] I have updated documentation (README.md, CLAUDE.md if needed)
75+
- [ ] My changes do not introduce new dependencies
76+
- [ ] I have maintained Python 3.8+ compatibility
77+
- [ ] I have reviewed the [TOON specification](https://github.com/toon-format/spec) for relevant sections
78+
79+
## Performance Impact
80+
81+
<!-- If applicable, describe any performance implications -->
82+
83+
- [ ] No performance impact
84+
- [ ] Performance improvement (describe below)
85+
- [ ] Potential performance regression (describe and justify below)
86+
87+
<!-- Details: -->
88+
89+
## Breaking Changes
90+
91+
<!-- If this is a breaking change, describe the migration path for users -->
92+
93+
- [ ] No breaking changes
94+
- [ ] Breaking changes (describe migration path below)
95+
96+
<!-- Migration path: -->
97+
98+
## Screenshots / Examples
99+
100+
<!-- If applicable, add screenshots or example output -->
101+
102+
```python
103+
# Example usage
104+
```
105+
106+
Output:
107+
```
108+
# Example output
109+
```
110+
111+
## Additional Context
112+
113+
<!-- Add any other context about the PR here (optional) -->
114+
115+
## Checklist for Reviewers
116+
117+
<!-- For maintainers reviewing this PR -->
118+
119+
- [ ] Code changes are clear and well-documented
120+
- [ ] Tests adequately cover the changes
121+
- [ ] Documentation is updated
122+
- [ ] No security concerns
123+
- [ ] Follows TOON specification
124+
- [ ] Backward compatible (or breaking changes are justified and documented)

0 commit comments

Comments
 (0)