Adds explicit statement of need to review checklist #862
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
The item for statement of need in the review checklist does not reflect our [explicit requirement](https://joss.readthedocs.io/en/latest/submitting.html#submission-requirements) to have this section, so this add it
adds explicit statement of need mention to the review checklist in docs
40 tasks
xuanxu
approved these changes
Feb 3, 2021
kthyng
reviewed
Feb 3, 2021
docs/review_checklist.md
Outdated
| @@ -30,7 +30,7 @@ Below is an example of the review checklist for the [Yellowbrick JOSS submission | |||
|
|
|||
| ### Documentation | |||
|
|
|||
| - **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is? | |||
| - **A statement of need:** Do the authors have a Statement of Need that clearly states what problems the software is designed to solve and who the target audience is? | |||
There was a problem hiding this comment.
Should it be yet more specific as in "Do the authors have a section entitled Statement of Need..." since that is what exactly is checked for?
arfon
reviewed
Feb 3, 2021
arfon
reviewed
Feb 3, 2021
|
Works for me! |
takes suggested change Co-authored-by: Arfon Smith <arfon@users.noreply.github.com>
takes suggested change Co-authored-by: Arfon Smith <arfon@users.noreply.github.com>
|
I've adopted those changes to make the language even more explicit |
Closed
40 tasks
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.
The item for statement of need in the review checklist does not reflect our explicit requirement to have this section, so this add it