mirror of
https://github.com/uber/h3-py.git
synced 2026-11-16 07:44:46 +00:00
1.5 KiB
1.5 KiB
Development notes for h3-py
Install for development
git clone git@github.com:uber/h3-py.gitcd h3-pymake initmake testmake lint
Docstrings
- Follow something like the
numpydocdocstring guide or thepandasdocstring guide
Updating the H3 submodule
cd src/h3lib
git checkout master
git pull
cd ..
git add h3lib
git commit ...
for a specific version tag:
cd src/h3lib
git checkout v3.7.1 # or whatever version tag you'd like
cd ..
git add h3lib
git commit ...
Resetting the submodule
For when moving between h3-py branches using different versions of the
h3lib submodule.
git submodule deinit -f .
git submodule update --init
Releasing a new version
- update
CHANGELOG.mdto reflect any changes since the last release - update the
h3-pyversion inpyproject.toml - if updating the C
h3libversion, update the version badge on the readme - create PR, get reviews, and merge with these changes
- go to https://github.com/uber/h3-py/releases and "Draft a new release"
- set the tag version and the release to the version. e.g.,
v3.7.2(alternatively:git tag v3.7.2&&git push origin --tags) - add the updated
CHANGELOG.mdtext to the release notes - publish release
- set the tag version and the release to the version. e.g.,
- GitHub actions should trigger on the release event and then go on to build and upload the wheels to PyPI