Add documentation on running the tests #43
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
matthewturk
approved these changes
Jul 30, 2018
54 tasks
jzuhone
requested changes
Aug 1, 2018
CONTRIBUTING.rst
Outdated
| 3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6. Check | ||
| 1. The pull request should include tests for functionality that is not already | ||
| tested. We strive for 100% test coverage and pull requests should not add any | ||
| new untested code. Use the codecov.io reports on the pull request to gaugue |
There was a problem hiding this comment.
I suspect that we should make the codecov.io reference here a link.
jzuhone
approved these changes
Aug 1, 2018
ygrange
approved these changes
Aug 1, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This responds to @ygrange's comment here: openjournals/joss-reviews#809 (comment)
I've added a section to the developer docs on running the tests locally using either
py.testortox. I've also mentioned the extra test dependencies. I also expanded a little bit on the pull request guidelines to reflect what I actually think about merging PRs to this repo. @jzuhone might want to give this a quick lookover.