📖 Update docs with new visual regression (#288)

* 🚜 Move license file * 📖 Update contribution guide for visual regression
bbody · Dec 31, 2018 · 2362881 · 2362881
1 parent 14671c9
commit 2362881
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -30,6 +30,15 @@ This guide assumes you are using a command line, if you want to use other tools
 9. Once tests pass, I will merge into `development`
 10. Then I will merge into `master` with other changes
 
+## Changes to the UI
+Visual regression is tested on on Pull Requests, so if any changes are made to 
+the way the page will look you will need to reset the reference images.
+
+1. Delete the reference images `rm spec-e2e/visual-diffs/reference`
+2. Regenerate the reference images `test:e2e:visual_reference`
+3. Stage the latest reference images `git add spec-e2e/visual-diffs/reference/*`
+4. Commit the latest reference images `git commit -m ":ambulance: Update visual regression reference images"`
+
 ## Technologies
 Despite CMD-Resume being quite simple there are quite a few packages and tools
 which are used to develop, test, build and deploy.

diff --git a/LICENSE/LICENSE → LICENSE b/LICENSE/LICENSE → LICENSE
diff --git a/docs/CONTRIBUTING.mdpp b/docs/CONTRIBUTING.mdpp
@@ -30,6 +30,15 @@ This guide assumes you are using a command line, if you want to use other tools
 9. Once tests pass, I will merge into `development`
 10. Then I will merge into `master` with other changes
 
+## Changes to the UI
+Visual regression is tested on on Pull Requests, so if any changes are made to 
+the way the page will look you will need to reset the reference images.
+
+1. Delete the reference images `rm spec-e2e/visual-diffs/reference`
+2. Regenerate the reference images `test:e2e:visual_reference`
+3. Stage the latest reference images `git add spec-e2e/visual-diffs/reference/*`
+4. Commit the latest reference images `git commit -m ":ambulance: Update visual regression reference images"`
+
 ## Technologies
 !INCLUDE "docs/partials/TECHNOLOGIES.md"