Skip to content

feat(ci): add pull request template with contributor checklist - #779

Merged
diberry merged 2 commits into
github:devfrom
diberry:squad/778-pr-template
Apr 4, 2026
Merged

diberry merged 2 commits into
github:devfrom
diberry:squad/778-pr-template

Conversation

@diberry

@diberry diberry commented Apr 3, 2026

Copy link
Copy Markdown
Contributor

What

Enhances the PR template with a structured readiness checklist that contributors see at PR creation time.

Why

Suggested by @tamirdresher in PR #752 review. Having static checkboxes upfront complements any future dynamic PR readiness bot — template gives the checklist before push, bot validates after push.

How

Updated .github/PULL_REQUEST_TEMPLATE.md\ to include:

  • Branch & Commit checks (branch from dev, up to date, not draft, clean history)
  • Build & Test checks (build, test, lint)
  • Changeset checks (changeset or CHANGELOG or skip-changelog label)
  • Docs and Exports sections (carried forward)
  • Bot validation note and CONTRIBUTING.md reference

Closes #778

Working as EECOM (Core Dev)

Copilot AI review requested due to automatic review settings April 3, 2026 13:26

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a structured PR readiness checklist to the repository’s pull request template so contributors see key “review-ready” expectations at PR creation time.

Changes:

  • Inserts a “PR Readiness Checklist” section covering branch hygiene, build/test steps, changesets, docs, and exports.
  • Adds guidance pointing to CONTRIBUTING.md and noting the readiness bot will validate items after push.
  • Reorganizes the template by placing the checklist before the “Breaking Changes” section.

Comment thread .github/PULL_REQUEST_TEMPLATE.md Resolved
Comment thread .github/PULL_REQUEST_TEMPLATE.md Resolved
Comment thread .github/PULL_REQUEST_TEMPLATE.md Resolved
Comment thread .github/PULL_REQUEST_TEMPLATE.md Resolved
@diberry
diberry force-pushed the squad/778-pr-template branch from dde3a06 to a291352 Compare April 3, 2026 17:50
@github-actions

github-actions Bot commented Apr 3, 2026 •

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

⚠️ 3 item(s) to address before review

Status Check Details
❌ Single commit 2 commits — consider squashing before review
✅ Not in draft Ready for review
✅ Branch up to date Up to date with dev
❌ Copilot review No Copilot review yet — it may still be processing
✅ Changeset present No source files changed — changeset not required
✅ Scope clean No .squad/ or docs/proposals/ files
✅ No merge conflicts No merge conflicts
✅ Copilot threads resolved All 4 Copilot thread(s) resolved
❌ CI passing 14 check(s) still running

This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

@diberry
diberry force-pushed the squad/778-pr-template branch from a291352 to 01826b7 Compare April 3, 2026 20:48
diberry added a commit to diberry/squad that referenced this pull request Apr 3, 2026
…b#779)

Add .github/PULL_REQUEST_TEMPLATE.md with sections for description,
change type, checklist, testing, and related issues.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
diberry force-pushed the squad/778-pr-template branch from 01826b7 to f8ea11d Compare April 3, 2026 20:53

@tamirdresher tamirdresher left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Clean contributor checklist, aligns with existing conventions. Consider adding CLI command refs (e.g. npx changeset add) for first-time contributors in a follow-up.

…b#779)

Add .github/PULL_REQUEST_TEMPLATE.md with sections for description,
change type, checklist, testing, and related issues.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
diberry force-pushed the squad/778-pr-template branch from f8ea11d to 5ce13ea Compare April 4, 2026 13:01
@diberry

diberry commented Apr 4, 2026

Copy link
Copy Markdown
Contributor Author

Files in this PR:

  • .github/PULL_REQUEST_TEMPLATE.md

@diberry
diberry merged commit a9bb7ad into github:dev Apr 4, 2026
16 checks passed
@diberry
diberry deleted the squad/778-pr-template branch April 4, 2026 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat(ci): add pull_request_template.md with contributor checklist

3 participants