Skip to content

Commit

Permalink
Change hierarchy
Browse files Browse the repository at this point in the history
  • Loading branch information
arfon committed Jul 1, 2018
1 parent cd2d354 commit 27738a9
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions docs/review_criteria.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,14 +57,6 @@ Reviewers should check that the software API is documented to a suitable level.
.. note:: The decision on API documentation is left largely to the discretion of the reviewer and their experience of evaluating the software.
```

#### Tests

Authors are strongly encouraged to include an automated test suite covering the core functionality of their software.

> **Good:** An automated test suite hooked up to an external service such as Travis-CI or similar<br />
> **OK:** Documented manual steps that can be followed to check the expected functionality of the software (e.g. a sample input file to assert behaviour)<br />
> **Bad (not acceptable):** No way for you the reviewer to check whether the software works
#### Community guidelines

There should be clear guidelines for third-parties wishing to:
Expand All @@ -73,10 +65,18 @@ There should be clear guidelines for third-parties wishing to:
- Report issues or problems with the software
- Seek support

#### Functionality
### Functionality

Reviewers are expected to install the software they are reviewing and to verify the core functionality of the software.

### Tests

Authors are strongly encouraged to include an automated test suite covering the core functionality of their software.

> **Good:** An automated test suite hooked up to an external service such as Travis-CI or similar<br />
> **OK:** Documented manual steps that can be followed to check the expected functionality of the software (e.g. a sample input file to assert behaviour)<br />
> **Bad (not acceptable):** No way for you the reviewer to check whether the software works
## Other considerations

### An important note about 'novel' software
Expand Down

0 comments on commit 27738a9

Please sign in to comment.