From 4ce078b5c1133e26984b15080ebd125db6feb2b6 Mon Sep 17 00:00:00 2001 From: Joakim Loxdal Date: Fri, 20 Mar 2026 11:09:45 +0100 Subject: [PATCH] Add contributing guidelines and release instructions --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 5f9cb7f..7969c5a 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,16 @@ This will open up the graphical user interface. If you for any reason don't want to install the package, you can run it as a module directly with `python -m mal_gui.app` from this directory. +## Contributing + +- If you have contributions, please make a PR or an issue +- Write test if possible +- Make sure the pipeline passes in Github + +### Making a release +- Change the version number in pyproject.toml according to [semantic versioning](https://semver.org/) +- Make a commit +- Tag the latest commit with the new version number ## How to use the graphical interface