Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (41 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.8 KB

Contributing to PythonClaw

Thank you for your interest in contributing to PythonClaw! We welcome contributions of all kinds — bug fixes, new features, documentation improvements, and more.

Getting Started

git clone https://github.com/ericwang915/PythonClaw.git
cd PythonClaw
python -m venv .venv && source .venv/bin/activate
pip install -e .
pytest tests/ -v

How to Contribute

Reporting Bugs

  • Search existing issues first.
  • If not found, open a new issue with a clear title, description, and reproduction steps.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code, add tests.
  3. Ensure the test suite passes: pytest tests/ -v
  4. Make sure your code follows the style guide.
  5. Submit the pull request!

Code Style

  • Follow PEP 8 standards.
  • Use Ruff for linting: ruff check pythonclaw/
  • Use meaningful variable names.
  • Avoid redundant comments — code should be self-documenting.

Adding New Skills

  1. Create a directory under pythonclaw/templates/skills/<category>/<skill_name>/.
  2. Add a SKILL.md with clear instructions for the agent.
  3. Add any supporting scripts.
  4. Submit a PR.

Adding New LLM Providers

  1. Create a new file in pythonclaw/core/llm/.
  2. Implement the LLMProvider interface from base.py.
  3. Add the provider option to main.py:_build_provider().
  4. Add tests and documentation.

Adding New Channels

  1. Create a new file in pythonclaw/channels/.
  2. Use SessionManager for agent lifecycle management and concurrency control.
  3. Follow the telegram_bot.py pattern (use sm.acquire(sid) for async handlers).
  4. Wire the channel into server.py, main.py, and onboard.py.

Thanks for helping make PythonClaw better!