Contributing

Many hands make light work! Here are some ways you can contribute to this project:

Open an issue

• You can open an issue if you'd like to request a specific function or report a bug/error.

Fixing typos

• You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file.

Bigger changes

• If you want to make a bigger change, it's a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).

• You can also bring up changes in the nflverse discord and our team will be happy to discuss!

Tooling and Code Practices

This project uses the following tooling:

• uv for dependency management
• ruff for linting and formatting
• mypy for type checking
• pytest for testing
• mkdocs for documentation site

# Install development dependencies
uv sync --dev

# Run tests
uv run pytest

# Format code
uv run ruff format

# Type check
uv run mypy src

# Serve docs site locally
uv run mkdocs serve

# Build docs site
uv run mkdocs build

Code of Conduct

Please note that the nflverse project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.