Skip to content

Commit 4cf6571

Browse files
committed
README: update to explain how to run quickcheck-style tests.
1 parent 3d1600b commit 4cf6571

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,16 +52,20 @@ features = ["c"]
5252
## Contributing
5353

5454
1. Pick one or more intrinsics from the [pending list](#progress).
55-
2. Fork this repository
56-
3. Port the intrinsic(s) and their corresponding [unit tests][1] from their [C implementation][2] to
57-
Rust.
58-
4. Send a Pull Request (PR)
59-
5. Once the PR passes our extensive [testing infrastructure][3], we'll merge it!
55+
2. Fork this repository.
56+
3. Port the intrinsic(s) and their corresponding [unit tests][1] from their
57+
[C implementation][2] to Rust.
58+
4. Implement a [test generator][3] to compare the behavior of the ported intrinsic(s)
59+
with their implementation on the testing host. Note that randomized compiler-builtin tests
60+
should be run using `cargo test --features gen-tests`.
61+
4. Send a Pull Request (PR).
62+
5. Once the PR passes our extensive [testing infrastructure][4], we'll merge it!
6063
6. Celebrate :tada:
6164

6265
[1]: https://github.com/rust-lang/compiler-rt/tree/8598065bd965d9713bfafb6c1e766d63a7b17b89/test/builtins/Unit
6366
[2]: https://github.com/rust-lang/compiler-rt/tree/8598065bd965d9713bfafb6c1e766d63a7b17b89/lib/builtins
64-
[3]: https://travis-ci.org/rust-lang-nursery/compiler-builtins
67+
[3]: https://github.com/rust-lang-nursery/compiler-builtins/blob/0ba07e49264a54cb5bbd4856fcea083bb3fbec15/build.rs#L180-L265
68+
[4]: https://travis-ci.org/rust-lang-nursery/compiler-builtins
6569

6670
### Porting Reminders
6771

0 commit comments

Comments
 (0)