Skip to content

Commit d177e96

Browse files
authored
Merge pull request #20 from aRustyDev/pr/pr-template-templates
chore(pr-template): Add PR template for contributing new templates
2 parents e22068c + a8a2e55 commit d177e96

1 file changed

Lines changed: 54 additions & 0 deletions

File tree

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
## Summary
2+
3+
<!-- Brief description of the template(s) being added or modified -->
4+
5+
## Template Type
6+
7+
- [ ] PR template (`.github/PULL_REQUEST_TEMPLATE/`)
8+
- [ ] Issue template (`.github/ISSUE_TEMPLATE/`)
9+
- [ ] Mustache template
10+
- [ ] Other template type: <!-- specify -->
11+
12+
## Templates Affected
13+
14+
<!-- List the template files being added, modified, or removed -->
15+
16+
| File | Action | Purpose |
17+
|------|--------|---------|
18+
| `path/to/template.md` | Added/Modified/Removed | Brief description |
19+
20+
## Related Issues
21+
22+
<!-- Link to related issues: Fixes #123, Relates to #456 -->
23+
24+
## Checklist
25+
26+
### General
27+
- [ ] Template follows repository naming conventions
28+
- [ ] Template includes clear placeholder text/comments for users
29+
- [ ] Template is placed in the correct directory
30+
31+
### For PR/Issue Templates
32+
- [ ] Template includes all required sections
33+
- [ ] Checkboxes and options are relevant to the template's purpose
34+
- [ ] Labels are correctly referenced (if applicable)
35+
36+
### For Mustache/Code Templates
37+
- [ ] Variable placeholders are clearly documented
38+
- [ ] Default values are sensible (if applicable)
39+
- [ ] Template renders correctly with test data
40+
41+
## Template Preview
42+
43+
<!--
44+
For PR/Issue templates: Describe key sections and their purpose
45+
For Mustache templates: Show example rendered output if possible
46+
-->
47+
48+
## Testing
49+
50+
<!-- How was this template tested? Did you create a test PR/issue using it? -->
51+
52+
## Additional Context
53+
54+
<!-- Any other information reviewers should know about this template -->

0 commit comments

Comments
 (0)