Add a brief CONTRIBUTING note

ID

66fd32d

date

2024-05-17 07:24:31+00:00

author

Alex Chan <alex@alexwlchan.net>

parent

a95a166

message

Add a brief CONTRIBUTING note

changed files

1 file, 12 additions

CONTRIBUTING.md

Changed files

CONTRIBUTING.md (0) → CONTRIBUTING.md (413)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c23bf95
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,12 @@
+# CONTRIBUTING
+
+## Creating a new release
+
+1.  Bump the version number in `save_safari_webarchive.swift`
+2.  Add a changelog entry in `CHANGELOG.md`
+3.  Create a Git tag with your new version number
+4.  Push your changes and Git tag to GitHub
+
+GitHub Actions will create a new release, including compiled binaries.
+
+These binaries aren't notarised -- see https://github.com/alexwlchan/safari-webarchiver/issues/6