From 33c28bbf70fd69bd43f8de05b4ab1a95371d5ef4 Mon Sep 17 00:00:00 2001
From: Michael Boniface <m.j.boniface@soton.ac.uk>
Date: Tue, 25 Feb 2025 09:31:20 +0000
Subject: [PATCH] docs: added release commands to contributing.md

---
 docs/contributing.md | 30 +++++++++++++++++++++++++++---
 1 file changed, 27 insertions(+), 3 deletions(-)

diff --git a/docs/contributing.md b/docs/contributing.md
index 1c6ba5e..708f4ad 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -67,6 +67,13 @@ To run tests using `pytest`, use:
 hatch run pytest
 ```
 
+## Running the CLI
+The package provides a command-line interface (CLI) entry point. 
+
+```sh
+acmc --help
+```
+
 ### All code checks
 The project run all type and formatting checking
 
@@ -103,13 +110,30 @@ To build the package, use:
 hatch build
 ```
 
-## Running the CLI
-The package provides a command-line interface (CLI) entry point. 
+## Releasing the Package
+
+Update the version number in pyproject.toml
+
+Build the package using:
 
 ```sh
-acmc --help
+hatch build
 ```
 
+Creates file `acmc-<version>-py3-none-any.whl` in the `./dist` directory
+
+Check package using:
+
+```sh
+twine check dist/acmc-<version>-py3-none-any.whl
+```
+Upload to pypi using:
+
+```sh
+twine upload dist/acmc-<version>-py3-none-any.whl --username __token__ --password <your pypi token>
+```
+
+
 ## Contributing
 
 ### GitLab Basic Workflow Overview 
-- 
GitLab