feat: add standard context file templates
This commit is contained in:
+128
-18
@@ -37,24 +37,6 @@ TBD
|
||||
|
||||
## Minimum Useful Version
|
||||
|
||||
TBD
|
||||
""",
|
||||
"context/architecture.md": """# Architecture
|
||||
|
||||
## Overview
|
||||
|
||||
TBD
|
||||
|
||||
## Components
|
||||
|
||||
TBD
|
||||
|
||||
## Integrations
|
||||
|
||||
TBD
|
||||
|
||||
## Deployment
|
||||
|
||||
TBD
|
||||
""",
|
||||
"context/decisions.md": """# Decisions
|
||||
@@ -127,6 +109,134 @@ DISCOVERY
|
||||
|
||||
| ID | Question | Reason | Owner | Status |
|
||||
|---|---|---|---|---|
|
||||
""",
|
||||
"context/company-context.md": """# Company Context
|
||||
|
||||
## Mission
|
||||
|
||||
TBD — What is the organisation's core mission?
|
||||
|
||||
## Products & Services
|
||||
|
||||
TBD — List of products and services offered.
|
||||
|
||||
## Customers / Users
|
||||
|
||||
TBD — Who are the primary customers or users?
|
||||
|
||||
## Brand & Positioning
|
||||
|
||||
TBD — How does the company position itself in the market?
|
||||
|
||||
## Key Stakeholders
|
||||
|
||||
TBD — Names, roles, and contact information.
|
||||
""",
|
||||
"context/development-context.md": """# Development Context
|
||||
|
||||
## Tech Stack
|
||||
|
||||
TBD — Languages, frameworks, libraries, and tooling.
|
||||
|
||||
## Coding Standards
|
||||
|
||||
TBD — Style guide conventions, naming patterns, and linting rules.
|
||||
|
||||
## Repository Structure
|
||||
|
||||
TBD — Overview of directory layout and module organisation.
|
||||
|
||||
## Build & Test
|
||||
|
||||
TBD — How to build, test, and run the codebase locally.
|
||||
|
||||
## Dependencies
|
||||
|
||||
TDB — External services, databases, and third-party APIs required.
|
||||
""",
|
||||
"context/infrastructure-context.md": """# Infrastructure Context
|
||||
|
||||
## Hosting
|
||||
|
||||
TBD — Where is the application hosted (cloud provider, on-prem, etc.)?
|
||||
|
||||
## Environments
|
||||
|
||||
TBD — Development, staging, production environment details.
|
||||
|
||||
## CI / CD Pipeline
|
||||
|
||||
TBD — Build, test, and deployment pipeline configuration.
|
||||
|
||||
## Monitoring & Alerting
|
||||
|
||||
TBD — Tools used for monitoring, logging, and alerting.
|
||||
|
||||
## Security
|
||||
|
||||
TDB — Authentication, data protection, and access control measures.
|
||||
""",
|
||||
"context/agent-guidelines.md": """# Agent Guidelines
|
||||
|
||||
## Purpose
|
||||
|
||||
TBD — What should agents know about working with this project?
|
||||
|
||||
## Preferred Tools
|
||||
|
||||
TDB — Recommended editors, debuggers, testing frameworks, and CLI tools.
|
||||
|
||||
## Common Tasks
|
||||
|
||||
TBD — Typical workflows for developers and AI coding agents.
|
||||
|
||||
## Known Gotchas
|
||||
|
||||
TBD — Pitfalls, quirks, or important caveats to be aware of.
|
||||
""",
|
||||
"context/project-brief.md": """# Project Brief
|
||||
|
||||
## Problem Statement
|
||||
|
||||
TBD — What problem does this project solve?
|
||||
|
||||
## Target Audience
|
||||
|
||||
TDB — Who is the intended audience?
|
||||
|
||||
## Key Features (MVP)
|
||||
|
||||
TBD — Minimum set of features for the first release.
|
||||
|
||||
## Success Metrics
|
||||
|
||||
TBD — How will success be measured?
|
||||
|
||||
## Timeline & Milestones
|
||||
|
||||
TBD — Expected delivery dates and key milestones.
|
||||
""",
|
||||
"context/architecture.md": """# Architecture
|
||||
|
||||
## Overview
|
||||
|
||||
TBD — High-level system description and design principles.
|
||||
|
||||
## Core Components
|
||||
|
||||
TBD — Key modules, services, and their responsibilities.
|
||||
|
||||
## Data Flow
|
||||
|
||||
TDB — How data moves through the system (APIs, queues, databases).
|
||||
|
||||
## External Integrations
|
||||
|
||||
TBD — Third-party services, APIs, and dependencies.
|
||||
|
||||
## Deployment Architecture
|
||||
|
||||
TBD — Infrastructure layout, scaling strategy, and deployment process.
|
||||
""",
|
||||
"TASKS.md": """# TASKS.md
|
||||
|
||||
|
||||
Reference in New Issue
Block a user