A note about test failure artifacts and vcs

ashfurrow · Jun 1, 2017 · 3c1724e · 3c1724e
1 parent ace0c38
commit 3c1724e
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -178,3 +178,14 @@ implement the `ViewResizer` protocol and resize yourself.
 The custom behavior can be used to record the views too.
 
 For more info on usage, check the [dynamic sizes tests](Bootstrap/BootstrapTests/DynamicSizeTests.swift).
+
+## A note about test failures artifacts
+
+By default Nimble-Snapshot will place test failures image diffs in a folder right next to `ReferenceImages`. It is strongly recommended that you don't commit those files to your source repo.
+
+Add this to your `.gitignore`:
+
+```
+# Nimble-Snapshot
+FailureDiffs
+```