Merge pull request #138 from openjournals/refactor-checklists

Refactor checklists

responses/reviewer_checklist.erb

@@ -0,0 +1,39 @@
+## Review checklist for @<%= reviewer %>
+
+### Conflict of interest
+
+- [ ] I confirm that I have read the [JOSS conflict of interest (COI) policy](https://github.com/openjournals/joss/blob/master/COI.md) and that: I have no COIs with reviewing this work or that any perceived COIs have been waived by JOSS for the purpose of this review.
+
+### Code of Conduct
+
+- [ ] I confirm that I read and will adhere to the [JOSS code of conduct](https://joss.theoj.org/about#code_of_conduct).
+
+### General checks
+
+- [ ] **Repository:** Is the source code for this software available at the [<%= repository_url %>](<%= repository_url %>)?
+- [ ] **License:** Does the repository contain a plain-text LICENSE file with the contents of an [OSI approved](https://opensource.org/licenses/alphabetical) software license?
+- [ ] **Contribution and authorship:** Has the submitting author (<%= submitting_author %>) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?
+- [ ] **Substantial scholarly effort:** Does this submission meet the scope eligibility described in the [JOSS guidelines](https://joss.readthedocs.io/en/latest/submitting.html#substantial-scholarly-effort)
+
+### Functionality
+
+- [ ] **Installation:** Does installation proceed as outlined in the documentation?
+- [ ] **Functionality:** Have the functional claims of the software been confirmed?
+- [ ] **Performance:** If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)
+
+### Documentation
+
+- [ ] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?
+- [ ] **Installation instructions:** Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
+- [ ] **Example usage:** Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
+- [ ] **Functionality documentation:** Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
+- [ ] **Automated tests:** Are there automated tests or manual steps described so that the functionality of the software can be verified?
+- [ ] **Community guidelines:** Are there clear guidelines for third parties wishing to 1) Contribute to the software 2) Report issues or problems with the software 3) Seek support
+
+### Software paper
+
+- [ ] **Summary:** Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
+- [ ] **A statement of need:** Does the paper have a section titled 'Statement of Need' that clearly states what problems the software is designed to solve and who the target audience is?
+- [ ] **State of the field:** Do the authors describe how this software compares to other commonly-used packages?
+- [ ] **Quality of writing:** Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
+- [ ] **References:** Is the list of references complete, and is everything cited appropriately that should be cited (e.g., papers, datasets, software)? Do references in the text use the proper [citation syntax]( https://rmarkdown.rstudio.com/authoring_bibliographies_and_citations.html#citation_syntax)?

spec/support/fake_github.rb

@@ -12,7 +12,7 @@ class FakeGitHub < Sinatra::Base
     json_response 200, 'issue-940.json'
   end
 
-  # Pre-review issue
+  # Pre-review issues
   get '/repos/openjournals/joss-reviews-testing/issues/936' do
     json_response 200, 'pre-review-issue-936.json'
   end
@@ -35,11 +35,19 @@ class FakeGitHub < Sinatra::Base
     json_response 200, 'pre-review-issue-935.json'
   end
 
-  # Review issue
+  get '/repos/openjournals/joss-reviews-testing/issues/122' do
+    json_response 200, 'pre-review-issue-122.json'
+  end
+
+  # Review issues
   get '/repos/openjournals/joss-reviews-testing/issues/937' do
     json_response 200, 'review-issue-937.json'
   end
 
+  get '/repos/openjournals/joss-reviews-testing/issues/121' do
+    json_response 200, 'review-issue-121.json'
+  end
+
   post '/repos/openjournals/joss-reviews-testing/issues/937/comments' do
     json_response 201, 'pre-review-issue-comment-created-937.json'
   end

spec/support/fixtures/generate-my-checklist-non-reviewer.json

@@ -0,0 +1,208 @@
+{
+  "action": "created",
+  "issue": {
+    "url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121",
+    "repository_url": "https://api.github.com/repos/openjournals/joss-reviews-testing",
+    "labels_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/labels{/name}",
+    "comments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/comments",
+    "events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/events",
+    "html_url": "https://github.com/openjournals/joss-reviews-testing/issues/121",
+    "id": 338403341,
+    "node_id": "MDU6SXNzdWUzMzg0MDMzNDE=",
+    "number": 121,
+    "title": "[REVIEW]: Testing",
+    "user": {
+      "login": "arfon",
+      "id": 4483,
+      "node_id": "MDQ6VXNlcjQ0ODM=",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/arfon",
+      "html_url": "https://github.com/arfon",
+      "followers_url": "https://api.github.com/users/arfon/followers",
+      "following_url": "https://api.github.com/users/arfon/following{/other_user}",
+      "gists_url": "https://api.github.com/users/arfon/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/arfon/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/arfon/subscriptions",
+      "organizations_url": "https://api.github.com/users/arfon/orgs",
+      "repos_url": "https://api.github.com/users/arfon/repos",
+      "events_url": "https://api.github.com/users/arfon/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/arfon/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "labels": [
+
+    ],
+    "state": "open",
+    "locked": false,
+    "assignee": null,
+    "assignees": [
+
+    ],
+    "milestone": null,
+    "comments": 4,
+    "created_at": "2018-07-05T01:54:30Z",
+    "updated_at": "2018-09-12T10:46:14Z",
+    "closed_at": null,
+    "author_association": "COLLABORATOR",
+    "body": "**Submitting author:** @arfon (<a href=\"http://orcid.org/0000-0002-1236-5109\">Robert Gieseke</a>)\r\n**Repository:** <a href=\"https://github.com/spacetelescope/nircam_data_analysis\" target =\"_blank\">https://github.com/spacetelescope/nircam_data_analysis</a>\r\n**Version:** v1.0.1\r\n**Editor:** @arfon\r\n**Reviewers:** @reviewer1, @reviewer2\r\n\r\n**Author instructions**\r\n\r\nThanks for submitting your paper to JOSS @rgieseke. The JOSS editor (shown at the top of this issue) will work with you on this issue to find a reviewer for your submission before creating the main review issue.\r\n\r\n@rgieseke if you have any suggestions for potential reviewers then please mention them here in this thread. In addition, [this list of people](https://github.com/openjournals/joss/blob/master/docs/reviewers.csv) have already agreed to review for JOSS and may be suitable for this submission.\r\n\r\n**Editor instructions**\r\n\r\nThe JOSS submission bot @whedon is here to help you find and assign reviewers and start the main review. To find out what @whedon can do for you type:\r\n\r\n```\r\n@whedon commands\r\n```\r\n\r\n  "
+  },
+  "comment": {
+    "url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/comments/420601978",
+    "html_url": "https://github.com/openjournals/joss-reviews-testing/issues/121#issuecomment-420601978",
+    "issue_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121",
+    "id": 420601978,
+    "node_id": "MDEyOklzc3VlQ29tbWVudDQyMDYwMTk3OA==",
+    "user": {
+      "login": "nonreviewer",
+      "id": 4483,
+      "node_id": "MDQ6VXNlcjQ0ODM=",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/nonreviewer",
+      "html_url": "https://github.com/nonreviewer",
+      "followers_url": "https://api.github.com/users/nonreviewer/followers",
+      "following_url": "https://api.github.com/users/nonreviewer/following{/other_user}",
+      "gists_url": "https://api.github.com/users/nonreviewer/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/nonreviewer/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/nonreviewer/subscriptions",
+      "organizations_url": "https://api.github.com/users/nonreviewer/orgs",
+      "repos_url": "https://api.github.com/users/nonreviewer/repos",
+      "events_url": "https://api.github.com/users/nonreviewer/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/nonreviewer/received_events",
+      "type": "User",
+      "site_admin": false
+    },
+    "created_at": "2018-09-12T10:46:14Z",
+    "updated_at": "2018-09-12T10:46:14Z",
+    "body": "@whedon generate my checklist"
+  },
+  "repository": {
+    "id": 59520368,
+    "node_id": "MDEwOlJlcG9zaXRvcnk1OTUyMDM2OA==",
+    "name": "joss-reviews-testing",
+    "full_name": "openjournals/joss-reviews-testing",
+    "owner": {
+      "login": "openjournals",
+      "id": 9032431,
+      "node_id": "MDEyOk9yZ2FuaXphdGlvbjkwMzI0MzE=",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/9032431?v=4",
+      "gravatar_id": "",
+      "url": "https://api.github.com/users/openjournals",
+      "html_url": "https://github.com/openjournals",
+      "followers_url": "https://api.github.com/users/openjournals/followers",
+      "following_url": "https://api.github.com/users/openjournals/following{/other_user}",
+      "gists_url": "https://api.github.com/users/openjournals/gists{/gist_id}",
+      "starred_url": "https://api.github.com/users/openjournals/starred{/owner}{/repo}",
+      "subscriptions_url": "https://api.github.com/users/openjournals/subscriptions",
+      "organizations_url": "https://api.github.com/users/openjournals/orgs",
+      "repos_url": "https://api.github.com/users/openjournals/repos",
+      "events_url": "https://api.github.com/users/openjournals/events{/privacy}",
+      "received_events_url": "https://api.github.com/users/openjournals/received_events",
+      "type": "Organization",
+      "site_admin": false
+    },
+    "private": true,
+    "html_url": "https://github.com/openjournals/joss-reviews-testing",
+    "description": null,
+    "fork": false,
+    "url": "https://api.github.com/repos/openjournals/joss-reviews-testing",
+    "forks_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/forks",
+    "keys_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/keys{/key_id}",
+    "collaborators_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/collaborators{/collaborator}",
+    "teams_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/teams",
+    "hooks_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/hooks",
+    "issue_events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/events{/number}",
+    "events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/events",
+    "assignees_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/assignees{/user}",
+    "branches_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/branches{/branch}",
+    "tags_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/tags",
+    "blobs_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/blobs{/sha}",
+    "git_tags_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/tags{/sha}",
+    "git_refs_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/refs{/sha}",
+    "trees_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/trees{/sha}",
+    "statuses_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/statuses/{sha}",
+    "languages_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/languages",
+    "stargazers_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/stargazers",
+    "contributors_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/contributors",
+    "subscribers_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/subscribers",
+    "subscription_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/subscription",
+    "commits_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/commits{/sha}",
+    "git_commits_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/commits{/sha}",
+    "comments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/comments{/number}",
+    "issue_comment_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/comments{/number}",
+    "contents_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/contents/{+path}",
+    "compare_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/compare/{base}...{head}",
+    "merges_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/merges",
+    "archive_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/{archive_format}{/ref}",
+    "downloads_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/downloads",
+    "issues_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues{/number}",
+    "pulls_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/pulls{/number}",
+    "milestones_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/milestones{/number}",
+    "notifications_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/notifications{?since,all,participating}",
+    "labels_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/labels{/name}",
+    "releases_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/releases{/id}",
+    "deployments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/deployments",
+    "created_at": "2016-05-23T21:43:02Z",
+    "updated_at": "2017-11-13T19:56:15Z",
+    "pushed_at": "2018-09-09T21:24:53Z",
+    "git_url": "git://github.com/openjournals/joss-reviews-testing.git",
+    "ssh_url": "[email protected]:openjournals/joss-reviews-testing.git",
+    "clone_url": "https://github.com/openjournals/joss-reviews-testing.git",
+    "svn_url": "https://github.com/openjournals/joss-reviews-testing",
+    "homepage": null,
+    "size": 3,
+    "stargazers_count": 0,
+    "watchers_count": 0,
+    "language": "Ruby",
+    "has_issues": true,
+    "has_projects": true,
+    "has_downloads": true,
+    "has_wiki": true,
+    "has_pages": false,
+    "forks_count": 0,
+    "mirror_url": null,
+    "archived": false,
+    "open_issues_count": 36,
+    "license": null,
+    "forks": 0,
+    "open_issues": 36,
+    "watchers": 0,
+    "default_branch": "test"
+  },
+  "organization": {
+    "login": "openjournals",
+    "id": 9032431,
+    "node_id": "MDEyOk9yZ2FuaXphdGlvbjkwMzI0MzE=",
+    "url": "https://api.github.com/orgs/openjournals",
+    "repos_url": "https://api.github.com/orgs/openjournals/repos",
+    "events_url": "https://api.github.com/orgs/openjournals/events",
+    "hooks_url": "https://api.github.com/orgs/openjournals/hooks",
+    "issues_url": "https://api.github.com/orgs/openjournals/issues",
+    "members_url": "https://api.github.com/orgs/openjournals/members{/member}",
+    "public_members_url": "https://api.github.com/orgs/openjournals/public_members{/member}",
+    "avatar_url": "https://avatars3.githubusercontent.com/u/9032431?v=4",
+    "description": ""
+  },
+  "sender": {
+    "login": "nonreviewer",
+    "id": 4483,
+    "node_id": "MDQ6VXNlcjQ0ODM=",
+    "avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/nonreviewer",
+    "html_url": "https://github.com/nonreviewer",
+    "followers_url": "https://api.github.com/users/nonreviewer/followers",
+    "following_url": "https://api.github.com/users/nonreviewer/following{/other_user}",
+    "gists_url": "https://api.github.com/users/nonreviewer/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/nonreviewer/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/nonreviewer/subscriptions",
+    "organizations_url": "https://api.github.com/users/nonreviewer/orgs",
+    "repos_url": "https://api.github.com/users/nonreviewer/repos",
+    "events_url": "https://api.github.com/users/nonreviewer/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/nonreviewer/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+}