]> git.ipfire.org Git - thirdparty/snapper.git/commitdiff
added a testsuite section 212/head
authorLadislav Slezák <lslezak@suse.cz>
Fri, 4 Dec 2015 09:49:20 +0000 (10:49 +0100)
committerLadislav Slezák <lslezak@suse.cz>
Fri, 4 Dec 2015 09:49:20 +0000 (10:49 +0100)
README.md

index 94b5e3c6e403154376de8e4cf64cc17e4a6585a3..bb60b223e8a802d50eb9e256db4f409327b6de14 100644 (file)
--- a/README.md
+++ b/README.md
@@ -55,11 +55,23 @@ sudo killall snapperd
 (sudo) snapper ...
 ```
 
+### Running Tests
+
+Snapper includes some internal unit tests to avoid some bugs and regressions.
+The tests are located in the `testsuite` subdirectory and you can start them
+using the `make check` command.
+
+There are also some additional tests in the `testsuite-real` subdirectory,
+but be careful. *These tests really execute snapper commands and they can
+destroy your data! Run these tests only in a testing environment!*
+
 ### Releasing
 
 - Before releasing the Snapper package ensure that the changes made to the package
 are mentioned in the `package/snapper.changes` file.
 
+- Make sure the units tests still passes ([see above](running-tests)).
+
 - When the version is increased then the Git repo has to be tagged, use the
 `vX.Y.Z` format for the tag. Also the
 [filesystems:snapper](https://build.opensuse.org/project/show/filesystems:snapper)