Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
81 lines (52 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

81 lines (52 loc) · 2.24 KB
Raw

Contributing to Llama Metasearch

Thank you for your interest in contributing to Llama Metasearch! This document provides guidelines and instructions for contributing to this project.

Code of Conduct

Please read and follow our Code of Conduct.

How to Contribute

There are many ways to contribute to Llama Metasearch:

  1. Report bugs: Submit issues for any bugs you encounter.
  2. Suggest features: Submit issues with feature requests or enhancement ideas.
  3. Improve documentation: Help improve the documentation by fixing typos, clarifying explanations, or adding examples.
  4. Contribute code: Submit pull requests with bug fixes, features, or improvements.

Development Setup

Prerequisites

  • Python 3.8 or higher
  • Git

Setting Up the Development Environment

  1. Fork the repository by clicking the "Fork" button on the top-right of the repository page.

  2. Clone your fork:

    git clone https://github.com/YOUR_USERNAME/llama-metasearch.git
cd llama-metasearch

  3. Set up the upstream remote:

    git remote add upstream https://github.com/llamasearchai/llama-metasearch.git

  4. Create a virtual environment:

    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate

  5. Install development dependencies:

    pip install -e ".[dev]"

  6. Run tests:

    pytest

Pull Request Guidelines

  • Pull requests should focus on a single feature or fix.
  • Include tests for any new functionality or bug fixes.
  • Update documentation to reflect any changes in public API or behavior.
  • Follow the existing code style and conventions.
  • Keep your pull request up-to-date with the main branch.

Code Style Guidelines

We follow standard Python conventions:

License

By contributing to Llama Metasearch, you agree that your contributions will be licensed under the project's MIT License.