Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
484 lines (352 loc) · 12.1 KB

CONTRIBUTING.md

File metadata and controls

484 lines (352 loc) · 12.1 KB

Contributing Guide

Welcome to contribute to the Wegent project! Wegent is an AI agent-based intelligent code generation and automated execution platform with a cloud-native microservices architecture. We warmly welcome all forms of contributions, including but not limited to code submissions, documentation improvements, bug reports, and feature suggestions.

📋 Table of Contents

🎯 Project Overview

Wegent is an AI agent management platform based on Kubernetes-style CRD design, with key features including:

  • Cloud-Native Architecture: Microservices architecture supporting horizontal scaling
  • Declarative API: Kubernetes-style CRD resource management
  • AI Agent Ecosystem: Supporting core concepts like Ghost, Model, Shell, Bot
  • Task Collaboration: Team and Task mechanisms for multi-agent collaboration
  • Containerized Execution: Isolated execution environments ensuring security

Core Components

  • Frontend: Next.js + TypeScript + Tailwind CSS
  • Backend: FastAPI + SQLAlchemy + MySQL
  • Executor: Python + Docker containers
  • Executor Manager: Task scheduling and management
  • AI Services: Claude Code (supporting more model extensions)

🛠️ Development Environment Setup

Prerequisites

  • Docker >= 20.10
  • Docker Compose >= 2.0
  • Node.js >= 18.0 (for frontend development)
  • Python >= 3.10 (for backend development)
  • Git

Quick Start

  1. Clone the repository

    git clone https://github.com/your-org/Wegent.git
cd Wegent

  2. Start all services

    docker compose up -d

  3. Access the application

Local Development Environment

Frontend Development

cd frontend
npm install
npm run dev

Backend Development

cd backend
./start.sh
# Or manually: uv sync && source .venv/bin/activate
# Configure environment variables
export DATABASE_URL="mysql://user:password@localhost/wegent"
uvicorn app.main:app --reload --host 0.0.0.0 --port 8000

Executor Development

cd executor
./start.sh
# Or manually: uv sync && source .venv/bin/activate && python main.py

🏗️ Project Architecture

Directory Structure

Wegent/
├── frontend/          # Next.js frontend application
│   ├── src/
│   │   ├── app/       # App Router pages
│   │   ├── apis/      # API clients
│   │   ├── features/  # Feature modules
│   │   └── types/     # TypeScript type definitions
│   └── package.json
├── backend/           # FastAPI backend service
│   ├── app/
│   │   ├── api/       # API routes
│   │   ├── core/      # Core configuration
│   │   ├── models/    # Data models
│   │   ├── schemas/   # Pydantic schemas
│   │   └── services/  # Business logic
│   └── pyproject.toml # Dependencies
├── executor/          # Task executor
├── executor_manager/  # Executor manager
├── shared/           # Shared utilities and models
└── docker/           # Docker configuration files

CRD Resource Model

The project adopts Kubernetes-style CRD design with core resources including:

  • Ghost 👻: AI agent's soul and behavior definition
  • Model 🧠: AI model configuration
  • Shell 🐚: Runtime environment configuration
  • Bot 🤖: Specific agent instances
  • Team 👥: Agent collaboration teams
  • Workspace 💼: Work environments
  • Task 🎯: Executable tasks

🔄 Development Workflow

1. Create Branch

# Create feature branch from main
git checkout main
git pull origin main
git checkout -b feature/your-feature-name

2. Development Work

  • Follow code standards
  • Write unit tests
  • Update related documentation
  • Ensure code passes all checks

3. Commit Code

git add .
git commit -m "feat: add new feature description"

4. Push Code (Quality Checks Run Here)

Pre-push Setup (Required)

Wegent uses pre-commit hooks to ensure code quality before pushing. This is especially important for AI coding agents (Claude Code, Cursor, etc.).

# Install pre-commit
pip install pre-commit

# Install pre-push hooks
pre-commit install --hook-type pre-push

Pre-push Quality Checks

When pushing code, pre-commit automatically runs quality checks:

  • Lint & Format (Black, isort, ESLint)
  • Type Check (TypeScript, mypy)
  • Unit Tests (only for changed modules)
  • Build Check (syntax validation)
  • Documentation update reminders
# Push to remote (triggers quality checks)
git push origin feature/your-feature-name

# If documentation reminders shown, verify and push
AI_VERIFIED=1 git push origin feature/your-feature-name

# Skip checks if needed (not recommended)
git push --no-verify origin feature/your-feature-name

Manual Quality Checks

# Run all pre-push checks manually
pre-commit run --all-files --hook-stage pre-push

# Run specific checks
pre-commit run black --all-files
pre-commit run eslint-frontend --all-files

5. Create Pull Request

  • Fill out complete PR description
  • Link related issues
  • Request code review
  • Respond to review feedback

📝 Code Standards

Python Code Standards (Backend/Executor)

  • Follow PEP 8 standards
  • Use Black for code formatting
  • Use isort for import organization
  • Use pylint for code checking
# Code formatting
black .
isort .

# Code checking
pylint app/

TypeScript Code Standards (Frontend)

  • Use ESLint + Prettier
  • Follow TypeScript best practices
  • Use strict type checking
