Skip to content

[DOCS] Create instructions/pr-templates.instructions.md #713

@ashleyshaw

Description

@ashleyshaw

Create portable, detailed instruction file for PR template usage across all repositories.

Details

  • Follow the pattern in .github/instructions/instructions.instructions.md
  • Include frontmatter
  • Sections: Overview, General Rules, Detailed Guidance, Examples, Validation, References
  • No .github assumptions (reusable outside this repo)
  • Explain each template type and when to use it
  • Link to BRANCHING_STRATEGY.md for branch naming context

Template Coverage

  • pr_bug.md: When to use, what's required, what's optional
  • pr_feature.md: Feature-specific sections, acceptance criteria
  • pr_chore.md: Maintenance and housekeeping work
  • pr_ci.md: CI/CD and workflow changes
  • pr_docs.md: Documentation-only changes
  • pr_hotfix.md: Critical production fixes
  • pr_refactor.md: Code restructuring
  • pr_release.md: Release preparation
  • pr_deps.md: Dependency updates

Acceptance Criteria

  • File follows instruction template pattern (frontmatter, role, overview, rules, guidance, examples, validation, refs)
  • Covers all 9+ PR template types
  • Includes examples of correct and incorrect usage
  • References BRANCHING_STRATEGY.md

Metadata

Issue Type: Task
Priority: High
Phase: 2 - Documentation & Guidance
Effort: 1.5h
Depends on: #2, #4

Project: Template Enforcement & Governance

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions