CONTRIBUTING.md

Contributing to edn_format

Setup

If you have Docker installed:

docker build -t swaroopch/edn_format .
docker run --rm -v $PWD:/app swaroopch/edn_format python tests.py

Tests

Run unit tests with:

python tests.py

Check Python warnings with:

python -Wall -c 'import edn_format'

Run a linter over the code with:

flake8 --max-line-length=100 --exclude=parsetab.py .

Release a new version with GitHub

1. Bump up the version number in setup.py, e.g. 0.7.0
2. Fill the CHANGELOG.md
3. Create a new tag starting with v, e.g. v0.7.5 (see .github/workflows/publish-pypi.yml)

Release a new version without GitHub

1. Ensure you have setup GPG and twine
2. Bump up the version number in setup.py, e.g. 0.7.0
3. Fill the CHANGELOG.md
4. Create a git tag: git tag -s v0.7.0 -m 'Version 0.7.0' (use signed tags)
5. Verify git tag: git tag -v v0.7.0
6. Push git tag: git push origin master --tags
7. Clean your dist/ directory if it already exists
8. Package the release: python setup.py sdist bdist_wheel
9. Check the package: twine check dist/*
10. Upload the package: twine upload dist/*