From f595a6a427fedf50705c0fc6c7d625e336a94d7a Mon Sep 17 00:00:00 2001
From: Anna Lushnikova <anna.loosla@gmail.com>
Date: Fri, 13 Sep 2024 12:17:19 -0400
Subject: [PATCH] create snap readme; add go install
 github.com/digitalocean/github-changelog-generator@latest ==> list merged PRs
 since last release to review changes to release

---
 CONTRIBUTING.md | 10 +++++++---
 snap/README.md  | 20 ++++++++++++++++++++
 2 files changed, 27 insertions(+), 3 deletions(-)
 create mode 100644 snap/README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ab871d130..8c9563063 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -194,9 +194,13 @@ to do so. Travis also runs shellcheck.
 
 ## Releasing
 
-1. Use [github-changelog-generator](https://github.com/digitalocean/github-changelog-generator) 
-   to list the changes since the last release 
-   and decide what kind of release you are doing (bugfix, feature or breaking).
+To cut a release, push a new tag (versioning discussed below).
+
+### Tagging a release
+
+1. Run `make changes` to review the changes since the last
+   release. Based on the changes, decide what kind of release you are
+   doing (bugfix, feature or breaking).
    `doctl` follows [semantic versioning](https://semver.org), ask if you aren't sure.
 
 1. Synchronize your local repository with all the tags that have been created or updated on the remote main branch
diff --git a/snap/README.md b/snap/README.md
new file mode 100644
index 000000000..f1f2a645f
--- /dev/null
+++ b/snap/README.md
@@ -0,0 +1,20 @@
+# Snap
+
+Snap packages are automatically built and uploaded as part of the GitHub Actions
+release workflow.
+
+To build a snap package locally for testing, first install `snapcraft`.
+
+On Ubuntu, run:
+
+    sudo snap install snapcraft --classic
+
+Or on MacOS, run:
+
+    brew install snapcraft
+
+Finally, build the package by running:
+
+    make snap
+
+More details about the snap package can be found in the `snap/snapcraft.yaml` file.