Skip to content
This repository was archived by the owner on Apr 9, 2024. It is now read-only.

Commit 190fce1

Browse files
xuanxuxuanxu
authored
Merge pull request #138 from openjournals/refactor-checklists
Refactor checklists
2 parents dbb71d6 + 78a89c7 commit 190fce1

9 files changed

+851
-28
lines changed

‎responses/reviewer_checklist.erb

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## Review checklist for @<%= reviewer %>
2+
3+
### Conflict of interest
4+
5+
- [ ] 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.
6+
7+
### Code of Conduct
8+
9+
- [ ] I confirm that I read and will adhere to the [JOSS code of conduct](https://joss.theoj.org/about#code_of_conduct).
10+
11+
### General checks
12+
13+
- [ ] **Repository:** Is the source code for this software available at the [<%= repository_url %>](<%= repository_url %>)?
14+
- [ ] **License:** Does the repository contain a plain-text LICENSE file with the contents of an [OSI approved](https://opensource.org/licenses/alphabetical) software license?
15+
- [ ] **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?
16+
- [ ] **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)
17+
18+
### Functionality
19+
20+
- [ ] **Installation:** Does installation proceed as outlined in the documentation?
21+
- [ ] **Functionality:** Have the functional claims of the software been confirmed?
22+
- [ ] **Performance:** If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)
23+
24+
### Documentation
25+
26+
- [ ] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?
27+
- [ ] **Installation instructions:** Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.
28+
- [ ] **Example usage:** Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).
29+
- [ ] **Functionality documentation:** Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
30+
- [ ] **Automated tests:** Are there automated tests or manual steps described so that the functionality of the software can be verified?
31+
- [ ] **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
32+
33+
### Software paper
34+
35+
- [ ] **Summary:** Has a clear description of the high-level functionality and purpose of the software for a diverse, non-specialist audience been provided?
36+
- [ ] **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?
37+
- [ ] **State of the field:** Do the authors describe how this software compares to other commonly-used packages?
38+
- [ ] **Quality of writing:** Is the paper well written (i.e., it does not require editing for structure, language, or writing quality)?
39+
- [ ] **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

+10-2
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ class FakeGitHub < Sinatra::Base
1212
json_response 200, 'issue-940.json'
1313
end
1414

15-
# Pre-review issue
15+
# Pre-review issues
1616
get '/repos/openjournals/joss-reviews-testing/issues/936' do
1717
json_response 200, 'pre-review-issue-936.json'
1818
end
@@ -35,11 +35,19 @@ class FakeGitHub < Sinatra::Base
3535
json_response 200, 'pre-review-issue-935.json'
3636
end
3737

38-
# Review issue
38+
get '/repos/openjournals/joss-reviews-testing/issues/122' do
39+
json_response 200, 'pre-review-issue-122.json'
40+
end
41+
42+
# Review issues
3943
get '/repos/openjournals/joss-reviews-testing/issues/937' do
4044
json_response 200, 'review-issue-937.json'
4145
end
4246

47+
get '/repos/openjournals/joss-reviews-testing/issues/121' do
48+
json_response 200, 'review-issue-121.json'
49+
end
50+
4351
post '/repos/openjournals/joss-reviews-testing/issues/937/comments' do
4452
json_response 201, 'pre-review-issue-comment-created-937.json'
4553
end

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

