update contributing

Author: bckohan

CONTRIBUTING.md

@@ -83,16 +83,21 @@ just test tests/test_basics.py::BasicTests::test_call_command
 
 django-typer strictly adheres to [semantic versioning](https://semver.org).
 
+## Issuing Releases
+
+The release workflow is triggered by tag creation. You must have [git tag signing enabled](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits). Our justfile has a release shortcut:
+
+```bash
+    just release x.x.x
+```
 
 ## Just Recipes
 
 ```
-build                    # build docs and package
+build                    # build src package and wheel
 build-docs               # build the docs
 build-docs-html          # build html documentation
 build-docs-pdf           # build pdf documentation
-build-sdist              # build the source distribution
-build-wheel              # build the wheel distribution
 check                    # run all static checks
 check-docs               # lint the documentation
 check-docs-links         # check the documentation links for broken links
@@ -106,32 +111,36 @@ clean-docs               # remove doc build artifacts
 clean-env                # remove the virtual environment
 clean-git-ignored        # remove all git ignored files
 coverage                 # generate the test coverage report
-default                  # list all available commands
 docs                     # build and open the documentation
 docs-live                # serve the documentation, with auto-reload
 fix                      # fix formatting, linting issues and import sorting
 format                   # format the code and sort imports
-init python="python"     # install build tooling
 install *OPTS            # update and install development dependencies
 install-docs             # install documentation dependencies
 install-precommit        # install git pre-commit hooks
+install-psycopg3         # install with postgresql dependencies
 install-translate        # install translation dependencies
+install-uv               # install the uv package manager
 lint                     # sort the imports and fix linting issues
 list-missed-tests        # run the tests and report if any were not run - sanity check
 log-tests                # run all tests and log them
+manage *COMMAND          # run the django admin
 open-docs                # open the html documentation
-pin-dependency +PACKAGES # install a dependency to a specific version e.g. just pin-dependency Django~=5.1.0
 precommit                # run the pre-commit checks
+release VERSION          # issue a relase for the given semver string (e.g. 2.1.0)
 run +ARGS                # run the command in the virtual environment
+setup python="python"    # setup the venv and pre-commit hooks
 sort-imports             # sort the python imports
 test *TESTS              # run tests
 test-all                 # run all tests
 test-bash                # test bash shell completions
 test-fish                # test fish shell completions
+test-lock +PACKAGES      # lock to specific python and versions of given dependencies
 test-no-rich             # run the tests that require rich not to be installed
 test-powershell          # test powershell shell completions
 test-pwsh                # test pwsh shell completions
 test-rich                # run the tests that require rich to be installed
 test-zsh                 # test zsh shell completions
 translate                # generate translations using google translate
+validate_version VERSION # validate the given version string against the lib version
 ```

justfile

@@ -48,6 +48,7 @@ install *OPTS:
 install-docs:
     uv sync --group docs --all-extras
 
+# install with postgresql dependencies
 install-psycopg3:
     uv sync --group psycopg3
 
@@ -108,6 +109,7 @@ build-docs-pdf: install-docs
 # build the docs
 build-docs: build-docs-html
 
+# build src package and wheel
 build:
     uv build