Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
103 lines (72 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

103 lines (72 loc) · 2.14 KB

Contributing Guidelines

Thank you for contributing to the Robota project! This document provides guidelines on how to contribute to the project.

Development Environment Setup

  1. Clone the repository:
git clone https://github.com/woojubb/robota.git
cd robota
  1. Install dependencies:
pnpm install
  1. Run development server:
pnpm dev

Project Structure

Robota is designed as a monorepo structure, consisting of the following packages:

  • packages/core: Core modules and common interfaces
  • packages/openai: OpenAI integration
  • packages/anthropic: Anthropic integration
  • packages/tools: Tools and utilities
  • apps/docs: Documentation website
  • packages/*/examples: Package-owned example code

Developing New Features

  1. Create a new branch:
git checkout -b feature/your-feature-name
  1. Write code and run tests:
pnpm test
  1. Commit and push:
git add .
git commit -m "feat: your description"
git push origin feature/your-feature-name
  1. Submit a Pull Request

Commit Message Convention

Commit messages should follow this format:

  • feat: Add new feature
  • fix: Bug fix
  • docs: Documentation changes
  • style: Code formatting, missing semicolons, etc. (no code changes)
  • refactor: Code refactoring
  • test: Test-related code
  • chore: Build process or auxiliary tool changes

Guidelines:

  • Keep commit messages under 80 characters
  • Use English for all commit messages
  • Write in present tense (e.g., "add feature" not "added feature")
  • Be concise but descriptive

Examples:

  • ✅ feat: add gpt-4o model support to OpenAI provider
  • ✅ fix: resolve memory leak in cache manager
  • ❌ feat: add gpt-4o model support to OpenAI provider with comprehensive error handling and validation (too long)

Pull Request Guidelines

  1. Clear title and description
  2. Link related issues
  3. Include tests for changes
  4. Update documentation (if necessary)

Code Style

  • The project uses ESLint and Prettier.
  • Check code style before committing:
pnpm lint
pnpm format

License

All contributions are provided under the project's MIT license.