44 lines (31 loc) · 985 Bytes

Contributing

We welcome contributions! Here's how to get started.

Development Setup

git clone https://github.com/CSOAI-ORG/<repo-name>.git
cd <repo-name>
pip install -e ".[dev]"

Making Changes

Fork the repository
Create a feature branch (git checkout -b feature/your-feature)
Make your changes
Run tests (pytest)
Commit with a descriptive message
Push to your fork and open a Pull Request

Code Style

Python: Follow PEP 8, use type hints
Use descriptive variable and function names
Add docstrings to all public functions

Pull Request Guidelines

Keep PRs focused on a single change
Include tests for new functionality
Update documentation as needed
Reference any related issues

Reporting Bugs

Use the GitHub issue tracker. Include:

Steps to reproduce
Expected vs actual behavior
Python version and OS

License

By contributing, you agree that your contributions will be licensed under the MIT License.