Skip to content

Commit

Permalink
Add minimal testing devdocs
Browse files Browse the repository at this point in the history
  • Loading branch information
LilithHafner authored Jan 22, 2024
1 parent aac2ea9 commit e0a3c15
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,3 +57,16 @@ Follow the style of the surrounding text when making changes. When adding new fe
* use emphasis (`*`) and bold (`**`) sparingly;
* always use fenced code blocks instead of indented blocks;
* follow the conventions outlined in the Julia documentation page on documentation.

## Tests

### Unit tests

As is conventional for Julia packages, unit tests are located at `test/*.jl` with the entrypoint
`test/runtests.jl`.

### End to end testing

Tests that building docs of example packages from source and inspect the results (end to end testing)
are located in `/test/examples`. The main entry points are `test/examples/make.jl` for building and
`test/examples/test.jl` for doing some basic checks on the generated outputs.

0 comments on commit e0a3c15

Please sign in to comment.