Skip to content

Commit bd174e6

Browse files
pull request template
1 parent f1fb6f9 commit bd174e6

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/pull_request_template.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
## Description
2+
3+
Please provide a clear and concise description of your changes:
4+
5+
- What does this PR do?
6+
- What problem does it solve?
7+
- Are there any breaking changes?
8+
9+
## Type of Contribution
10+
11+
Please check the type of contribution:
12+
13+
- [ ] **Documentation fix** (correcting errors, typos, outdated information)
14+
- [ ] **Documentation improvement** (enhancing clarity, adding missing information)
15+
- [ ] **New documentation** (adding new pages or sections)
16+
- [ ] **Tutorial** (new tutorial content)
17+
- [ ] **Other** (please describe):
18+
19+
## Review Process Preference
20+
21+
**Important**: Please select your preference for the review process:
22+
23+
- [ ] **Option A**: I have time to handle formatting and style review feedback myself
24+
- [ ] **Option B**: Please have the Polkadot docs team take over for formatting review to expedite the process
25+
26+
*Note: If you choose Option B, you must also check "Allow edits from maintainers" at the bottom of this page (if available). This allows our team to create a follow-up branch and handle style/formatting changes, letting you focus on the technical content.*
27+
28+
## Checklist
29+
30+
Before submitting this PR, please verify:
31+
32+
- [ ] I have tested my changes locally (if applicable)
33+
- [ ] I have followed the [style guidelines](https://github.com/papermoonio/documentation-style-guide/blob/main/style-guide.md)
34+
- [ ] I have regenerated AI documentation files using `python scripts/generate_llms_standard.py` (if content changed)
35+
- [ ] My changes are focused and atomic (single logical change per PR)
36+
- [ ] I have updated the table of contents or navigation files (if adding new pages)
37+
38+
## Additional Context
39+
40+
Add any other context about the pull request here. Include screenshots for UI changes, links to related issues, or any specific areas where you'd like reviewer feedback.
41+
42+
## Related Issues
43+
44+
Closes #(issue number)
45+
Fixes #(issue number)
46+
Relates to #(issue number)

0 commit comments

Comments
 (0)