feat: add PR requirements spec and PR template#672
feat: add PR requirements spec and PR template#672bradygaster merged 5 commits intobradygaster:devfrom
Conversation
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>
There was a problem hiding this comment.
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. |
|
@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. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
|
||
| ### 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) |
There was a problem hiding this comment.
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.
| - [ ] 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) |
…om/diberry/squad into squad/106-pr-requirements-upstream
Part 1 of 2: Repo Health -- PR Requirements
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 checklistRelated Issues
Testing
npm run buildpassesnpm testpasses (179/183 suites green; 4 failures are vitest worker timeouts unrelated to markdown-only changes)Docs
N/A -- these ARE the docs
Breaking Changes
None
Waivers
None