Skip to content

feat: add PR requirements spec and PR template#672

Merged
bradygaster merged 5 commits intobradygaster:devfrom
diberry:squad/106-pr-requirements-upstream
Mar 29, 2026
Merged

feat: add PR requirements spec and PR template#672
bradygaster merged 5 commits intobradygaster:devfrom
diberry:squad/106-pr-requirements-upstream

Conversation

@diberry
Copy link
Copy Markdown
Collaborator

@diberry diberry commented Mar 28, 2026

Part 1 of 2: Repo Health -- PR Requirements

This PR establishes the rules. Automated enforcement comes next.

What

Adds the canonical PR requirements spec and PR template for the Squad repo.

Why

Establishes PR quality standards as versioned files. Phase 2 delivers them as versioned files.
Addresses Challenger FATAL finding: spec must be versioned, not mutable issue.

How

  • .github/PR_REQUIREMENTS.md: versioned spec (6 categories, waiver process, exemptions)
  • .github/PULL_REQUEST_TEMPLATE.md: author-facing checklist

Related Issues

  • PR requirements PRD (this PR delivers Phase 2)
  • PR completeness gates (Part 2: automated enforcement)
  • Reviewer checklist (Phase 4)

Testing

  • npm run build passes
  • npm test passes (179/183 suites green; 4 failures are vitest worker timeouts unrelated to markdown-only changes)
  • No code changes -- markdown files only

Docs

N/A -- these ARE the docs

Breaking Changes

None

Waivers

None

Adds .github/PR_REQUIREMENTS.md (versioned spec with 6 categories, CRUD-on-CLI/SDK user-facing definition, waiver process, exemptions) and .github/PULL_REQUEST_TEMPLATE.md (author-facing checklist). Part 1 of 2 for repo health -- #104 will automate enforcement.

Closes Phase 2 of #106

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings March 28, 2026 22:26
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds repository-wide pull request governance documentation under .github/, aiming to standardize PR quality requirements and provide a contributor-facing checklist.

Changes:

  • Introduces a versioned PR requirements specification (.github/PR_REQUIREMENTS.md).
  • Adds a PR author checklist template (.github/PULL_REQUEST_TEMPLATE.md).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.

File Description
.github/PR_REQUIREMENTS.md Defines PR requirement categories, waiver/exemption rules, and “user-facing change” criteria.
.github/PULL_REQUEST_TEMPLATE.md Provides a structured PR description template and checklists aligned to the spec.

Comment thread .github/PR_REQUIREMENTS.md
Comment thread .github/PR_REQUIREMENTS.md
Comment thread .github/PR_REQUIREMENTS.md
Comment thread .github/PR_REQUIREMENTS.md
Comment thread .github/PULL_REQUEST_TEMPLATE.md
@diberry
Copy link
Copy Markdown
Collaborator Author

diberry commented Mar 29, 2026

@bradygaster -- I'm working on getting Squad to interact with Copilot code review correctly. Most of Copilot's suggestions and comments resulted in changes to this PR. CI is green and this is ready to merge when you are.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread .github/PR_REQUIREMENTS.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

Comment thread .github/PR_REQUIREMENTS.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


### Docs
<!-- What documentation was updated. "N/A" only if truly no user-facing change. -->
- [ ] CHANGELOG.md entry (if packages/squad-sdk/src/ or packages/squad-cli/src/ changed)
Copy link

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

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

The Docs checklist says a CHANGELOG entry is needed when packages/squad-sdk/src/ or packages/squad-cli/src/ changed, but PR_REQUIREMENTS.md scopes CHANGELOG requirements to user-facing changes (public surface changes), not all edits under those paths. Align the template language with the spec (e.g., reference the “user-facing change” definition) to avoid conflicting guidance.

Suggested change
- [ ] CHANGELOG.md entry (if packages/squad-sdk/src/ or packages/squad-cli/src/ changed)
- [ ] CHANGELOG.md entry (for user-facing changes in packages/squad-sdk/src/ or packages/squad-cli/src/; see PR_REQUIREMENTS.md “user-facing change” definition)

Copilot uses AI. Check for mistakes.
@bradygaster bradygaster merged commit 186cd6f into bradygaster:dev Mar 29, 2026
3 checks passed
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.

5 participants