Contributing to hubdata

Reporting bugs

If something isn’t working as described, or if you find a mistake in the documentation, please feel free to report a bug by opening an issue.

Contributing to the code base

Contributions to the code base are welcome. If you want to add a new feature, please open an issue before doing any work, to ensure that the suggestion aligns with the project’s goals and overall direction.

If you’d like to tackle an existing issue, please leave a comment on it.

Submitting code changes

After you’ve completed the changes described in the issue you’re working on, you can submit them by creating a pull request (PR) to this repository.

Please ensure the following are true before creating the PR:

• Your change is covered by tests, if applicable

• Project documentation is updated, if applicable

• The following local dev commands pass without warnings or errors (see docs/source/dev.md):

  • uv run pytest

  • uv run ruff check

  • uv tool run mypy . --ignore-missing-imports --disable-error-code=attr-defined

  • uv run --group docs sphinx-build docs/source docs/_build/html --fresh-env --fail-on-warning

• The ## unreleased section of CHANGELOG.md contains a description of your change

The PR itself should:

• Have a descriptive title

• Be linked to its corresponding issue in the description

• Have a description that includes any other information or context that will help a code reviewer understand your changes