Skip to content

spec_template.md

Latest commit

 

History

History
213 lines (169 loc) · 7.09 KB

spec_template.md

File metadata and controls

213 lines (169 loc) · 7.09 KB
Raw

RenderTrust Specification Template

This specification template guides AI agents through planning, implementing, and testing features for the RenderTrust project. Follow this template to ensure comprehensive documentation, proper testing, and adherence to project standards.

Issue Reference

High-Level Objective

  • [Describe the primary goal of this feature/task in 1-2 sentences]
  • [Explain the business value and user impact]

User Stories

  • As a [user type], I want to [action/feature], so that [benefit/value]
  • As a [user type], I want to [action/feature], so that [benefit/value]
  • [Add more user stories as needed]

Acceptance Criteria

  • [Specific, measurable outcome that must be achieved]
  • [Specific, measurable outcome that must be achieved]
  • [Add more criteria as needed]
  • All unit tests pass
  • All integration tests pass
  • Code follows project style guidelines
  • Documentation is updated

Mid-Level Objectives

  • [Break down the high-level objective into concrete, measurable steps]
  • [Each objective should be specific enough to guide implementation but not overly detailed]
  • [Include dependencies between objectives if applicable]

Technical Implementation Details

Architecture

  • [Describe the architectural approach]
  • [Include diagrams or references to architecture documents if applicable]
  • [Explain how this fits into the existing RenderTrust architecture]

Dependencies

  • [List external dependencies (libraries, services, APIs)]
  • [List internal dependencies (other RenderTrust components)]
  • [Specify version requirements if applicable]

Security Considerations

  • [Describe security requirements and considerations]
  • [Include encryption, authentication, and authorization details if applicable]
  • [Reference relevant security documentation]

Performance Requirements

  • [Specify performance expectations (latency, throughput, resource usage)]
  • [Define benchmarks or metrics for measuring performance]

Coding Standards

  • Follow RenderTrust coding standards
  • Use [specific patterns or practices relevant to this task]
  • Ensure proper error handling and logging
  • Include comprehensive comments and documentation

Context

Beginning Context

  • [List existing files and components that will be modified]
  • [Describe the current state of the system relevant to this task]
  • [Include code snippets or references to key existing functionality]

Ending Context

  • [List all files that will exist after implementation (new and modified)]
  • [Describe the expected state of the system after implementation]
  • [Include expected interfaces, APIs, or data structures]

Testing Strategy

Unit Tests

  • [List specific unit tests to be created or updated]
  • [Specify test coverage expectations]
  • [Include edge cases and error scenarios to test]

Integration Tests

  • [Describe integration test scenarios]
  • [Specify components to be tested together]
  • [Include end-to-end workflows to validate]

Performance Tests

  • [Describe performance testing approach if applicable]
  • [Specify benchmarks and acceptance thresholds]

Low-Level Tasks

Ordered from start to finish with detailed implementation guidance

  1. [First task with specific implementation details]

    - File(s) to create/modify: [file path(s)]
- Function(s) to create/modify: [function name(s)]
- Implementation details:
  - [Specific code changes or algorithms to implement]
  - [Data structures to use]
  - [Edge cases to handle]
- Testing approach:
  - [How to test this specific task]
  - [Test cases to cover]

  2. [Second task with specific implementation details]

    - File(s) to create/modify: [file path(s)]
- Function(s) to create/modify: [function name(s)]
- Implementation details:
  - [Specific code changes or algorithms to implement]
  - [Data structures to use]
  - [Edge cases to handle]
- Testing approach:
  - [How to test this specific task]
  - [Test cases to cover]

  3. [Continue with additional tasks as needed]

Subtasks for Linear

These subtasks will be added to the original Linear issue

  1. [Subtask title]

    • Description: [Detailed description]
    • Estimated effort: [Small/Medium/Large]
    • Dependencies: [List any dependencies]

  2. [Subtask title]

    • Description: [Detailed description]
    • Estimated effort: [Small/Medium/Large]
    • Dependencies: [List any dependencies]

  3. [Continue with additional subtasks as needed]

Documentation Updates

  • [List documentation files that need to be created or updated]
  • [Specify the content to add or modify]
  • [Include API documentation requirements if applicable]

Rollout Considerations

  • [Describe any special considerations for deploying this change]
  • [Include migration steps if applicable]
  • [Specify monitoring requirements]

Risks and Mitigations

  • Risk: [Describe potential risk]
    • Mitigation: [Describe mitigation strategy]
  • Risk: [Describe potential risk]
    • Mitigation: [Describe mitigation strategy]

Pull Request Template

Use this template when creating a pull request for your implementation

# Pull Request Template

## Overview
<!-- Provide a brief description of what this PR does -->
[Brief description of the implementation based on this spec]

## Changes
<!-- List the specific changes made in this PR -->
- [Major change 1]
- [Major change 2]
- [Major change 3]

## Technical Details
<!-- Explain any technical decisions, trade-offs, or architectural considerations -->
[Explain key technical decisions made during implementation]

## Testing
<!-- Describe how you tested these changes -->
- [ ] Tested changes in local development environment
- [ ] Checked for errors in console logs and network requests
- [ ] Ran full build to verify production readiness
- [ ] Updated or added unit tests
- [ ] Performed integration testing

## Impact
<!-- Describe the potential impact of these changes on users or other parts of the system -->
[Describe how these changes affect the system and users]

## Related Issues
<!-- Link to any related issues -->
- Resolves [REN-XX: Issue Title]

---

<!-- Please ensure your PR follows our contribution guidelines -->
- [ ] I have followed the SAFe Essentials workflow
- [ ] I have consulted with team members as needed
- [ ] I have updated documentation as necessary
- [ ] I have verified that these changes meet the acceptance criteria

Agent Implementation Checklist

  • Thoroughly researched and understood the requirements
  • Created detailed implementation plan
  • Added subtasks to Linear issue
  • Implemented code changes
  • Written comprehensive tests
  • Verified all tests pass
  • Updated documentation
  • Code compiles without errors or warnings
  • Performed self-review of code
  • Created pull request (if applicable)

Notes and Questions

  • [Note any important information not covered elsewhere]
  • [List questions that need clarification]
  • [Include alternative approaches considered]