Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
add a note about make test/make xtest
  • Loading branch information
coke committed Oct 20, 2016
1 parent 4fd5eb7 commit 8899ab3
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -95,6 +95,17 @@ more lines with the signatures. Other allowed words instead of `method` are
`term`. If you wish to hide a heading from any index prefix it with the empty
comment `Z<>`.

## Running tests

Any contributions should pass the `make test` target. This insures basic
integrity of the documentation, and is run automatically by a corresponding
travis build. Even edits made via the github editor should pass this test.

The repo should also pass `make xtest` most of the time - this includes
tests about whitespace and spelling that might be difficult to get right
on an initial commit, and shouldn't be considered to break the build. If
you're contributing a patch or pull request, please make sure this passes.

## Testing examples

To export examples from all .pod6-files use `make extract-examples`. To run
Expand Down

0 comments on commit 8899ab3

Please sign in to comment.