From 55f72aac20f22b48e657c57ee9ae2bead8705f3e Mon Sep 17 00:00:00 2001 From: Daniel Siepmann Date: Fri, 1 Feb 2019 09:43:34 +0100 Subject: [PATCH] TASK: Add some info to readme * Remove results folder for cleanup. As it's created on demand. * Add missing information about structure of tests. --- readme.rst | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/readme.rst b/readme.rst index 5fec70d..d1cb087 100644 --- a/readme.rst +++ b/readme.rst @@ -34,7 +34,7 @@ Execute the following:: Clean everything:: - rm -rf composer.lock vendor web Tests phpunit.xml.dist infection.json.dist + rm -rf composer.lock vendor web Tests phpunit.xml.dist infection.json.dist Results Installation development dependencies using composer:: @@ -88,6 +88,8 @@ What's in the test? #. We have one PHP class `AddressTest`. +#. The class and file ends with `Test`. + #. Two public methods. #. The methods are annotated with `@test`. @@ -194,6 +196,8 @@ Benefits of tests #. Allow more secure refactoring. +#. Forces to write clean code. + Automate test execution -----------------------