ci(pr-template): Add PR template for planning documents - #25
Merged
Conversation
integration(pr-template): Adding PR template for adding new templates
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
1 participant
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
Adds a dedicated PR template for adding or modifying planning documents in the
.ai/directory, including plans, phase documents, ADRs, and index updates.Template Type
.github/PULL_REQUEST_TEMPLATE/).github/ISSUE_TEMPLATE/)Templates Affected
.github/PULL_REQUEST_TEMPLATE/planning.mdRelated Issues
Checklist
General
For PR/Issue Templates
For Mustache/Code Templates
Template Preview
Key sections include:
Planning Document Type - Checkboxes for:
.ai/plans/<plan-name>.md).ai/plans/phases/<plan-name>-phase-<N>.md).ai/docs/adr/*.md).ai/INDEX.md)Documents Affected - Table with file path, action, and UUID
Frontmatter Checklist - Based on the frontmatter-standard ADR:
id,title,status,date,authorrelated,children,depends_on,tagsPlan Structure - For new plans: problem statement, goals, phases, success criteria, dependencies
Cross-Reference Verification - Bidirectional link maintenance, parent/child relationships, INDEX.md updates
Phase Document Checklist - Phase numbering, tasks, acceptance criteria, dependencies
ADR Checklist - Problem statement, decision, alternatives, tradeoffs, implementation
Validation - UUID uniqueness, reference existence, markdown rendering, link validation
Testing
Template aligns with the frontmatter standard documented in
.ai/docs/adr/frontmatter-standard.mdand the project's planning document conventions.Additional Context
This template expands the PR template suite:
mcp-server-default.md- Default for MCP server changeswiki-update.md- For Wiki documentation updatestemplates.md- For contributing new templatesmcp-onboarding.md- For onboarding new MCP Server reposdependency-update.md- For automated dependency updatesplanning.md- For planning documents (this PR)