Contributing¶
Structure¶
Basic project layout:
vhrharmonize/cli: packaged command-line entry pointsvhrharmonize/preprocess: reusable processing stepsvhrharmonize/providers: provider discovery and metadata parsingvhrharmonize/io: shared raster and workflow IO helpersconfigs: example configuration filesdocs: MkDocs sourcetests: tests
Build Docs Locally¶
pip install -e ".[docs]"
mkdocs serve -f docs/mkdocs.yml
mkdocs build -f docs/mkdocs.yml
Releases¶
make release version=0.0.2
This updates pyproject.toml, commits the version bump, creates the v0.0.2 tag, and pushes it. GitHub Actions then creates the GitHub release and publishes to PyPI.
How to Contribute¶
- Open an issue first if the change affects behavior, API, or workflow design.
- Fork the repository.
- Create a branch in your fork.
- Make the change.
- Open a pull request from your fork to the main repository.