← スキル一覧に戻る

oe-docs-updates
by shami-ah
⭐ 0🍴 1📅 2026年1月21日
SKILL.md
name: oe-docs-updates description: Keeps OpenEvent-AI “living docs” in sync while coding. Use whenever you fix a bug, discover a new bug, add/modify behavior, or capture a future idea. Updates docs/guides/TEAM_GUIDE.md (bug list + regressions), DEV_CHANGELOG.md (what changed), new_features.md (ideas parked for later), and TO_DO_NEXT_SESS.md (next-session tasks).
oe-docs-updates
Workflow (keep entries small + actionable)
-
If you fixed a bug
- Update
docs/guides/TEAM_GUIDE.md:- Find the matching bug entry (search by keywords).
- Mark status as fixed (or add “Fixed” note).
- Add a link/reference to the regression test that now covers it (prefer
backend/tests/regression/test_team_guide_bugs.pyor a specs test).
- Update
DEV_CHANGELOG.md:- Add a short entry under today’s date: what changed + which tests verify it.
- Update
-
If you discovered a bug but didn’t fix it
- Update
docs/guides/TEAM_GUIDE.md:- Add it under the appropriate “Known Issues / Bugs” section.
- Include: symptom, likely trigger, suspected module(s), minimal repro hint, and a suggested test file location.
- Update
TO_DO_NEXT_SESS.md:- Add a single-line task with priority and where to start (file path + test to write/run).
- Update
-
If you added a feature or changed UX/behavior
- Update
DEV_CHANGELOG.md:- Add: new behavior + migration/compat note (if any) + tests.
- If it’s an idea that you are intentionally not implementing now:
- Write it to
new_features.mdinstead (see below).
- Write it to
- Update
-
If you found a “future idea” while debugging
- Add it to
new_features.md:- Keep it as a small ticket: context → current pain → proposed solution → files likely touched → priority.
- Do not mix in a partial implementation here.
- Add it to
Style rules (important for debugging agents)
- Prefer searchable keywords in headings and bullets (“billing capture”, “site visit”, “detour”, “HIL”, “smart shortcuts”).
- Always include one concrete pointer: failing test name, script path, or function/module.
- Avoid long narratives. Target: ≤10 lines per doc update.
スコア
総合スコア
50/100
リポジトリの品質指標に基づく評価
✓SKILL.md
SKILL.mdファイルが含まれている
+20
○LICENSE
ライセンスが設定されている
0/10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
レビュー
💬
レビュー機能は近日公開予定です