Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (44 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

67 lines (44 loc) · 1.94 KB
Raw

Contributing to inspect_evals_scoring

Thank you for your interest in contributing to inspect_evals_scoring!

How to Contribute

We welcome contributions of all kinds, including:

  • Bug fixes and issue reports
  • Feature enhancements
  • Documentation improvements
  • Infrastructure optimizations
  • New utility functions
  • Performance improvements

Getting Started

  1. Fork the repository and clone it locally

  2. Create a virtual environment:

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

  3. Install the package in development mode:

    pip install -e ".[dev]"

  4. Make your changes

  5. Run tests to ensure your changes don't break existing functionality:

    # Run tests using the interpreter in the virtual environment
.venv/bin/python -m pytest

  6. Submit a pull request with a clear description of the changes and their purpose

Development Guidelines

  • Write tests to confirm new functionality
  • Follow the existing code style (we use ruff for linting)
  • Add appropriate documentation for new features
  • Keep the codebase modular and maintainable
  • Ensure AWS resources are parameterized and configurable

Feature Requests

If you have ideas for new features, please open an issue describing:

  1. The problem you're trying to solve
  2. Your proposed solution

Project Scope

This project is intended to be a starting point for building scalable evaluation systems. While we aim to provide a solid foundation, we recognize that different users will have different needs. Contributions that make the system more flexible, configurable, and adaptable to various use cases are especially welcome.

Code of Conduct

Please be respectful and constructive in all interactions. We aim to foster an inclusive and welcoming community.

License

By contributing to this project, you agree that your contributions will be licensed under the project's MIT license.