Skip to content

Commit 992a8f0

Browse files
committed
Merge pull request apache#288 from tuncer/fix-176
Fix apache#176
2 parents fe16668 + cb52df9 commit 992a8f0

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,37 @@ Do not commit to master in your fork.
3636

3737
Provide a clean branch without merge commits.
3838

39+
Tests
40+
-----
41+
42+
As a general rule, any behavioral change to rebar requires a test to go with it. If there's
43+
already a test case, you may have to modify that one. If there isn't a test case or a test
44+
suite, add a new test case or suite in `inttest/`. [retest](https://github.com/dizzyd/retest) based tests are preferred, but
45+
we also have EUnit tests in `test/`.
46+
47+
Say you've added a new test case in `inttest/erlc`. To only execute the modified suite,
48+
you would do the following:
49+
```sh
50+
# First we build rebar and its deps to also get `deps/retest/retest`
51+
$ make debug deps
52+
# Now we can test the modified erlc suite
53+
$ deps/retest/retest -v inttest/erlc
54+
```
55+
56+
To test EUnit tests, you would do:
57+
```sh
58+
$ make debug
59+
$ ./rebar -v eunit
60+
```
61+
62+
You can also run `make test` to execute both EUnit and [retest](https://github.com/dizzyd/retest) tests as `make check` does.
63+
64+
Credit
65+
------
66+
67+
To give everyone proper credit in addition to the git history, please feel free to append
68+
your name to `THANKS` in your first contribution.
69+
3970
Committing your changes
4071
-----------------------
4172

0 commit comments

Comments
 (0)