dev_notes.md

Development notes for h3-py

Install for development

• git clone git@github.com:uber/h3-py.git
• cd h3-py
• make init
• make test
• make lint

Docstrings

• Follow something like the numpydoc docstring guide or the pandas docstring guide

Workflow

• GitHub Standard Fork & Pull Request Workflow
• pyenv for multiple versions (to help with tox)
• tox stuff
• more tox stuff

Updating the H3 submodule

cd src/h3lib
git checkout master
git pull
cd ..
git add h3lib
git commit ...