# Code checking and formatting
npm run lint
npm run format

General Standards

  • Use descriptive naming for functions and variables
  • Add necessary comments and docstrings
  • Keep code clean and readable
  • Avoid duplicate code, extract common logic

📨 Commit Conventions

Use Conventional Commits specification:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit Types

  • feat: New features
  • fix: Bug fixes
  • docs: Documentation updates
  • style: Code formatting
  • refactor: Code refactoring
  • test: Test-related
  • chore: Build and tooling-related

Examples

feat(backend): add user authentication API

fix(frontend): resolve task status display issue

docs: update contributing guide

refactor(executor): improve error handling

🧪 Testing Requirements

Wegent uses comprehensive testing frameworks across all modules. All code changes should include appropriate tests.

Backend Testing

  • Use pytest with pytest-asyncio, pytest-cov, and pytest-mock
  • Write unit tests for all business logic
  • Add integration tests for API endpoints and database operations
  • Target: Maintain or improve code coverage (minimum 40-60%, target 70-80%)
  • Use test markers: @pytest.mark.unit, @pytest.mark.integration, @pytest.mark.slow
cd backend
# Run all tests
pytest

# Run with coverage
pytest --cov=app --cov-report=html

# Run only unit tests
pytest -m unit

Frontend Testing

  • Use Jest + React Testing Library
  • Write component unit tests
  • Mock API calls and external dependencies
  • Add E2E tests for critical user flows (Playwright)
cd frontend
npm test
npm run test:coverage

Executor and Shared Module Testing

  • Mock external services (Anthropic, OpenAI, Docker, etc.)
  • Test error handling and edge cases
  • Use fixtures for common test setup
# Executor tests
cd executor
pytest tests/ --cov=agents

# Executor Manager tests
cd executor_manager
pytest tests/ --cov=executors

# Shared utilities tests
cd shared
pytest tests/ --cov=utils

Test Organization Best Practices

  1. Follow AAA Pattern: Arrange, Act, Assert
  2. One assertion per test: Each test should verify one specific behavior
  3. Descriptive test names: Use clear names that explain what is being tested
  4. Mock external dependencies: Never call real external services in tests
  5. Use fixtures: Share common setup via pytest fixtures
  6. Test edge cases: Include tests for error conditions and boundary values
  7. Keep tests independent: Each test should run independently

CI/CD Testing

All tests run automatically via GitHub Actions on:

  • Push to main, master, or develop branches
  • All pull requests

The test suite includes:

  • Backend tests (Python 3.10, 3.11, 3.12)
  • Executor tests
  • Executor Manager tests
  • Shared utilities tests
  • Frontend tests (Node.js 18.x)

Coverage reports are uploaded to Codecov.

For detailed testing documentation, see:

📚 Documentation Requirements

API Documentation

  • Use FastAPI auto-generated Swagger documentation
  • Add detailed descriptions for all endpoints
  • Provide request/response examples

Code Documentation

  • Python: Use docstring format
  • TypeScript: Use JSDoc comments
  • Add inline comments for complex logic

User Documentation

  • Keep README.md up to date
  • Feature usage guides
  • Troubleshooting documentation

🐛 Bug Reports

When reporting bugs using GitHub Issues, please include:

  1. Environment Information

    • Operating system
    • Docker version
    • Browser version (for frontend issues)

  2. Reproduction Steps

    • Detailed operation steps
    • Expected behavior
    • Actual behavior

  3. Related Logs

    • Error messages
    • Console output
    • Service logs

  4. Screenshots or Screen Recording (if applicable)

💡 Feature Requests

When submitting feature requests, please describe:

  • Feature description and use cases
  • Expected user experience
  • Possible implementation approaches
  • Impact on existing features

👀 Code Review

Review Checklist

  • Code follows standards
  • Features correctly implemented
  • Sufficient test coverage
  • Documentation updated completely
  • Performance impact assessed
  • Security considerations
  • Backward compatibility

Review Principles

  • Constructive feedback
  • Focus on code quality
  • Consider maintainability
  • Respect different viewpoints

🚀 Release Process

Version Management

Use Semantic Versioning (SemVer):

  • MAJOR.MINOR.PATCH
  • Major version: Incompatible API changes
  • Minor version: Backward-compatible feature additions
  • Patch version: Backward-compatible bug fixes

Release Steps

  1. Update version number
  2. Update CHANGELOG.md
  3. Create release branch
  4. Code review and testing
  5. Merge to main branch
  6. Create Git tag
  7. Build and publish Docker images

🤝 Community Code of Conduct

We are committed to providing a friendly, safe, and welcoming environment for everyone. Please follow these principles:

  • Use friendly and inclusive language
  • Respect different viewpoints and experiences
  • Gracefully accept constructive criticism
  • Focus on what is best for the community
  • Show empathy towards other community members

📞 Contact

If you have any questions, feel free to contact us through:

  • GitHub Issues: Report bugs and feature requests
  • GitHub Discussions: Community discussions and Q&A
  • Email: [maintainer email]

📄 License

This project is licensed under the Apache 2.0 License. By contributing code, you agree that your contributions will be licensed under the same license.

Thank you for contributing to the Wegent project! 🎉