diff --git a/docs/dev-rule.md b/docs/dev-rule.md index 1884b6ff..ad2386f7 100644 --- a/docs/dev-rule.md +++ b/docs/dev-rule.md @@ -1,19 +1,19 @@ -**Simplest starting system (GitHub Issues + Milestones)** +### Simplest starting system (GitHub Issues + Milestones) -1. Create **Milestones** (these are your big phases): +1. **Create Milestones (these are your big phases):** - v0.1 – Minimal end-to-end loop (manual trigger, 1 ticker, basic buy + guardian sell) - v0.2 – Scheduler + Profit Guardian polish - v0.3 – Multi-ticker + Dashboard - Backtesting foundation - Experiments & Research -2. Create **Issue labels** (keep to 6–8 max): +2. **Create Issue labels (keep to 6–8 max):** - priority:high / priority:medium - area:graph / area:agents / area:tools / area:data / area:ui / area:config - type:bug / type:feature / type:refactor / type:experiment - status:blocked (use when waiting on API key, etc.) -3. Workflow for a typical work session: +3. **Workflow for a typical work session:** - Open repo → look at Milestone “v0.1” - Pick 1–3 small issues (ideally < 2–4 hours each) - Create branch: `git checkout -b 47-add-profit-guardian-node` @@ -27,12 +27,3 @@ - Merge (you can squash or rebase — solo so whatever feels clean) -### Daily / Weekly Rituals (prevents chaos) -- **Start session (5 min)**: Open GitHub → see open issues in current milestone → pick 1 thing -- **End session (5 min)**: - - Commit & push even if incomplete - - Write quick note in issue or `docs/log.md`: “Today: implemented trailing stop calc. Tomorrow: test with SHOP data gap.” -- **Weekly (Sunday? 15–30 min)**: - - Review open issues → close stale ones or move to “parking lot” milestone - - Update `README.md` status section (very motivating) - - Run quick manual test / backtest → screenshot result → drop in issue or docs/screenshots/