CONTRIBUTING.md

Contributing

Development Setup

Install dependencies:

pip install -r requirements.txt

Optional adapters:

pip install ".[telegram]"
pip install ".[feishu]"

Workflow

1. Make focused changes.
2. Keep runtime behavior deterministic.
3. Prefer skill-local logic over global magic.
4. Add or update tests for behavior changes.
5. Run the full test suite before handing off changes.

Code Guidelines

• Keep skills small and explicit.
• Keep shared prompt injection opt-in.
• Prefer config-driven provider and channel wiring.
• Do not reintroduce chat-first orchestration into the runtime core.
• Treat adapters as thin I/O boundaries.

Tests

Run:

python -m pytest

Documentation

When adding a new runtime capability, update the relevant docs:

• README.md for public-facing overview
• doc/base_config_guide.md for central config changes
• doc/skill_writer_guide.md if skill generation behavior changes
• doc/architecture.md if the runtime structure or extension boundaries change

Pull Request Expectations

• explain what changed
• explain why it changed
• mention tests run
• mention known limitations or follow-up work