Skip to content

Add agent-native contribution workflow doc for Rooms #48

Description

@rosspeili

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

  1. 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
  2. Link prominently from CONTRIBUTING.md ("If you are an AI agent, read this first").

  3. Optional: root AGENTS.md one-screen pointer to the full workflow (GitHub/Cursor discoverability).

  4. 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).

  5. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions