docs: add ROADMAP.md template and roadmap rules

This commit is contained in:
imfozilbek
2025-12-22 00:38:57 +05:00
parent d900979c4e
commit cca8da08cd
2 changed files with 264 additions and 0 deletions

View File

@@ -289,6 +289,48 @@ git push origin main --tags
**⛔ MUST read `./ROADMAP.md` first** to understand current status.
## ROADMAP.md Rules (MANDATORY)
**⛔ Every monorepo MUST have `ROADMAP.md` in root.**
| Rule | Requirement |
|------|-------------|
| **Structure** | Phases → Milestones → Tasks with checkboxes |
| **Versioning** | Each package has independent semver (v0.1.0) |
| **Dependencies** | Show "Depends on: package vX.X.X" |
| **Status table** | Current version + next milestone per package |
| **Architecture** | ASCII diagram of package relationships |
**Milestone format:**
```markdown
#### 1.1 @project/core v0.1.0 - Feature Name
> **Depends on:** `@project/other v0.1.0`
| Task | Status |
|------|--------|
| Task description | [x] or [ ] |
```
**Status indicators:**
```
✅ Completed | 🔄 In Progress | ⏳ Planned
```
**⛔ RULES:**
- Update ROADMAP.md BEFORE starting new milestone
- Mark tasks `[x]` immediately when done
- Update "Current Status" table after each release
- Never skip dependency order (core → api → clients)
- One package version = one atomic milestone
**Dependency order (always):**
```
1. @project/core (domain, types, use cases)
2. @project/api (uses core)
3. @project/client (re-exports from core)
4. @project/web (uses client + api)
```
## Shared Code Policy
**⛔ Code duplication is PROHIBITED.**