Welcome as a contributor to pygeojson
. Since the project is fairly new, and
we stricly don't know it will lift off, we will discuss contributions on a case
by case basis.
What's important to us, no matter what, is that we get feedback on how it works, and how it doesn't. We would love to hear from you no matter what experience you have with the library. Please open an issue in GitHub if you have any feedback.
Below you'll find instructions on how to get your hands dirty in case you want to start hacking on this library.
Set up the project with poetry
:
poetry install
Run the tests:
poetry run python -m pytest
Run type/lint check:
poetry run mypy pygeojson
Check formatting:
poetry run black
This project uses
conventional commits and
python-semantic-release
to generate version numbers and changelogs.
First, check out a new branch and create a new version:
poetry run semantic-release version
Then, create the changelog and update the CHANGELOG.md
manually:
poetry run semantic-release changelog
Also, update the version number in pyproject.toml
to the one
created by semantic-python
.
Amend the changelog changes and new version to the commit:
git add CHANGELOG.md pyproject.toml
git commit --amend
Publish to PyPi:
poetry build && poetry publish