summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKai Noda <nodakai@gmail.com>2016-04-11 10:47:43 +0800
committerNODA, Kai <nodakai@gmail.com>2016-04-27 08:35:18 +0800
commitcba130bc01d7f6fea035ca0410feac02bb80ebd8 (patch)
tree7d4f08af877ff6ea76ee5375a4ab9807b4e574b5 /README.md
parent22bb4e4c6f2705aa86cac6c54ed735b315154f72 (diff)
downloadrust-libc-cba130bc01d7f6fea035ca0410feac02bb80ebd8.tar.gz
Explain about the automated tests on Travis
in order to advise contributors to locally test their patches. Also update ctest to include a fix on rerun-if-changed so that human developers doing trial & error can properly test their latest code. Signed-off-by: NODA, Kai <nodakai@gmail.com>
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index 920d705ee8..09b9a567b4 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,16 @@ With that in mind, the steps for adding a new API are:
4. Wait for CI to pass, fixing errors.
5. Wait for a merge!
+### Test before you commit
+
+We have two automated tests running on [Travis](https://travis-ci.org/rust-lang/libc):
+
+1. [`libc-test`](https://github.com/alexcrichton/ctest)
+ - `cd libc-test && cargo run`
+ - Use the `skip_*()` functions in `build.rs` if you really need a workaround.
+2. Style checker
+ - `rustc ci/style.rs && ./style src`
+
## Platforms and Documentation
The following platforms are currently tested and have documentation available: