mirror of
https://github.com/allaunthefox/Research-Stack.git
synced 2026-07-31 03:05:21 +00:00
1,006 B
1,006 B
Contributing
Getting Started
- Fork the repository
- Clone your fork
- Create a feature branch
Development Workflow
# Create branch
git checkout -b feature/my-feature
# Make changes
# ... edit code ...
# Run tests
pytest tests/ -v
# Commit
git add .
git commit -m "feat: add feature"
# Push
git push origin feature/my-feature
Code Standards
- Follow PEP 8
- Add docstrings to all functions
- Use type annotations
- Run pylint before committing
Testing
- All new code requires tests
- Run
pytest tests/before submitting - Aim for 60%+ coverage
Pull Requests
- Keep PRs small (<500 lines)
- Update documentation if needed
- Reference related issues
- Wait for CI to pass
Commit Messages
Use Conventional Commits:
feat: add new feature
fix: resolve bug
docs: update documentation
test: add tests
refactor: restructure code
Review Process
- Automated checks run (CI)
- Maintainer reviews code
- Address feedback
- Merge when approved