Contributing

For detailed contribution guidelines, please see the Contributing Guide in the repository.

Quick Links

• Full Contributing Guide - Complete guidelines for contributors
• Code License (MIT) - License for code
• Data License (CC BY 4.0) - License for data
• Citation Guide (CITATION.cff) - How to cite this work
• Security Policy - Reporting security issues

Ways to Contribute

1. Report Issues - Found a bug? Open an issue
2. Improve Documentation - Help make these docs better
3. Fix Bugs - Submit pull requests for bug fixes
4. Add Features - Propose and implement new features
5. Update Data - Report outdated scorecard information

Getting Started

1. Fork the repository
2. Clone your fork locally
3. Run python init_project.py to set up the project structure
4. Install dependencies: pip install -r requirements.txt
5. Make your changes
6. Run tests: pytest tests/
7. Run pre-commit: pre-commit run --all-files
8. Submit a pull request

For detailed instructions, see the full Contributing Guide.