From 08f1c62924bbe7fe2330de582f5217ecca828a9d Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Oskar=20Thor=C3=A9n?= <ot@oskarthoren.com>
Date: Mon, 30 Nov 2020 11:38:51 +0800
Subject: [PATCH] Initial release v0.1 (#308)

- Add CHANGELOG and update with initial version
- Add contributors README
- Add release doc
---
 CHANGELOG.md                         | 18 ++++++++++++
 docs/contributors/README.md          |  9 ++++++
 docs/contributors/release-process.md | 41 ++++++++++++++++++++++++++++
 3 files changed, 68 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 docs/contributors/README.md
 create mode 100644 docs/contributors/release-process.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 000000000..44fef462c
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,18 @@
+# Changelog
+
+## 2020-11-30 v0.1
+
+Initial beta release.
+
+This release contains:
+
+- A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html).
+- A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html).
+- CLI applications `wakunode` and `wakunode2` that allows you to run a Waku v1 or v2 node.
+- Examples of Waku v1 and v2 usage.
+- Various tests of above.
+
+Currenty the Waku v2 implementation, and [most protocols it consist of](https://specs.vac.dev/specs/waku/),
+are in a draft/beta state. The Waku v1 implementation is stable but not under active development.
+
+Feedback welcome!
diff --git a/docs/contributors/README.md b/docs/contributors/README.md
new file mode 100644
index 000000000..71aaf6e64
--- /dev/null
+++ b/docs/contributors/README.md
@@ -0,0 +1,9 @@
+# Contributors
+
+This folder contains documentation that is primarily useful for contributors. Some links and
+resources here might require privileged access.
+
+Example resources:
+
+- How to do releases
+- Viewing and modifying metrics dashboard
diff --git a/docs/contributors/release-process.md b/docs/contributors/release-process.md
new file mode 100644
index 000000000..929dc285f
--- /dev/null
+++ b/docs/contributors/release-process.md
@@ -0,0 +1,41 @@
+# Release Process
+
+How to do releases.
+
+For more context, see https://trunkbaseddevelopment.com/branch-for-release/
+
+## How to to do releases
+
+1. Checkout a release branch from master
+
+`git checkout -b release/v0.1`
+
+2. Update `CHANGELOG.md` and ensure it is up to date
+
+3. Create a tag with the same name as release and push it
+
+```
+git tag -as v0.1 -m "Initial release."
+git push origin v0.1
+```
+
+4. Open a PR
+
+5. Harden release in release branch
+
+6. Modify tag
+
+If you need to update stuff, remove tag and make sure the new tag is associated
+with CHANGELOG update.
+
+```
+# Delete tag
+git tag -d v0.1
+git push --delete origin v0.1
+
+# Make changes, rebase and tag again
+# Squash to one commit and make a nice commit message
+git rebase -i origin/master
+git tag -as v0.1 -m "Initial release."
+git push origin v0.1
+```