CONTRIBUTING.md

Contributing to CodeBeaver

Thank you for your interest in contributing to CodeBeaver! This document provides guidelines and instructions for contributing to the project.

Development Setup

1. Clone the repository:

2. Create a virtual environment and activate it:

   python -m venv .venv
   source .venv/bin/activate  # On Unix/macOS
   # or
   .venv\Scripts\activate  # On Windows

3. Install the package in development mode with test dependencies:

   pip install -e ".[test]"

Running Tests

We use pytest for our test suite. To run the tests:

pytest

To run tests with coverage report:

pytest --cov=codebeaver --cov-report=term-missing

Code Style

We follow PEP 8 style guidelines. Before submitting a pull request, please ensure your code follows these standards.

You can check code style using:

# Install development dependencies
pip install black flake8

# Run black for code formatting
black .

# Run flake8 for style checking
flake8 .

Pull Request Process

1. Fork the repository and create your branch from main.
2. If you've added code that should be tested, add tests.
3. Ensure the test suite passes.
4. Update the documentation if needed.
5. Issue the pull request!

License

By contributing to CodeBeaver, you agree that your contributions will be licensed under its MIT license.