Contributing to Sufast

Help us make Sufast better! Learn how to contribute code, documentation, and ideas to the project.

Welcome! We're excited that you want to contribute to Sufast. Every contribution, no matter how small, helps make the framework better for everyone.

Code Contributions

Fix bugs, add features, and improve performance

Documentation

Improve docs, write tutorials, and fix typos

Community

Help others, report bugs, and share ideas

Getting Started

Set up your development environment and make your first contribution

1. Fork and Clone the Repository

Repository Setupbash

# 1. Fork the repository on GitHub
# Click the "Fork" button at https://github.com/shohan-dev/sufast

# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/sufast.git
cd sufast

# 3. Add upstream remote
git remote add upstream https://github.com/shohan-dev/sufast.git

# 4. Verify remotes
git remote -v

2. Set Up Development Environment

Environment Setupbash

# 1. Create virtual environment
python -m venv venv
source venv/bin/activate  # Linux/Mac
# or
venv\Scripts\activate  # Windows

# 2. Install development dependencies
pip install -e ".[dev]"

# 3. Install pre-commit hooks
pre-commit install

# 4. Run tests to verify setup
pytest

# 5. Check code formatting
black --check .
isort --check-only .
flake8 .

3. Create a Feature Branch

Branch Workflowbash

# 1. Update your main branch
git checkout main
git pull upstream main

# 2. Create a new branch for your feature
git checkout -b feature/your-feature-name

# 3. Make your changes
# ... edit files ...

# 4. Commit your changes
git add .
git commit -m "Add: your feature description"

# 5. Push to your fork
git push origin feature/your-feature-name

4. Submit a Pull Request

Pull Request Checklist

• ✅ Tests pass locally
• ✅ Code follows style guidelines
• ✅ Documentation updated if needed
• ✅ Commit messages are clear
• ✅ PR description explains the changes

PR Templatemarkdown

## Description
Brief description of what this PR does.

## Type of Change
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update

## Testing
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes

## Checklist
- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation

🚀 Ready to Contribute?

Join our community and help make Sufast even better!