Thank you for your interest in contributing to ReversibleAI!
- Fork the repository
- Clone your fork:
git clone https://github.com/yourusername/reversibleai.git - Create a branch:
git checkout -b feature/your-feature-name - Install in development mode:
pip install -e .[dev] - Install pre-commit hooks:
pre-commit install
We use:
- Black for code formatting (line length: 88)
- isort for import sorting
- flake8 for linting
- mypy for type checking
Run before committing:
black reversibleai tests
isort reversibleai tests
flake8 reversibleai tests
mypy reversibleai- Write tests for new features
- Ensure all tests pass:
pytest - Maintain test coverage above 80%
- Ensure all tests pass
- Update documentation if needed
- Commit:
git commit -m 'Add feature: description' - Push:
git push origin feature/your-feature-name - Open a Pull Request
All contributions require code review. Please be patient and responsive to feedback.