-
Gather context in parallel:
git log main..HEAD --oneline — commits in this PR
git diff main...HEAD --stat — files changed
git branch --show-current — current branch name
- Read
.github/PULL_REQUEST_TEMPLATE.md
-
Determine change types by mapping conventional-commit prefixes and the nature of the diff:
| Conventional prefix | PR Change Type |
|---|
feat | New Feature |
fix | Bug Fix |
refactor | Code Refactor |
docs / doc | Documentation |
test | Test |
chore / ci / build | Other |
Only keep the change types present in this PR — remove the rest from the template.
-
Suggest a PR title using Conventional Commits format: <type>: <short imperative description> (50–72 chars). When multiple types apply, use the most significant: feat > fix > refactor > test > docs > chore.
-
Generate the filled-in PR description. Pre-check only the applicable change type boxes; remove the inapplicable ones entirely. Write all prose sections (Description, Related Issue) as flowing paragraphs — do NOT wrap lines at any character limit. Each sentence or logical thought should continue on the same line so that GitHub renders the text correctly without unwanted line breaks.
-
Screenshots section — decide based on changed files:
- Frontend changes (
admin-wcc-app/**, *.tsx, *.css, components, pages): include the section and list the specific screenshots needed (before/after UI, error states, label/title changes, GIF for interactions). Emphasise that screenshots are required for the reviewer to assess visual changes.
- Backend API changes (new/changed controllers or endpoints): include the section asking for Swagger UI screenshots (
/swagger-ui/index.html).
- Only
test, docs, chore, ci, or refactor with no endpoint changes: omit the Screenshots section entirely.
-
Pull request checklist — always include the contributor guide checkbox. Include "I have tested my changes locally" only for feat, fix, refactor, or frontend changes — omit it for pure docs, chore, or ci changes.
-
Derive the contributor's GitHub username from the origin remote:
git remote get-url origin
Extract <username> from the URL (path segment before /wcc-backend).
Print:
- Suggested PR title (plain text)
- PR description (markdown code block)
- GitHub compare URL:
https://github.com/Women-Coding-Community/wcc-backend/compare/main...<username>:<branch-name>
- Remind the user to add screenshots before submitting if required