Add missing Non-Goals and Quality Checklist sections to 8 templates#29
Merged
Alan-Jowett merged 2 commits intomicrosoft:mainfrom Mar 19, 2026
Merged
Conversation
Fixes microsoft#20 Add Quality Checklist sections to 5 templates: - investigate-bug: findings verification, severity consistency, coverage - investigate-security: exploit scenarios, CWE identifiers, coverage - review-code: severity ordering, fix suggestions, overall assessment - plan-implementation: TASK-ID uniqueness, dependencies, critical path - plan-refactoring: step atomicity, verification, rollback paths Add Non-Goals sections to 5 templates: - author-requirements-doc: no design, no implementation, no test cases - author-design-doc: no requirements generation, no implementation - author-validation-plan: no test execution, no scope expansion - plan-implementation: no implementation, no calendar estimates - plan-refactoring: no redesign, no new features Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing “Non-Goals” and “Quality Checklist” sections to multiple authoring/planning/review templates to standardize scope boundaries and final-output verification, addressing #20.
Changes:
- Added template-specific Quality Checklist sections (e.g., review/investigation/planning templates).
- Added Non-Goals sections to clarify what each template must not do.
- Updated 8 template markdown files to include the missing sections.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| templates/review-code.md | Adds a Quality Checklist for code review outputs. |
| templates/plan-refactoring.md | Adds Non-Goals and a Quality Checklist for refactoring plans. |
| templates/plan-implementation.md | Adds Non-Goals and a Quality Checklist for implementation plans. |
| templates/investigate-security.md | Adds a Quality Checklist for security investigations. |
| templates/investigate-bug.md | Adds a Quality Checklist for bug investigations. |
| templates/author-validation-plan.md | Adds Non-Goals to constrain validation plan scope. |
| templates/author-requirements-doc.md | Adds Non-Goals to constrain requirements doc scope. |
| templates/author-design-doc.md | Adds Non-Goals to constrain design doc scope. |
- Fix 'commitable' -> 'committable' in plan-refactoring quality checklist - Remove 'Do NOT omit tradeoff analysis' from author-design-doc non-goals (this is a positive requirement, not a scope exclusion; already covered by the quality checklist item 'Tradeoff analysis is present') Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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
Fixes #20 — adds missing Non-Goals and Quality Checklist sections to 8 templates that were missing one or both.
Changes
Quality Checklist added to 5 templates
Each checklist is specific to its template's task:
investigate-buginvestigate-securityreview-codeplan-implementationplan-refactoringNon-Goals added to 5 templates
Each non-goals section defines task-appropriate scope boundaries:
author-requirements-docauthor-design-docauthor-validation-planplan-implementationplan-refactoringValidation
tests/validate-manifest.pypasses.