👍 First of all: Thank you for taking the time to contribute!
The following is a set of guidelines for contributing to
cdm-data-loaders. These guidelines are not strict rules.
Use your best judgment, and feel free to propose changes to this document
in a pull request.
The KBase CDM team strives to create a welcoming environment for editors, users and other contributors. Please carefully read our Code of Conduct.
This repository requires Python >= 3.13 and is managed with uv:
- Install dependencies (including development and documentation groups):
uv sync --all-groups
- Run lint and formatting checks with Ruff:
uv run ruff check
- Run the local unit test suite (skipping container Spark, Ceph, and docs drift tests):
uv run pytest -m "not requires_spark and not requires_ceph and not docs" - Verify committed PyArrow schemas and documentation if bundled XSDs, converter rules, CLI settings, specs, or docstrings change:
uv run xsd_to_pyarrow --bundled --check uv run pytest -m docs uv run python -m docs_macros uv run --group docs zensical build --clean --strict uv run python -m docs_macros --clean
Please use our Issue Tracker for any of the following:
- Reporting problems
- Requesting new data loaders
Please use the Issue Tracker to ask general questions or contribute to discussions.
Please submit a Pull Request to submit new code or to add a bug fix for an existing issue.
- Read ["About Issues"][about-issues]
- Issues should be focused and actionable
- Complex issues should be broken down into simpler issues where possible
- Read ["About Pull Requests"][about-pulls]
- Read ["About Branches"][about-branches]
- Read [GitHub Pull Requests: 10 Tips to Know](https://blog.mergify.com/github-pull-requests-10-tips-to-know/)
- Pull Requests (PRs) should be atomic and aim to close a single issue
- Long running PRs should be avoided where possible
- PRs should reference issues following standard conventions (e.g. “fixes #123”)
- Never work on the main branch, always work on an issue/feature branch
- Always create a PR on a branch to maximize transparency of what you are doing
- PRs should be reviewed and merged in a timely fashion by the CDM science technical leads
- PRs that do not pass GitHub actions should never be merged
- In the case of git conflicts, the contributor should try and resolve the conflict
- If a PR fails a GitHub action check, the contributor should try and resolve the issue in a timely fashion
We recommend also reading GitHub Pull Requests: 10 Tips to Know