From af346ad5245e7aa09fb2ce9fcbe0515d993b1966 Mon Sep 17 00:00:00 2001
From: Wen Kokke <wenkokke@users.noreply.github.com>
Date: Tue, 14 Jul 2020 20:13:26 +0100
Subject: [PATCH] Wrote TODO for new releases.

---
 RELEASES.md           | 24 ++++++++++++++++++++++++
 _includes/script.html |  2 +-
 2 files changed, 25 insertions(+), 1 deletion(-)
 create mode 100644 RELEASES.md

diff --git a/RELEASES.md b/RELEASES.md
new file mode 100644
index 00000000..b1b01155
--- /dev/null
+++ b/RELEASES.md
@@ -0,0 +1,24 @@
+# How to create a new release
+
+For a project such as PLFA, [Semantic Versioning][SemVer] doesn’t make a huge amount of sense. Instead, we’ve adopted [Calendar Versioning][CalVer], following, e.g., [Ubuntu][Ubuntu]. PLFA versions are of the form `YY.0M`, where `YY` is the short year, and `0M` is the zero-padded month. For each release, there are two tags in the repository:
+
+- `dev-YY0M`: a copy of the contents of the `dev` branch at the time of release; and
+- `web-YY0M`: a copy of the web version of PLFA only.
+
+The former contains everything you’d need to work with that version of PLFA, whereas the latter consists only of the relevant files to deploy a web version of PLFA.
+
+There are several steps to creating a new release for PLFA:
+
+- [ ] Create a new tag `dev-YY0M` of the `dev` branch.
+- [ ] Create a new tag `web-YY0M` of the `master` branch.
+- [ ] Push the new tags.
+- [ ] Draft a new release [on GitHub][releases] linked to the `dev-YY0M` tag.
+- [ ] Add the release version `YY0M` to the end of the `RELEASE_VERSIONS` variable in the Makefile.
+- [ ] Write an announcement for the release in the `_posts` folder, describing any major changes.
+- [ ] Run `make build build-history test` and deal with any problems.
+- [ ] Commit and push.
+
+[releases]: https://github.com/plfa/plfa.github.io/releases
+[SemVer]: https://semver.org/
+[CalVer]: https://calver.org
+[Ubuntu]: https://www.ubuntu.com
diff --git a/_includes/script.html b/_includes/script.html
index f9fa4b12..e927c906 100644
--- a/_includes/script.html
+++ b/_includes/script.html
@@ -8,7 +8,7 @@
 
 <script type="text/javascript">
 
- // Makes sandwhich menu works
+ // Makes sandwich menu work
  $('.menu-icon').click(function(){
    $('.trigger').toggle();
  });