From 1854f7e14836385ac3d6a5cbcbe7d5ea4a9168ca Mon Sep 17 00:00:00 2001
From: Ed Campbell <ed.campbell@cityscience.com>
Date: Tue, 7 Jan 2020 16:11:47 +0000
Subject: [PATCH] Add patching instructions

---
 PATCHING.md | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
 create mode 100644 PATCHING.md

diff --git a/PATCHING.md b/PATCHING.md
new file mode 100644
index 00000000..90ef6ba0
--- /dev/null
+++ b/PATCHING.md
@@ -0,0 +1,31 @@
+# Patching the plugin
+
+## Git workflow
+
+To patch an upstream release create a corresponding `releases/vX.Y.Z` branch in the CityScience
+fork, apply any changes e.g. cherry-pick commits from earlier release branches and then tag this
+branch. For example:
+
+```bash
+git clone git@github.com:CityScience/cypress-plugin-snapshots.git
+cd cypress-plugin-snapshots
+git remote add upstream git@github.com:meinaart/cypress-plugin-snapshots.git
+git fetch --all --tags
+git checkout -b releases/v1.2.9 v1.2.9
+# Apply fixes/patches and commit to release branch, get it reviewed etc.
+git tag v1.2.9-csc
+git push origin --tags
+```
+
+The tag name should match the corresponding tag from upstream, with `-csc` appended to it.
+
+## Testing
+
+To test a modified release:
+
+```bash
+npm install
+npm install --prefix cypress
+npm run ci:test
+```
+