Contributing¶
Thank you for your interest in contributing to ReAct Agent Framework!
How to Contribute¶
Report Bugs¶
Found a bug? Open an issue with:
- Clear description
- Steps to reproduce
- Expected vs actual behavior
- Python version and environment
Suggest Features¶
Have an idea? Open an issue with:
- Feature description
- Use case
- Proposed implementation (optional)
Submit Code¶
- Fork the repository
- Create a branch (
git checkout -b feature/MyFeature
) - Make your changes
- Run tests and linting
- Commit (
git commit -m 'Add MyFeature'
) - Push (
git push origin feature/MyFeature
) - Open a Pull Request
Development Setup¶
# Clone your fork
git clone https://github.com/YOUR_USERNAME/react-agent-framework.git
cd react-agent-framework
# Create virtual environment
python -m venv .venv
source .venv/bin/activate
# Install in editable mode with dev dependencies
pip install -e ".[dev]"
Code Quality¶
Format Code¶
Lint Code¶
Type Check¶
Commit Messages¶
Follow Conventional Commits:
feat:
New featurefix:
Bug fixdocs:
Documentationrefactor:
Code refactoringtest:
Testschore:
Maintenance
Example:
Pull Request Guidelines¶
- Keep PRs focused on a single feature/fix
- Add tests for new features
- Update documentation
- Ensure CI passes
- Link related issues
License¶
By contributing, you agree that your contributions will be licensed under the MIT License.