Thank you for your interest in contributing to Seattle Source Ranker! This document provides guidelines for contributing to the project.
- Fork the repository on GitHub
- Clone your fork locally:
git clone https://github.com/YOUR_USERNAME/Seattle-Source-Ranker.git cd Seattle-Source-Ranker - Install dependencies:
pip install -e . - Set up your environment:
- Create
.env.tokenswith your GitHub tokens (see MULTI_TOKEN_GUIDE.md) - Start Redis:
redis-server --daemonize yes
- Create
-
Create a new branch for your feature or bugfix:
git checkout -b feature/your-feature-name
-
Make your changes:
- Write clean, readable code
- Follow existing code style and conventions
- Add tests for new functionality
-
Test your changes:
pytest tests/ -v
-
Commit your changes:
git add . git commit -m "Add: brief description of your changes"
-
Push to your fork:
git push origin feature/your-feature-name
-
Open a Pull Request on GitHub
- Python: Follow PEP 8 style guide
- JavaScript/React: Use consistent formatting (Prettier-compatible)
- Documentation: Update relevant docs when adding features
- Testing: Maintain or improve test coverage
Run the test suite before submitting PRs:
pytest tests/ -vAll tests should pass before your PR can be merged.
- Use GitHub Issues to report bugs or suggest features
- Include clear descriptions and steps to reproduce
- Provide system information (OS, Python version, etc.)
- Check TROUBLESHOOTING.md for common issues
- Review existing issues and discussions
- Open a new issue if you need help
By contributing, you agree that your contributions will be licensed under the MIT License.