This directory contains implementation proposals for CIT features and major changes.
Implementation proposals provide a structured way to:
- Document design decisions before implementation
- Gather feedback from reviewers
- Track requirements and acceptance criteria
- Maintain historical context for future reference
docs/proposals/
├── README.md (this file)
├── IMPL-2026-01-25-job-management.md
├── IMPL-2026-02-01-webhook-support.md
└── archive/
└── IMPL-2025-12-15-deprecated-feature.md
Proposals use the format: IMPL-YYYY-MM-DD-<short-name>.md
Examples:
IMPL-2026-01-25-job-management.mdIMPL-2026-01-30-rate-limiting.mdIMPL-2026-02-05-multi-model-support.md
- Draft - Initial proposal created, under development
- Under Review - Submitted for team review
- Approved - Reviewed and approved, ready for implementation
- Rejected - Not approved, moved to archive/
- Implemented - Completed and merged to main
- Superseded - Replaced by newer proposal, moved to archive/
-
Copy the template:
cp docs/IMPLEMENTATION_PROPOSAL_TEMPLATE.md docs/proposals/IMPL-$(date +%Y-%m-%d)-my-feature.md -
Fill in the sections (see PROPOSAL_GUIDE.md)
-
Submit for review:
git checkout -b proposal/my-feature git add docs/proposals/IMPL-*-my-feature.md git commit -m "Proposal: Add my feature" git push origin proposal/my-feature # Create PR on GitHub
- Read PROPOSAL_GUIDE.md before creating a proposal
- Use IMPLEMENTATION_PROPOSAL_TEMPLATE.md as a starting point
- Keep proposals focused on a single feature or change
- Update proposal status as work progresses
- Move completed/rejected proposals to archive/ after 6 months
Currently active proposals:
None yet - this is the first proposal system setup
See archive/ for historical proposals.
- Quick Reference - ⚡ Fast 5-minute guide
- Implementation Proposal Template
- Proposal Guide - Complete guide with examples
- CIT Architecture
- Copilot Instructions
For questions about the proposal process, open an issue or ask in the PR.