CONTRIBUTING.md

Contributing

Local Development

# get the code
git clone [email protected]:metaist/pdfmerge.git
cd pdfmerge

# create a virtual environment
python -m venv .venv --prompt pdfmerge
. .venv/bin/activate
pip install --upgrade pip

# install dependencies and dev tools
pip install -e ".[dev]"
pnpm install -g cspell

As you work on the code, you should periodically run:

pdm lint  # for type checks
pdm test  # for unit tests

This repo generally tries to maintain type-correctness (via mypy and pyright) and complete unit test coverage.

Making a Release

Checkout prod:

git checkout prod
git merge --no-ff --no-edit main

Update top-most __init__.py:

__version__ = "X.0.1"

Update CHANGELOG.md:

Sections order is: Fixed, Changed, Added, Deprecated, Removed, Security.

---

[X.0.1]: https://github.com/metaist/pdfmerge/compare/X.0.0...X.0.1

## [X.0.1] - XXXX-XX-XXT00:00:00Z

**Fixed**

**Changed**

**Added**

**Deprecated**

**Removed**

**Security**

export VER="X.0.1"

# update docs
pdm docs

# check build
pip install -e .

# commit and push tags
git commit -am "release: $VER"
git tag $VER
git push
git push --tags
git checkout main
git merge --no-ff --no-edit prod
git push

Create the release on GitHub. The pypi.yaml workflow will attempt to publish it to PyPI.