Skip to content

feat: add multiple RFC template variants#16

Closed
mgiovani wants to merge 1 commit intomainfrom
feature/rfc-templates
Closed

feat: add multiple RFC template variants#16
mgiovani wants to merge 1 commit intomainfrom
feature/rfc-templates

Conversation

@mgiovani
Copy link
Copy Markdown
Owner

Summary

This PR adds multiple template variants for RFC (Request For Comments) documentation, allowing teams to choose the RFC style that best fits their proposal complexity and process requirements.

Templates Added

1. Minimal Template

  • File: rfc_template_minimal.md
  • Best For: Informal proposals or brainstorming
  • Length: ~12 lines
  • Sections: Problem, Proposed Solution, Discussion

2. Standard Template (Default)

  • File: rfc_template_standard.md
  • Best For: Most RFC scenarios requiring structured evaluation
  • Length: ~80 lines
  • Sections: Summary, Problem Statement, Proposed Solution, Implementation Details, Alternatives, Risks, Success Metrics

3. Detailed Template

  • File: rfc_template_detailed.md
  • Best For: Complex proposals requiring formal approval process
  • Length: ~300 lines
  • Sections: Abstract, Motivation, Background, Detailed Design, Implementation Plan, Alternatives, Risk Assessment, Resource Requirements, Testing Strategy, Rollout Plan, Approval Process

Configuration

Templates can be configured in .cursor-init.yaml:

templates:
  rfc: "standard"  # Options: minimal, standard, detailed

Changes Made

  • Added 3 RFC template variants ranging from minimal to comprehensive
  • Updated RFC rule to support template configuration
  • Updated configuration system to support RFC template selection
  • Added documentation for RFC template customization
  • Comprehensive placeholder system for different RFC complexities

Template Features

Common Placeholders

  • {{RFC_TITLE}} - RFC title
  • {{DATE}} - Current date
  • {{AUTHOR}} - Document author

RFC-Specific Placeholders

  • {{RFC_NUMBER}} - RFC number (detailed template)
  • {{STATUS}} - RFC status
  • {{PROBLEM_STATEMENT}} - Problem description
  • {{PROPOSED_SOLUTION}} - Solution details

Template Progression

  • Minimal: Simple Problem → Solution → Discussion
  • Standard: Structured analysis with alternatives and risks
  • Detailed: Enterprise-grade RFC with approval process and lifecycle management

Integration

The /rfc "Title" command will automatically use the configured RFC template variant when creating new RFCs.

Testing

  • ✅ Templates follow consistent placeholder conventions
  • ✅ All templates are well-structured with clear sections
  • ✅ Configuration system properly supports template selection
  • ✅ Rule updated to read template configuration
  • ✅ Documentation updated with usage examples

Use Cases

Minimal Template

  • Quick brainstorming sessions
  • Informal team proposals
  • Simple feature ideas

Standard Template (Default)

  • Feature proposals
  • Technical design decisions
  • Process improvements

Detailed Template

  • Major architectural changes
  • Cross-team initiatives
  • Formal approval processes
  • Enterprise environments

This is the second PR in a series to add template variants for all document types. Related PRs:

…uick proposals (~12 lines) - Add standard template for structured analysis (~80 lines) - Add detailed template for comprehensive lifecycle (~300 lines) - Update RFC rule to support template configuration - Update configuration to support RFC template selection - Add documentation for RFC template customization
Copilot AI review requested due to automatic review settings June 15, 2025 21:27
Copy link
Copy Markdown

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

This PR introduces multiple RFC template variants to support varied proposal complexities and improves documentation and configuration examples.

  • Added three RFC template variants (minimal, standard, detailed)
  • Updated template customization documentation to include RFC templates
  • Revised configuration and ER diagram generation logic to support RFC template selection

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/development/template-customization.md Updated guide to document RFC template customization options
.cursor/templates/rfc/rfc_template_standard.md Added standard RFC template with structured sections
.cursor/templates/rfc/rfc_template_minimal.md Added minimal RFC template for quick proposals
.cursor/templates/rfc/rfc_template_detailed.md Added detailed RFC template for complex proposals
.cursor/rules/cursor-init/diagrams/gen-er-diagram.mdc Modified ER diagram generation to incorporate template configuration
.cursor-init.example.yaml Updated YAML configuration to include RFC template options
Comments suppressed due to low confidence (2)

.cursor/templates/rfc/rfc_template_minimal.md:8

  • The placeholder '{{PROBLEM}}' in the minimal RFC template is inconsistent with '{{PROBLEM_STATEMENT}}' used in the standard and detailed templates. Consider aligning placeholder names across templates for consistency.
{{PROBLEM}}

.cursor/templates/rfc/rfc_template_minimal.md:12

  • The placeholder '{{SOLUTION}}' in the minimal RFC template differs from '{{PROPOSED_SOLUTION}}' in the standard RFC template. Standardizing these placeholders may help reduce confusion.
{{SOLUTION}}

@mgiovani
Copy link
Copy Markdown
Owner Author

🔄 Consolidated into PR #17

This PR has been consolidated into the comprehensive template improvements PR #17 which includes:

  • ✅ RFC templates (this PR)
  • ✅ Onboarding templates + data model templates
  • ✅ Enhanced architecture templates
  • ✅ All slash commands respecting template configuration

Please review and merge PR #17 instead of this individual PR.

Link to comprehensive PR: #17

@mgiovani mgiovani closed this Jun 15, 2025
@mgiovani mgiovani deleted the feature/rfc-templates branch June 15, 2025 21:47
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.

3 participants