Skip to content

Commit 0c9d5b6

Browse files
committed
feat: add pull request template for consistent contributions
Signed-off-by: kaifcoder <kaifmohd2014@gmail.com>
1 parent 7bc79dc commit 0c9d5b6

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

.github/pull_request_template.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
## Summary
2+
Explain the change in 1–3 sentences. Reference any related issues (e.g. Closes #123).
3+
4+
## Type of Change
5+
- [ ] Feature
6+
- [ ] Bug fix
7+
- [ ] Chore / Refactor
8+
- [ ] Docs
9+
- [ ] Tests
10+
- [ ] CI / Build
11+
- [ ] Other
12+
13+
## Motivation / Context
14+
Why is this change needed? What problem does it solve or what capability does it add?
15+
16+
## Approach
17+
Briefly describe how you implemented the change. Note any notable design decisions, trade-offs, or alternatives considered.
18+
19+
## CLI Impact
20+
If this alters user-facing CLI behavior:
21+
- Added / changed flags? Describe.
22+
- Backward compatible? If breaking, explain migration path.
23+
- Sample invocation before vs after:
24+
```
25+
# before
26+
# after
27+
```
28+
29+
## Generated Output Impact
30+
List any new / modified scaffold files or structural differences (e.g. new template folder, changed Dockerfile pattern, compose changes, new preset behaviors).
31+
32+
## Tests
33+
Describe test coverage:
34+
- [ ] Added new test(s)
35+
- [ ] Updated existing test(s)
36+
- [ ] Manually smoke-tested locally
37+
- [ ] No tests needed (explain why)
38+
39+
If you ran the smoke scaffold locally, paste the command & confirm success:
40+
```
41+
node bin/index.js demo --services node --no-install --yes
42+
```
43+
Result: ✅ / ❌
44+
45+
## Screenshots / Logs (Optional)
46+
Add any helpful output (chalk-styled CLI messages, error reproduction, etc.).
47+
48+
## Docs
49+
- [ ] Updated `README.md` if needed
50+
- [ ] Updated `.github/copilot-instructions.md` if internal conventions changed
51+
- [ ] Not applicable
52+
53+
## Checklist
54+
- [ ] Code follows existing style (chalk usage, emoji prefixes, exit codes)
55+
- [ ] No accidental large asset additions outside `templates/`
56+
- [ ] Default ports preserved / conflicts handled
57+
- [ ] New service templates added to: choices array, defaultPorts, Dockerfile switch, compose mapping
58+
- [ ] Git history clean (no stray debug commits)
59+
- [ ] Dependency additions are minimal & justified
60+
61+
## Open Questions / Follow-ups
62+
List any TODOs or future enhancements not in this PR.
63+
64+
---
65+
Thanks for contributing! 🎉

0 commit comments

Comments
 (0)