Skip to content

Contribution Guidelines

Welcome! This guide provides all the details you need to contribute effectively to the project. Thank you for helping us make octotask a better tool for developers worldwide. 💡

📋 Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Pull Request Guidelines
  4. Coding Standards
  5. Development Setup
  6. Testing
  7. Deployment
  8. Docker Deployment
  9. VS Code Dev Containers Integration

🛡️ Code of Conduct

This project is governed by our Code of Conduct. By participating, you agree to uphold this code. Report unacceptable behavior to the project maintainers.

🛠️ How Can I Contribute?

1️⃣ Reporting Bugs or Feature Requests

  • Check the issue tracker to avoid duplicates.
  • Use issue templates (if available).
  • Provide detailed, relevant information and steps to reproduce bugs.

2️⃣ Code Contributions

  1. Fork the repository.
  2. Create a feature or fix branch.
  3. Write and test your code.
  4. Submit a pull request (PR).

3️⃣ Join as a Core Contributor

✅ Pull Request Guidelines

PR Checklist

  • Branch from the main branch.
  • Update documentation, if needed.
  • Test all functionality manually.
  • Focus on one feature/bug per PR.

Review Process

  1. Manual testing by reviewers.
  2. At least one maintainer review required.
  3. Address review comments.
  4. Maintain a clean commit history.

📏 Coding Standards

General Guidelines

  • Follow existing code style.
  • Comment complex logic.
  • Keep functions small and focused.
  • Use meaningful variable names.

🖥️ Development Setup

1️⃣ Initial Setup

  • Clone the repository: 
    git clone https://github.com/octotask/octotask.git
  • Install dependencies: 
    pnpm install
  • Set up environment variables:
  • Rename .env.example to .env.local.
  • Add your API keys: 
    GROQ_API_KEY=XXX
HuggingFace_API_KEY=XXX
OPENAI_API_KEY=XXX
...
  • Optionally set:
    • Debug level: VITE_LOG_LEVEL=debug
    • Context size: DEFAULT_NUM_CTX=32768

Note: Never commit your .env.local file to version control. It's already in .gitignore.

2️⃣ Run Development Server

pnpm run dev