From 1563408eb9e542c42d3b128ef6d85cc3454f600e Mon Sep 17 00:00:00 2001 From: kshyatt Date: Wed, 1 Jul 2015 23:44:40 -0700 Subject: [PATCH] Added more info on testing [av skip] --- CONTRIBUTING.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b13f5e738148e..5db16de34817f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -52,11 +52,17 @@ There are never enough tests. Track [code coverage at Coveralls](https://coveral 2. Browse through the source files and find some untested functionality (highlighted in red) that you think you might be able to write a test for. -3. Write a test that exercises this functionality---you can add your test to one of the existing files, or start a new one, whichever seems most appropriate to you. If you're adding a new test file, make sure you include it in the list of tests in `test/choosetests.jl`. http://julia.readthedocs.org/en/latest/stdlib/test/ may be helpful in explaining how the testing infrastructure works. Submit the test as a pull request (see [CONTRIBUTING.md](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md)). +3. Write a test that exercises this functionality---you can add your test to one of the existing files, or start a new one, whichever seems most appropriate to you. If you're adding a new test file, make sure you include it in the list of tests in `test/choosetests.jl`. http://julia.readthedocs.org/en/latest/stdlib/test/ may be helpful in explaining how the testing infrastructure works. + +4. Run `make test-all` to rebuild Julia and run your new test(s). If you had to fix a bug or add functionality in `base`, this will ensure that your test passes and that you have not introduced extraneous whitespace. + +5. Submit the test as a pull request. * Code for the buildbot configuration is maintained at: https://github.com/staticfloat/julia-buildbot * You can see the current buildbot setup at: http://buildbot.e.ip.saba.us:8010/builders -* [Issue 9493](https://github.com/JuliaLang/julia/issues/9493) has a more detailed discussion on code coverage. +* [Issue 9493](https://github.com/JuliaLang/julia/issues/9493) and [issue 11885](https://github.com/JuliaLang/julia/issues/11885) have more detailed discussion on code coverage. + +Coveralls shows functionality that still needs "proof of concept" tests. These are important, as are tests for tricky edge cases, such as converting between integer types when the number to convert is near the maximum of the range of one of the integer types. Even if a function already has some coverage on Coveralls, it may still benefit from tests for edge cases. ### Improving documentation