Skip to content

Commit 113675f

Browse files
thomas-manginclaude
andcommitted
docs: Clean up completed plans and update todo tracking
Remove 13 completed plan files: - buffer-standardization.md, nlri-buffer-ready.md, nlri-collection.md - nlri-packed-base.md, nlri.md, update-attributes-refactor.md - update-wire-separation.md, eliminate-change-class.md - api-dispatch-refactor.md, api-v6-test.md, api-versioning.md - python312-buffer.md, run-script-migration-complete.md Update remaining plans: - byte-interning.md: Document existing caching, plan for NLRI qualifiers - todo.md: Add completed work to history with commit references - README.md: Simplified with current plan index 11 plan files remain (2 active, 8 planning, 1 readme). 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent eebb645 commit 113675f

16 files changed

+258
-3576
lines changed

plan/README.md

Lines changed: 27 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -1,117 +1,51 @@
11
# ExaBGP Plans Directory
22

3-
## Naming Convention
4-
5-
### Directory Structure
3+
## Current Plans
4+
5+
| Plan | Status | Description |
6+
|------|--------|-------------|
7+
| `todo.md` | 🔄 Active | Master TODO list with project tracking |
8+
| `coverage.md` | 🔄 Active | Test coverage improvement (59.71% → 60%) |
9+
| `byte-interning.md` | 🔄 Partial | LRU caching for NLRI qualifiers |
10+
| `addpath-nlri.md` | 📋 Planning | ADD-PATH for more NLRI types |
11+
| `architecture.md` | 📋 Planning | Circular dependency fixes |
12+
| `code-quality.md` | 📋 Planning | Misc improvements (low priority) |
13+
| `family-tuple.md` | 📋 Planning | FamilyTuple type alias |
14+
| `rib-improvement-proposals.md` | 📋 Discussion | RIB improvement ideas |
15+
| `runtime-validation-plan.md` | 📋 Planning | Runtime validation |
16+
| `security-validation.md` | 📋 Planning | Security validation |
617

7-
```
8-
plan/
9-
├── README.md # This file - naming conventions
10-
├── todo.md # Master TODO list with references
11-
12-
├── # Active multi-file projects (directories)
13-
├── type-safety/ # Type annotations project
14-
│ ├── README.md # Project overview
15-
│ ├── progress.md # Current progress
16-
│ └── *.md # Sub-plans
17-
18-
├── packed-bytes/ # Packed-bytes-first refactoring
19-
│ ├── README.md
20-
│ └── progress.md
21-
22-
├── runtime-validation/ # Security: input validation
23-
│ ├── README.md
24-
│ └── *.md
25-
26-
├── comment-cleanup/ # XXX comment resolution (✅ Complete)
27-
│ ├── README.md
28-
│ └── TODO.md
29-
30-
├── # Single-file plans (standalone .md files)
31-
├── coverage.md # Test coverage improvement
32-
├── python312-buffer.md # Python 3.12 migration
33-
├── addpath-nlri.md # AddPath feature expansion
34-
├── architecture.md # Circular dependency fixes
35-
├── security-validation.md # Config parser validation
36-
├── code-quality.md # Low-priority improvements
37-
└── family-tuple.md # FamilyTuple standardization
38-
```
18+
## Naming Convention
3919

4020
### Naming Rules
4121

42-
1. **Directories** - For multi-file projects with sub-plans
43-
- Use kebab-case: `type-safety/`, `packed-bytes/`
44-
- MUST contain `README.md` with overview
45-
- May contain `progress.md` for tracking
46-
- Sub-plans use UPPER_SNAKE_CASE: `MYPY_STATUS.md`
47-
48-
2. **Single files** - For standalone plans
49-
- Use kebab-case: `coverage.md`, `addpath-nlri.md`
50-
- Short, descriptive names (2-3 words max)
51-
- No prefixes like `PLAN_` or `TODO_`
52-
53-
3. **Progress/Status files**
54-
- `progress.md` - Current state tracking (in directories)
55-
- `TODO.md` - Remaining work items (in directories)
56-
57-
4. **Archive directories**
58-
- `archive/` subdirectory for historical docs
59-
- Preserve for context, mark as historical
22+
1. **Single files** - kebab-case: `coverage.md`, `addpath-nlri.md`
23+
2. **Short names** - 2-3 words max, descriptive
24+
3. **No prefixes** - Don't use `PLAN_` or `TODO_`
6025

6126
### File Template
6227

6328
```markdown
6429
# [Title]
6530

6631
**Status:** [emoji] [Active|Planning|Completed|On Hold]
67-
**Started:** YYYY-MM-DD
68-
**Last Updated:** YYYY-MM-DD
69-
**See also:** [related files]
32+
**Created:** YYYY-MM-DD
33+
**Updated:** YYYY-MM-DD
7034

7135
## Goal
7236

7337
[1-2 sentence summary]
7438

75-
## Scope
76-
77-
[What's included/excluded]
78-
7939
## Progress
8040

81-
| Item | Status |
82-
|------|--------|
83-
| ... | ... |
41+
- [x] Completed item
42+
- [ ] Pending item
8443

8544
## Files to Modify
8645

87-
[List of affected files]
88-
89-
## Risks
90-
91-
[Known risks and mitigations]
92-
93-
## Recent Failures
94-
95-
| Date | Test | Error | Root Cause | Status |
96-
|------|------|-------|------------|--------|
97-
| 2025-12-04 | test_example | AssertionError: ... | Off-by-one | ✅ Fixed |
98-
99-
## Blockers
100-
101-
| Blocker | Discovered | Status | Notes |
102-
|---------|------------|--------|-------|
103-
| Need API change | 2025-12-03 | 🔴 Blocking | Discuss with team |
104-
105-
## Resume Point
106-
107-
**Last worked:** YYYY-MM-DD
108-
**Last commit:** [hash or "uncommitted"]
109-
**Session ended:** Mid-task / Clean break / Blocked
110-
111-
**To resume:**
112-
1. [Exact next step to take]
113-
2. [Context needed]
114-
3. [Watch out for: potential issues]
46+
| File | Change |
47+
|------|--------|
48+
| ... | ... |
11549
```
11650

11751
### Status Emojis
@@ -120,10 +54,9 @@ plan/
12054
|-------|---------|
12155
| 🔄 | Active - work in progress |
12256
| 📋 | Planning - not started |
123-
|| Completed |
57+
|| Completed (delete when done) |
12458
| ⏸️ | On Hold |
125-
|| Cancelled |
12659

12760
---
12861

129-
**Last Updated:** 2025-12-04
62+
**Updated:** 2025-12-06

plan/api-dispatch-refactor.md

Lines changed: 0 additions & 102 deletions
This file was deleted.

0 commit comments

Comments
 (0)