Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
175 lines (132 loc) · 4.53 KB

CONTRIBUTING.md

File metadata and controls

175 lines (132 loc) · 4.53 KB

Contributing to EggAI Multi-Agent Meta Framework

Thank you for considering contributing to EggAI Multi-Agent Meta Framework! 🎉 We value your contributions and want to make the process as smooth as possible. Please follow the guidelines below to get started.

Table of Contents

Code of Conduct

Please read our Code of Conduct to ensure that you understand our expectations when interacting with the community.

How Can I Contribute?

Bug Reports

  1. Check if the bug has already been reported in the Issues section.
  2. Create a new issue and include:
    • A clear and descriptive title.
    • Steps to reproduce the bug.
    • Expected and actual results.
    • Relevant logs, screenshots, or error messages.

Feature Requests

  1. Review the Issues section to see if your idea has already been proposed.
  2. Create a new issue and describe:
    • The problem your feature solves.
    • The proposed solution.
    • Alternatives you've considered.

Code Contributions

  1. Look for good first issue or help wanted tags in the Issues.
  2. Discuss your plans in the issue before starting work.
  3. Fork the repository and work on a feature branch.

Development Workflow

We have a Makefile at the root of the project that simplifies common development tasks. It's the recommended way to work with the project.

Option 1: Using the Makefile (Recommended)

  1. Clone the repository:

    git clone https://github.com/eggai-tech/eggai.git
cd eggai

  2. Install all dependencies (SDK, docs, examples):

    make install

    Or install specific components:

    # Install only SDK dependencies
make install-sdk

# Install only documentation dependencies
make install-docs

# Install dependencies for a specific example
make install-example EXAMPLE=multi_agent_conversation

  3. Run tests:

    # Run all tests with summary
make test-all

# Run SDK tests only
make test-sdk

# Run tests for a specific example
make test-example EXAMPLE=multi_agent_conversation

  4. Clean up:

    # Clean Python cache files
make clean

# Deep clean (removes virtual environments as well)
make deep-clean

Option 2: SDK Development (Alternative)

If you prefer to work directly in the SDK directory:

  1. Navigate to the SDK directory: 
    cd sdk
  2. Install dependencies: 
    poetry install
  3. Run SDK tests: 
    poetry run pytest

Option 3: Example Project Development

If you're working on a specific example:

  1. Navigate to the example directory: 
    cd examples/multi_agent_conversation
  2. Install dependencies: 
    pip install -r requirements.txt
  3. Run example-specific setup (if available): 
    make setup
  4. Run tests: 
    pytest

Commit Message Guidelines

We follow the Conventional Commits standard for commit messages:

  • feat: A new feature.
  • fix: A bug fix.
  • docs: Documentation changes.
  • style: Code style changes (formatting, missing semicolons, etc.).
  • refactor: Code restructuring without functionality changes.
  • test: Adding or fixing tests.
  • chore: Maintenance tasks like updating dependencies.

Example:

feat: add new API endpoint for user management
fix: resolve issue with login timeout

Pull Request Guidelines

  1. Ensure your code adheres to the project's coding standards and style.
  2. Ensure all tests pass locally before creating a pull request.
  3. Provide a detailed description of your changes in the pull request.
  4. Reference the issue you are addressing (if applicable).
  5. Be responsive to feedback and make changes as requested.

License

By contributing to EggAI Multi-Agent Meta Framework, you agree that your contributions will be licensed under the Project License.

Thank you for contributing to EggAI Multi-Agent Meta Framework! 💖