Problem Statement
Skillware documents an Agent Contribution Workflow (docs/contributing/ai_native_workflow.md): staged process (prepare → analyze → plan approval → implement → verify → commit → PR/CI), complementary paths table, verification checklists by contribution type, and explicit operator/agent roles. It is linked from CONTRIBUTING.md as the first read for AI agents.
Rooms has no equivalent. Agents and operators working on issues (#29–#37, future PRs) improvise scope, miss complementary files (settings example, preflight, smoke tests), and skip changelog/docs updates. This slows review and duplicates maintainer feedback.
Proposed Solution
-
Add docs/contributing/ai_native_workflow.md adapted from Skillware's structure for Rooms:
Stages: prepare repo → analyze issue → plan + operator approval → implement → verify → commit/push → PR/CI
Complementary paths table (Rooms-specific):
| If the issue involves… |
Also inspect |
| CLI / wizard |
cli.py (or rooms/cli.py), docs/EXAMPLES.md, smoke tests |
| Settings YAML |
rooms/settings.py, rooms.settings.example.yaml, tests/test_settings.py |
| Ollama / local models |
rooms/ollama_preflight.py, preflight tests, --skip-preflight docs |
| Session / routing |
rooms/session.py, rooms/agent.py, tests/test_session.py |
| User-visible behavior |
CHANGELOG.md [Unreleased], README if install/usage changes |
-
Link prominently from CONTRIBUTING.md ("If you are an AI agent, read this first").
-
Optional: root AGENTS.md one-screen pointer to the full workflow (GitHub/Cursor discoverability).
-
Add lightweight Agent Code of Conduct section or link — scope discipline, no secrets, no emojis in commits if we adopt Skillware convention (decide in PR).
-
Verification checklists for: core framework, CLI, docs-only, bug fix, good first issue.
Acceptance criteria
Alternatives Considered
- Cursor rules only (
.cursor/rules) — optional supplement; repo-hosted markdown is portable across tools (Skillware choice).
- Copy Skillware file verbatim — rejected; complementary paths and packages differ.
Priority
Medium 🟡
Additional Context
Skillware ref: docs/contributing/ai_native_workflow.md, linked from CONTRIBUTING.md and Code of Conduct contribution-process section.
Depends loosely on CONTRIBUTING overhaul (#3) but can land in either order.
Problem Statement
Skillware documents an Agent Contribution Workflow (
docs/contributing/ai_native_workflow.md): staged process (prepare → analyze → plan approval → implement → verify → commit → PR/CI), complementary paths table, verification checklists by contribution type, and explicit operator/agent roles. It is linked fromCONTRIBUTING.mdas the first read for AI agents.Rooms has no equivalent. Agents and operators working on issues (#29–#37, future PRs) improvise scope, miss complementary files (settings example, preflight, smoke tests), and skip changelog/docs updates. This slows review and duplicates maintainer feedback.
Proposed Solution
Add
docs/contributing/ai_native_workflow.mdadapted from Skillware's structure for Rooms:Stages: prepare repo → analyze issue → plan + operator approval → implement → verify → commit/push → PR/CI
Complementary paths table (Rooms-specific):
cli.py(orrooms/cli.py),docs/EXAMPLES.md, smoke testsrooms/settings.py,rooms.settings.example.yaml,tests/test_settings.pyrooms/ollama_preflight.py, preflight tests,--skip-preflightdocsrooms/session.py,rooms/agent.py,tests/test_session.pyCHANGELOG.md[Unreleased], README if install/usage changesLink prominently from
CONTRIBUTING.md("If you are an AI agent, read this first").Optional: root
AGENTS.mdone-screen pointer to the full workflow (GitHub/Cursor discoverability).Add lightweight Agent Code of Conduct section or link — scope discipline, no secrets, no emojis in commits if we adopt Skillware convention (decide in PR).
Verification checklists for: core framework, CLI, docs-only, bug fix, good first issue.
Acceptance criteria
skills/references except optional feat: Integrate Skillware for Live Agent Tool Use & Control Room Orchestration #23 Skillware integration note)Alternatives Considered
.cursor/rules) — optional supplement; repo-hosted markdown is portable across tools (Skillware choice).Priority
Medium 🟡
Additional Context
Skillware ref:
docs/contributing/ai_native_workflow.md, linked fromCONTRIBUTING.mdand Code of Conduct contribution-process section.Depends loosely on CONTRIBUTING overhaul (#3) but can land in either order.