feat(github): add issue and PR templates aligned with CONTRIBUTING.md#324
Merged
Conversation
Why: the framework didn't have issue or PR templates, so every new issue and PR re-invented its own shape. That's particularly costly for a framework with an intent-first authoring loop — vague issues turn into vague agentic conversations that don't converge, and PRs without an explicit RFC-AI-0004 compliance pass miss principles a reviewer would otherwise catch. The templates operationalise CONTRIBUTING.md's guidance: - `bug_report.yml` — what's broken, which layer, repro, expected vs actual. Calls out that an eval fixture is the highest-signal evidence for a skill-behaviour bug. - `change_proposal.yml` — intent-first by design. Required fields are *what* + *why* + which layer; *how* is explicitly out of scope for the issue and left to the agentic loop on the PR. Optional boundary-conditions and out-of-scope fields surface edges up front, saving a round-trip during implementation. - `config.yml` — disables blank issues; routes open-ended questions to Discussions; routes adopter security vulnerabilities to the adopter project's `security@` list per ASF policy (NOT here). - `PULL_REQUEST_TEMPLATE.md` — the ## Summary + ## Test plan shape documented in CONTRIBUTING.md, plus a Type-of-change checklist scoped to the framework's layer map and an RFC-AI-0004 compliance checklist (six principles → six checkboxes). The eval-fixture requirement for skill behaviour changes is called out explicitly. Companion change to `.pre-commit-config.yaml`: add the PR template to the doctoc exclude list. GitHub pre-populates a new PR description with the template verbatim, so a doctoc-generated TOC becomes per-PR noise the contributor has to delete by hand.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
bug_report.yml,change_proposal.yml,config.yml) and one PR template (PULL_REQUEST_TEMPLATE.md) that operationalise the guidance landed in CONTRIBUTING.md (docs(contributing): rewrite for framework-as-a-whole audience #323).change_proposal.ymltemplate is intent-first by design — required fields are what + why + which layer; how is explicitly out of scope at the issue stage and is left to the agentic loop on the eventual PR.## Summary+## Test planshape documented in CONTRIBUTING.md, plus a Type-of-change checklist scoped to the framework's layer map and an explicit RFC-AI-0004 compliance checklist (six principles → six checkboxes).config.ymldisables blank issues, routes open-ended questions to Discussions, and routes adopter security vulnerabilities to the adopter project'ssecurity@list per ASF policy (not here).Type of change
docs/,README.md,CONTRIBUTING.md) — issue / PR template scaffoldingprek, workflows, validators) — doctoc exclude tweakTest plan
prek run --files .pre-commit-config.yaml .github/ISSUE_TEMPLATE/*.yml .github/PULL_REQUEST_TEMPLATE.mdpassesheadof the file starts at the SPDX header, no TOC injectedCompanion change in
.pre-commit-config.yamlGitHub pre-populates a new PR description with the template verbatim, so a doctoc-generated TOC becomes per-PR noise that the contributor has to delete by hand. Added
\.github/PULL_REQUEST_TEMPLATE\.mdto the doctoc exclude pattern.Linked issues
Follows from #323 (CONTRIBUTING.md rewrite — landed).
🤖 Generated with Claude Code