aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPaul Hawke <paul.hawke@gmail.com>2013-06-07 07:27:47 -0500
committerPaul Hawke <paul.hawke@gmail.com>2013-06-07 07:27:47 -0500
commitcad6aa43e51297bb188bee09432f63f6766970c4 (patch)
treee5f28a2632b48670921a82a5bdafe88455a39df7 /README.md
parent9d23138e24de6295dfcbc05665f3277857a5a9d8 (diff)
downloadnanohttpd-cad6aa43e51297bb188bee09432f63f6766970c4.tar.gz
Updated readme regarding testing
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 13 insertions, 1 deletions
diff --git a/README.md b/README.md
index 04a903a..90826e8 100644
--- a/README.md
+++ b/README.md
@@ -33,7 +33,19 @@
## How is the project managed?
-The project is managed with a "fork and pull-request" pattern. If you want to contribute, fork this repo and submit a pull-request of your changes when you're ready. Anyone can create Issues, and pull requests should be tied back to an issue describing the purpose of the submitted code.
+The project is managed with a "fork and pull-request" pattern.
+
+If you want to contribute, fork this repo and submit a pull-request of your changes when you're ready.
+
+Anyone can create Issues, and pull requests should be tied back to an issue describing the purpose of the submitted code.
+
+## The Tests
+
+In an ideal world for a bug fix: write a test of your own that fails as a result of the bug being present. Then fix the bug so that your unit-test passes. The test will now be a guard against the bug ever coming back.
+
+Similarly for enhancements, exercise your code with tests.
+
+Whatever else happens, if you make changes to the code, the unit & integration test suite (under ```core/src/main/test/```) should all continue to function. Pull requests with broken tests will be rejected.
## Where can I find the original (Java1.1) NanoHttpd?