mirror of
https://github.com/zoriya/v10.git
synced 2026-08-16 02:45:09 +00:00
61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
# Implementation Plans
|
|
|
|
Working notes and implementation details for AI agents and developers.
|
|
|
|
## Purpose
|
|
|
|
This directory contains:
|
|
|
|
- Step-by-step implementation plans
|
|
- Working notes during development
|
|
- AI-agent context for executing RFCs
|
|
- Completed work logs with key decisions
|
|
|
|
## What Belongs Here
|
|
|
|
- Implementation details and code snippets
|
|
- Debugging notes and discoveries
|
|
- Task breakdowns for complex features
|
|
- Post-implementation summaries
|
|
|
|
## What Doesn't Belong Here
|
|
|
|
Design proposals and architectural decisions belong in `/rfc`. This directory is for **how** to implement, not **what** or **why**.
|
|
|
|
## Compaction Rule
|
|
|
|
Before merging a PR, compact completed plans:
|
|
|
|
1. Remove verbose implementation details
|
|
2. Point to PR and commits for specifics
|
|
3. Keep key decisions and important notes
|
|
4. Update status to COMPLETED
|
|
|
|
Example compacted plan:
|
|
|
|
```markdown
|
|
# Feature Name
|
|
|
|
**Status:** COMPLETED
|
|
**PR:** [#123](https://github.com/videojs/v10/pull/123)
|
|
|
|
## Summary
|
|
|
|
Brief description of what was implemented.
|
|
|
|
## Key Decisions
|
|
|
|
- Decision 1: Rationale
|
|
- Decision 2: Rationale
|
|
|
|
## Notes
|
|
|
|
Any gotchas or important context for future reference.
|
|
```
|
|
|
|
## See Also
|
|
|
|
- [Design Docs](/internal/design/README.md) — Decisions you own
|
|
- [RFCs](/rfc/README.md) — Proposals needing buy-in
|
|
- [CLAUDE.md](/CLAUDE.md#design-documents) — How these relate
|