From 27d0a9e158d7f0c0c8e9f23a0380a5077c8dbc1e Mon Sep 17 00:00:00 2001
From: Antoine Gersant <antoine.gersant@lesforges.org>
Date: Mon, 20 Jan 2020 18:30:54 -0800
Subject: [PATCH] Added maintenance guide

---
 MAINTENANCE.md | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
 create mode 100644 MAINTENANCE.md

diff --git a/MAINTENANCE.md b/MAINTENANCE.md
new file mode 100644
index 0000000..d712f9d
--- /dev/null
+++ b/MAINTENANCE.md
@@ -0,0 +1,17 @@
+# How to make a release
+
+- Update version number in Cargo.toml and commit the change (no need to push)
+- Run `make_release.ps1`
+- After CI completes, find the release on Github and write the changelog
+- Move the release from Draft to Published
+
+Note that the Github web UI will separate the release from the corresponding tag until published.
+
+# How to pull changes from polaris-web
+
+- Run `git submodule update --recursive --remote` or the `update_submodules.bat` script
+
+# How to change the database schema
+
+- Add a new folder under `migrations` following the existing pattern
+- Run `update_db_schema.bat` (all its should also work in bash if you're a Linux user)