ID

29f1a54

date

2024-05-12 09:57:32+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

b86f016

message

Add some instructions for contributing

changed files

1 file, 10 additions

• CONTRIBUTING.md

Changed files

CONTRIBUTING.md (0) → CONTRIBUTING.md (311)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..23616bc
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,10 @@
+# CONTRIBUTING
+
+## Releasing a new version
+
+1.  Create a new changelog entry for your version in `CHANGELOG.md`
+2.  Commit your change
+3.  Create a Git tag with your version number
+4.  Push your new commit and Git tag to GitHub
+
+GitHub Actions will then build and release a new version of the CLI tool for you.