+208
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,208 @@
1+
{
2+
"action": "created",
3+
"issue": {
4+
"url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121",
5+
"repository_url": "https://api.github.com/repos/openjournals/joss-reviews-testing",
6+
"labels_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/labels{/name}",
7+
"comments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/comments",
8+
"events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121/events",
9+
"html_url": "https://github.com/openjournals/joss-reviews-testing/issues/121",
10+
"id": 338403341,
11+
"node_id": "MDU6SXNzdWUzMzg0MDMzNDE=",
12+
"number": 121,
13+
"title": "[REVIEW]: Testing",
14+
"user": {
15+
"login": "arfon",
16+
"id": 4483,
17+
"node_id": "MDQ6VXNlcjQ0ODM=",
18+
"avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
19+
"gravatar_id": "",
20+
"url": "https://api.github.com/users/arfon",
21+
"html_url": "https://github.com/arfon",
22+
"followers_url": "https://api.github.com/users/arfon/followers",
23+
"following_url": "https://api.github.com/users/arfon/following{/other_user}",
24+
"gists_url": "https://api.github.com/users/arfon/gists{/gist_id}",
25+
"starred_url": "https://api.github.com/users/arfon/starred{/owner}{/repo}",
26+
"subscriptions_url": "https://api.github.com/users/arfon/subscriptions",
27+
"organizations_url": "https://api.github.com/users/arfon/orgs",
28+
"repos_url": "https://api.github.com/users/arfon/repos",
29+
"events_url": "https://api.github.com/users/arfon/events{/privacy}",
30+
"received_events_url": "https://api.github.com/users/arfon/received_events",
31+
"type": "User",
32+
"site_admin": false
33+
},
34+
"labels": [
35+
36+
],
37+
"state": "open",
38+
"locked": false,
39+
"assignee": null,
40+
"assignees": [
41+
42+
],
43+
"milestone": null,
44+
"comments": 4,
45+
"created_at": "2018-07-05T01:54:30Z",
46+
"updated_at": "2018-09-12T10:46:14Z",
47+
"closed_at": null,
48+
"author_association": "COLLABORATOR",
49+
"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 "
50+
},
51+
"comment": {
52+
"url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/comments/420601978",
53+
"html_url": "https://github.com/openjournals/joss-reviews-testing/issues/121#issuecomment-420601978",
54+
"issue_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/121",
55+
"id": 420601978,
56+
"node_id": "MDEyOklzc3VlQ29tbWVudDQyMDYwMTk3OA==",
57+
"user": {
58+
"login": "nonreviewer",
59+
"id": 4483,
60+
"node_id": "MDQ6VXNlcjQ0ODM=",
61+
"avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
62+
"gravatar_id": "",
63+
"url": "https://api.github.com/users/nonreviewer",
64+
"html_url": "https://github.com/nonreviewer",
65+
"followers_url": "https://api.github.com/users/nonreviewer/followers",
66+
"following_url": "https://api.github.com/users/nonreviewer/following{/other_user}",
67+
"gists_url": "https://api.github.com/users/nonreviewer/gists{/gist_id}",
68+
"starred_url": "https://api.github.com/users/nonreviewer/starred{/owner}{/repo}",
69+
"subscriptions_url": "https://api.github.com/users/nonreviewer/subscriptions",
70+
"organizations_url": "https://api.github.com/users/nonreviewer/orgs",
71+
"repos_url": "https://api.github.com/users/nonreviewer/repos",
72+
"events_url": "https://api.github.com/users/nonreviewer/events{/privacy}",
73+
"received_events_url": "https://api.github.com/users/nonreviewer/received_events",
74+
"type": "User",
75+
"site_admin": false
76+
},
77+
"created_at": "2018-09-12T10:46:14Z",
78+
"updated_at": "2018-09-12T10:46:14Z",
79+
"body": "@whedon generate my checklist"
80+
},
81+
"repository": {
82+
"id": 59520368,
83+
"node_id": "MDEwOlJlcG9zaXRvcnk1OTUyMDM2OA==",
84+
"name": "joss-reviews-testing",
85+
"full_name": "openjournals/joss-reviews-testing",
86+
"owner": {
87+
"login": "openjournals",
88+
"id": 9032431,
89+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjkwMzI0MzE=",
90+
"avatar_url": "https://avatars3.githubusercontent.com/u/9032431?v=4",
91+
"gravatar_id": "",
92+
"url": "https://api.github.com/users/openjournals",
93+
"html_url": "https://github.com/openjournals",
94+
"followers_url": "https://api.github.com/users/openjournals/followers",
95+
"following_url": "https://api.github.com/users/openjournals/following{/other_user}",
96+
"gists_url": "https://api.github.com/users/openjournals/gists{/gist_id}",
97+
"starred_url": "https://api.github.com/users/openjournals/starred{/owner}{/repo}",
98+
"subscriptions_url": "https://api.github.com/users/openjournals/subscriptions",
99+
"organizations_url": "https://api.github.com/users/openjournals/orgs",
100+
"repos_url": "https://api.github.com/users/openjournals/repos",
101+
"events_url": "https://api.github.com/users/openjournals/events{/privacy}",
102+
"received_events_url": "https://api.github.com/users/openjournals/received_events",
103+
"type": "Organization",
104+
"site_admin": false
105+
},
106+
"private": true,
107+
"html_url": "https://github.com/openjournals/joss-reviews-testing",
108+
"description": null,
109+
"fork": false,
110+
"url": "https://api.github.com/repos/openjournals/joss-reviews-testing",
111+
"forks_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/forks",
112+
"keys_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/keys{/key_id}",
113+
"collaborators_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/collaborators{/collaborator}",
114+
"teams_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/teams",
115+
"hooks_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/hooks",
116+
"issue_events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/events{/number}",
117+
"events_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/events",
118+
"assignees_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/assignees{/user}",
119+
"branches_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/branches{/branch}",
120+
"tags_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/tags",
121+
"blobs_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/blobs{/sha}",
122+
"git_tags_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/tags{/sha}",
123+
"git_refs_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/refs{/sha}",
124+
"trees_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/trees{/sha}",
125+
"statuses_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/statuses/{sha}",
126+
"languages_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/languages",
127+
"stargazers_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/stargazers",
128+
"contributors_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/contributors",
129+
"subscribers_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/subscribers",
130+
"subscription_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/subscription",
131+
"commits_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/commits{/sha}",
132+
"git_commits_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/git/commits{/sha}",
133+
"comments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/comments{/number}",
134+
"issue_comment_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues/comments{/number}",
135+
"contents_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/contents/{+path}",
136+
"compare_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/compare/{base}...{head}",
137+
"merges_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/merges",
138+
"archive_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/{archive_format}{/ref}",
139+
"downloads_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/downloads",
140+
"issues_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/issues{/number}",
141+
"pulls_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/pulls{/number}",
142+
"milestones_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/milestones{/number}",
143+
"notifications_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/notifications{?since,all,participating}",
144+
"labels_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/labels{/name}",
145+
"releases_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/releases{/id}",
146+
"deployments_url": "https://api.github.com/repos/openjournals/joss-reviews-testing/deployments",
147+
"created_at": "2016-05-23T21:43:02Z",
148+
"updated_at": "2017-11-13T19:56:15Z",
149+
"pushed_at": "2018-09-09T21:24:53Z",
150+
"git_url": "git://github.com/openjournals/joss-reviews-testing.git",
151+
"ssh_url": "[email protected]:openjournals/joss-reviews-testing.git",
152+
"clone_url": "https://github.com/openjournals/joss-reviews-testing.git",
153+
"svn_url": "https://github.com/openjournals/joss-reviews-testing",
154+
"homepage": null,
155+
"size": 3,
156+
"stargazers_count": 0,
157+
"watchers_count": 0,
158+
"language": "Ruby",
159+
"has_issues": true,
160+
"has_projects": true,
161+
"has_downloads": true,
162+
"has_wiki": true,
163+
"has_pages": false,
164+
"forks_count": 0,
165+
"mirror_url": null,
166+
"archived": false,
167+
"open_issues_count": 36,
168+
"license": null,
169+
"forks": 0,
170+
"open_issues": 36,
171+
"watchers": 0,
172+
"default_branch": "test"
173+
},
174+
"organization": {
175+
"login": "openjournals",
176+
"id": 9032431,
177+
"node_id": "MDEyOk9yZ2FuaXphdGlvbjkwMzI0MzE=",
178+
"url": "https://api.github.com/orgs/openjournals",
179+
"repos_url": "https://api.github.com/orgs/openjournals/repos",
180+
"events_url": "https://api.github.com/orgs/openjournals/events",
181+
"hooks_url": "https://api.github.com/orgs/openjournals/hooks",
182+
"issues_url": "https://api.github.com/orgs/openjournals/issues",
183+
"members_url": "https://api.github.com/orgs/openjournals/members{/member}",
184+
"public_members_url": "https://api.github.com/orgs/openjournals/public_members{/member}",
185+
"avatar_url": "https://avatars3.githubusercontent.com/u/9032431?v=4",
186+
"description": ""
187+
},
188+
"sender": {
189+
"login": "nonreviewer",
190+
"id": 4483,
191+
"node_id": "MDQ6VXNlcjQ0ODM=",
192+
"avatar_url": "https://avatars1.githubusercontent.com/u/4483?v=4",
193+
"gravatar_id": "",
194+
"url": "https://api.github.com/users/nonreviewer",
195+
"html_url": "https://github.com/nonreviewer",
196+
"followers_url": "https://api.github.com/users/nonreviewer/followers",
197+
"following_url": "https://api.github.com/users/nonreviewer/following{/other_user}",
198+
"gists_url": "https://api.github.com/users/nonreviewer/gists{/gist_id}",
199+
"starred_url": "https://api.github.com/users/nonreviewer/starred{/owner}{/repo}",
200+
"subscriptions_url": "https://api.github.com/users/nonreviewer/subscriptions",
201+
"organizations_url": "https://api.github.com/users/nonreviewer/orgs",
202+
"repos_url": "https://api.github.com/users/nonreviewer/repos",
203+
"events_url": "https://api.github.com/users/nonreviewer/events{/privacy}",
204+
"received_events_url": "https://api.github.com/users/nonreviewer/received_events",
205+
"type": "User",
206+
"site_admin": false
207+
}
208+
}

0 commit comments

Comments
 (0)