aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/CONTRIBUTING
diff options
context:
space:
mode:
Diffstat (limited to 'docs/CONTRIBUTING')
-rw-r--r--docs/CONTRIBUTING5
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/CONTRIBUTING b/docs/CONTRIBUTING
index 5a88330..a45618a 100644
--- a/docs/CONTRIBUTING
+++ b/docs/CONTRIBUTING
@@ -66,6 +66,9 @@ This is a relatively easy, solid and transparent way to handle all requests in o
we know for bigger changes this is not always feasible. Just try to keep the merges about bigger "clean changesets".
* Your code should not introduce any compile warnings or errors. And also,
no regressions but that's harder to check.
+* Please try to keep the code clean - we don't like extraneous whitespace.
+ The sample pre-commit hook can check for this - so go ahead and
+ $ cp .git/hooks/pre-commit.sample .git/hooks/pre-commit
That said, you can always ask us to check on your stuff or ask for advice.
@@ -91,9 +94,11 @@ is, please supply:
valgrind --tool=memcheck --leak-check=full ./uzbl
### Writing unit tests
+
If you can, write a unit test for a bugfix or new functionality. Add relevant unit
tests to existing .c files in tests/. Others should be made in new source files with
corresponding changes to the tests/Makefile.
+Run all tests with `make tests`
### Debugging / backtraces