]> rtime.felk.cvut.cz Git - hubacji1/coffee-getter.git/commitdiff
Update readme with TDD
authorJiri Vlasak <hubacji1@fel.cvut.cz>
Wed, 20 Mar 2019 09:27:15 +0000 (10:27 +0100)
committerJiri Vlasak <hubacji1@fel.cvut.cz>
Wed, 20 Mar 2019 09:27:15 +0000 (10:27 +0100)
README.md

index a6bf09d2cb8880ccdc09157587fa052824d0638b..ee901cc04a34fbbfa1169f2639c1ae124272eed7 100644 (file)
--- a/README.md
+++ b/README.md
@@ -9,6 +9,18 @@ Please, think about [The seven rules of a great Git commit message][2] when
 making commit. The project use [OneFlow][3] branching model with the `master`
 branch as the branch where the development happens.
 
+## TDD
+Test Driven Development (TDD) is used in this project. Each *feature* **must**
+start with adding test and all the tests **must** pass before merge to the
+*master*.
+
+Run the tests by:
+```
+python3 -m unittest discover ut/
+```
+
+See [unittest][5] for start.
+
 ## License
 This project is developed under [GNU GPLv3 license][4].
 
@@ -16,4 +28,4 @@ This project is developed under [GNU GPLv3 license][4].
 [2]: https://chris.beams.io/posts/git-commit/
 [3]: http://endoflineblog.com/oneflow-a-git-branching-model-and-workflow
 [4]: ./LICENSE
-
+[5]: https://docs.python.org/3.5/library/unittest.html