Skip to content

Commit ea9121e

Browse files
authored
Revise PR template and checklist in CONTRIBUTING.md
Updated the PR template in CONTRIBUTING.md to improve clarity and added new checklist items.
1 parent 177c55f commit ea9121e

1 file changed

Lines changed: 15 additions & 15 deletions

File tree

CONTRIBUTING.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -193,29 +193,29 @@ refactor(generator): extract tower path builder into helper function
193193
4. **Open a PR** with the following template filled out:
194194

195195
```md
196-
## What does this PR do?
196+
## Description
197197

198-
<!-- One sentence summary -->
198+
Fixes # (issue number)
199199

200200
## Pillar
201201

202-
- [ ] New Theme Design
203-
- [ ] Geometric SVG Improvement
204-
- [ ] Timezone Logic Optimization
205-
- [ ] Other (describe below)
202+
- [ ] 🎨 Pillar 1 — New Theme Design
203+
- [ ] 📐 Pillar 2 — Geometric SVG Improvement
204+
- [ ] 🕐 Pillar 3 — Timezone Logic Optimization
205+
- [ ] 🛠️ Other (Bug fix, refactoring, docs)
206206

207207
## Visual Preview
208208

209-
<!-- Paste a screenshot or embed the SVG output URL -->
209+
## Checklist before requesting a review:
210210

211-
## Checklist
212-
213-
- [ ] I've tested this locally
214-
- [ ] All new logic/features have accompanying Vitest tests
215-
- [ ] `npm run test` passes locally
216-
- [ ] The SVG output matches the CommitPulse aesthetic standard
217-
- [ ] I've updated README.md if I added a new parameter or theme
218-
- [ ] My commits follow the Conventional Commits format
211+
- [ ] I have read the `CONTRIBUTING.md` file.
212+
- [ ] I have tested these changes locally (`localhost:3000/api/streak?user=YOUR_USERNAME`).
213+
- [ ] I have run `npm run format` and `npm run lint` locally and resolved all errors (CI will fail otherwise).
214+
- [ ] My commits follow the Conventional Commits format (e.g., `feat(themes): ...`, `fix(calculate): ...`).
215+
- [ ] I have updated `README.md` if I added a new theme or URL parameter.
216+
- [ ] I have started the repo.
217+
- [ ] I have made sure that i have only one commit to merge in this PR.
218+
- [ ] The SVG output matches the CommitPulse "premium quality" aesthetic standard (no raw elements, smooth animations, correct fonts).
219219
```
220220

221221
> **PRs without a visual preview for any SVG-touching changes will be asked for one before review.**

0 commit comments

Comments
 (0)