Skip to content

Commit

Permalink
Merge pull request #315 from NLeSC/remove-testing-chapter
Browse files Browse the repository at this point in the history
Remove testing chapter
  • Loading branch information
egpbos authored Nov 15, 2023
2 parents e8bd065 + 744abce commit 2b9ba80
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 98 deletions.
1 change: 0 additions & 1 deletion _sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
* [Best practices](/best_practices/overview.md)
* [Code Quality](/best_practices/code_quality.md)
* [Code Review](/best_practices/code_review.md)
* [Testing](/best_practices/testing.md)
* [Releases](/best_practices/releases.md)
* [Documentation](/best_practices/documentation.md)
* [Standards](/best_practices/standards.md)
Expand Down
2 changes: 1 addition & 1 deletion best_practices/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ developer and contributor since things have to be explained only once. A good CO
file describes at least how to perform the following tasks:

* How to [install the dependencies](#documented-development-setup)
* How to run [(unit) tests](testing.md#unit-tests)
* How to run [(unit) tests](https://the-turing-way.netlify.app/reproducible-research/testing/testing-unittest)
* What [code style](https://the-turing-way.netlify.app/reproducible-research/code-quality/code-quality-style.html) to use
* Reference to [code of conduct](#code-of-conduct)
* Mention the [git branching model](https://www.atlassian.com/git/tutorials/comparing-workflows) when using anything else than the [GitHub flow branching model](https://guides.github.com/introduction/flow/)
Expand Down
6 changes: 3 additions & 3 deletions best_practices/language_guides/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ The development environment will typically accumulate (old) packages during deve
### Code coverage

When you have tests it is also a good to see which source code is exercised by the test suite.
[Code coverage](../testing.md#Code_Coverage) can be measured with the [coverage](https://coverage.readthedocs.io) Python package.
[Code coverage](https://the-turing-way.netlify.app/reproducible-research/testing/testing-guidance#aim-to-have-a-good-code-coverage) can be measured with the [coverage](https://coverage.readthedocs.io) Python package.
The coverage package can also generate html reports which show which line was covered.
Most test runners have have the coverage package integrated.

The code coverage reports can be published online in code quality service or code coverage services.
The code coverage reports can be published online using a code quality service or code coverage services.
Preferred is to use one of the code quality service which also handles code coverage listed [below](#Code_quality_analysis_tools_and_services).
If this is not possible or does not fit then use one of the generic code coverage service list in the [software guide](../testing.md#Code_coverage_services).
If this is not possible or does not fit then use a generic code coverage service such as [Codecov](https://about.codecov.io/) or [Coveralls](https://coveralls.io/).

## Code quality analysis tools and services

Expand Down
2 changes: 1 addition & 1 deletion best_practices/language_guides/r.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ R function documentation offers plenty of space to document the functionality, i
See also [checking](http://r-pkgs.had.co.nz/check.html) and [testing](http://r-pkgs.had.co.nz/tests.html) R packages. note that within RStudio R package check and R package test can be done via simple toolbar clicks.

### Continuous integration
Continuous integration should be done with an [online service](../testing.md#Online-services-for-continuous-integration), see [Chapter](../testing.md) on testing.
[Continuous integration](https://the-turing-way.netlify.app/reproducible-research/ci) should be done with an online service.

### Debugging and Profiling
Debugging is possible in RStudio, see [link](https://support.posit.co/hc/en-us/articles/205612627-Debugging-with-RStudio). For profiling tips see [link](http://adv-r.had.co.nz/Profiling.html)
Expand Down
92 changes: 0 additions & 92 deletions best_practices/testing.md

This file was deleted.

0 comments on commit 2b9ba80

Please sign in to comment.