From cba130bc01d7f6fea035ca0410feac02bb80ebd8 Mon Sep 17 00:00:00 2001 From: Kai Noda Date: Mon, 11 Apr 2016 10:47:43 +0800 Subject: 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 --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'README.md') 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: -- cgit v1.2.1