Contributing to Clawd Code

Contributing to Clawd Code

Thank you for your interest in contributing to Clawd Code! This document provides guidelines and instructions for contributing.

Table of Contents

• Code of Conduct
• Development Setup
• Project Structure
• Coding Standards
• Commit Guidelines
• Pull Request Process
• Testing

Code of Conduct

This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

Development Setup

Prerequisites

• Python 3.10 or higher (3.11 recommended for local development)
• uv (recommended) or pip
• git
• A valid API key from at least one provider (Anthropic, OpenAI, or GLM)

Initial Setup

1. Fork and clone the repository

# Fork the repo on GitHub, then:
git clone https://github.com/YOUR_USERNAME/Clawd-Code.git
cd Clawd-Code

1. Create a virtual environment

uv venv --python 3.11
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

1. Install dependencies

uv pip install -r requirements.txt
uv pip install -e ".[dev]"

1. Install development tools

uv pip install black isort mypy pytest

1. Configure your API key

python -m src.cli login
# or use environment variables such as GLM_API_KEY / OPENAI_API_KEY / ANTHROPIC_API_KEY

1. Run tests to verify setup

python -m pytest tests/ -q

Project Structure

Clawd-Code/
├── src/                    # Source code
│   ├── providers/         # LLM provider implementations
│   ├── repl/              # Interactive REPL
│   ├── agent/             # Session management
│   ├── skills/            # SKILL.md loading and creation
│   ├── tool_system/       # Tool registry, loop, validation
│   ├── config.py          # Configuration management
│   └── cli.py             # CLI commands
├── tests/                 # Test files
├── .github/               # GitHub workflows and templates
├── requirements.txt       # Python dependencies
├── pyproject.toml         # Project metadata
└── README.md              # Project overview

Key Modules

• **`src/providers/`**: LLM provider implementations

  • base.py: Abstract base class for providers
  • anthropic_provider.py: Anthropic/Claude integration
  • openai_provider.py: OpenAI/GPT integration
  • glm_provider.py: GLM/Zhipu AI integration

• **`src/repl/`**: Interactive REPL implementation

  • core.py: Main REPL logic

• **`src/agent/`**: Session and conversation management

  • session.py: Session persistence
  • conversation.py: Message history

• **`src/config.py`**: Configuration management

  • Load/save configuration
  • API key management
  • Provider settings

• **`src/cli.py`