Skip to content

Add missing Non-Goals and Quality Checklist sections to 8 templates#29

Merged
Alan-Jowett merged 2 commits intomicrosoft:mainfrom
Alan-Jowett:fix/issue-20-missing-template-sections
Mar 19, 2026
Merged

Add missing Non-Goals and Quality Checklist sections to 8 templates#29
Alan-Jowett merged 2 commits intomicrosoft:mainfrom
Alan-Jowett:fix/issue-20-missing-template-sections

Conversation

@Alan-Jowett
Copy link
Copy Markdown
Member

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:

Template Key checklist items
investigate-bug Findings cite code evidence, severity justified, root cause identified
investigate-security Exploit scenarios for High/Critical, CWE identifiers, coverage statement
review-code Severity ordering, fix suggestions, overall assessment stated
plan-implementation TASK-IDs unique, dependencies explicit, critical path identified
plan-refactoring Steps atomic and commitable, verification per step, rollback paths

Non-Goals added to 5 templates

Each non-goals section defines task-appropriate scope boundaries:

Template Key non-goals
author-requirements-doc No design, no implementation approach, 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, no tech choices
plan-refactoring No redesign, no new features, no assumptions beyond provided code

Validation

tests/validate-manifest.py passes.

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>
Copilot AI review requested due to automatic review settings March 19, 2026 17:47
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 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>
@Alan-Jowett Alan-Jowett merged commit 932b9bb into microsoft:main Mar 19, 2026
2 checks passed
@Alan-Jowett Alan-Jowett deleted the fix/issue-20-missing-template-sections branch March 20, 2026 17:01
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.

Multiple templates missing Non-Goals and Quality Checklist sections

2 participants