{"action":"created","issue":{"url":"https://api.github.com/repos/openjournals/joss-reviews/issues/863","repository_url":"https://api.github.com/repos/openjournals/joss-reviews","labels_url":"https://api.github.com/repos/openjournals/joss-reviews/issues/863/labels{/name}","comments_url":"https://api.github.com/repos/openjournals/joss-reviews/issues/863/comments","events_url":"https://api.github.com/repos/openjournals/joss-reviews/issues/863/events","html_url":"https://github.com/openjournals/joss-reviews/issues/863","id":345848058,"node_id":"MDU6SXNzdWUzNDU4NDgwNTg=","number":863,"title":"[REVIEW]: GrainSizeTools: a Python script for grain size analysis and paleopiezometry based on grain size","user":{"login":"whedon","id":18508068,"node_id":"MDQ6VXNlcjE4NTA4MDY4","avatar_url":"https://avatars3.githubusercontent.com/u/18508068?v=4","gravatar_id":"","url":"https://api.github.com/users/whedon","html_url":"https://github.com/whedon","followers_url":"https://api.github.com/users/whedon/followers","following_url":"https://api.github.com/users/whedon/following{/other_user}","gists_url":"https://api.github.com/users/whedon/gists{/gist_id}","starred_url":"https://api.github.com/users/whedon/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/whedon/subscriptions","organizations_url":"https://api.github.com/users/whedon/orgs","repos_url":"https://api.github.com/users/whedon/repos","events_url":"https://api.github.com/users/whedon/events{/privacy}","received_events_url":"https://api.github.com/users/whedon/received_events","type":"User","site_admin":false},"labels":[{"id":330465313,"node_id":"MDU6TGFiZWwzMzA0NjUzMTM=","url":"https://api.github.com/repos/openjournals/joss-reviews/labels/review","name":"review","color":"fbca04","default":false}],"state":"open","locked":false,"assignee":{"login":"lheagy","id":6361812,"node_id":"MDQ6VXNlcjYzNjE4MTI=","avatar_url":"https://avatars1.githubusercontent.com/u/6361812?v=4","gravatar_id":"","url":"https://api.github.com/users/lheagy","html_url":"https://github.com/lheagy","followers_url":"https://api.github.com/users/lheagy/followers","following_url":"https://api.github.com/users/lheagy/following{/other_user}","gists_url":"https://api.github.com/users/lheagy/gists{/gist_id}","starred_url":"https://api.github.com/users/lheagy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lheagy/subscriptions","organizations_url":"https://api.github.com/users/lheagy/orgs","repos_url":"https://api.github.com/users/lheagy/repos","events_url":"https://api.github.com/users/lheagy/events{/privacy}","received_events_url":"https://api.github.com/users/lheagy/received_events","type":"User","site_admin":false},"assignees":[{"login":"lheagy","id":6361812,"node_id":"MDQ6VXNlcjYzNjE4MTI=","avatar_url":"https://avatars1.githubusercontent.com/u/6361812?v=4","gravatar_id":"","url":"https://api.github.com/users/lheagy","html_url":"https://github.com/lheagy","followers_url":"https://api.github.com/users/lheagy/followers","following_url":"https://api.github.com/users/lheagy/following{/other_user}","gists_url":"https://api.github.com/users/lheagy/gists{/gist_id}","starred_url":"https://api.github.com/users/lheagy/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lheagy/subscriptions","organizations_url":"https://api.github.com/users/lheagy/orgs","repos_url":"https://api.github.com/users/lheagy/repos","events_url":"https://api.github.com/users/lheagy/events{/privacy}","received_events_url":"https://api.github.com/users/lheagy/received_events","type":"User","site_admin":false}],"milestone":null,"comments":11,"created_at":"2018-07-30T17:04:26Z","updated_at":"2018-08-21T21:23:57Z","closed_at":null,"author_association":"COLLABORATOR","body":"**Submitting author:** @marcoalopez (<a href=\"http://orcid.org/0000-0002-0261-9267\">Marco A. Lopez-Sanchez</a>)\r\n**Repository:** <a href=\"https://github.com/marcoalopez/GrainSizeTools/\" target =\"_blank\">https://github.com/marcoalopez/GrainSizeTools/</a>\r\n**Version:** v2.0\r\n**Editor:** @lheagy\r\n**Reviewer:** @khaors, @jsta\r\n**Archive:** Pending\r\n\r\n## Status\r\n\r\n[![status](http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815/status.svg)](http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815)\r\n\r\nStatus badge code:\r\n\r\n```\r\nHTML: <a href=\"http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815\"><img src=\"http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815/status.svg\"></a>\r\nMarkdown: [![status](http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815/status.svg)](http://joss.theoj.org/papers/677d076203e90d16eaaf301a05600815)\r\n```\r\n**Reviewers and authors**:\r\n\r\nPlease avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the <a href=\"https://marcoalopez.github.io/GrainSizeTools/\" target=\"_blank\">target repository</a> and link to those issues (especially acceptance-blockers) in the review thread below. (For completists: if the target issue tracker is also on GitHub, linking the review thread in the issue or vice versa will create corresponding breadcrumb trails in the link target.)\r\n\r\n## Reviewer instructions & questions\r\n\r\n@khaors, @jsta, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:\r\n1. Make sure you're logged in to your GitHub account\r\n2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations\r\n\r\nThe reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @lheagy know.\r\n\r\n✨ **Please try and complete your review in the next two weeks** ✨ \r\n\r\n## Review checklist for @khaors\r\n### Conflict of interest\r\n\r\n- [ ] As the reviewer I confirm that I have read the [JOSS conflict of interest policy](https://github.com/openjournals/joss/blob/master/COI.md) and that there are no conflicts of interest for me to review this work.\r\n\r\n### Code of Conduct\r\n\r\n- [ ] I confirm that I read and will adhere to the [JOSS code of conduct](https://joss.theoj.org/about#code_of_conduct).\r\n\r\n### General checks\r\n\r\n- [ ] **Repository:** Is the source code for this software available at the <a target=\"_blank\" href=\"https://marcoalopez.github.io/GrainSizeTools/\">repository url</a>?\r\n- [ ] **License:** Does the repository contain a plain-text LICENSE file with the contents of an [OSI approved](https://opensource.org/licenses/alphabetical) software license?\r\n- [ ] **Version:** Does the release version given match the GitHub release (v2.0)?\r\n- [ ] **Authorship:** Has the submitting author (@marcoalopez) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?\r\n\r\n### Functionality\r\n\r\n- [ ] **Installation:** Does installation proceed as outlined in the documentation?\r\n- [ ] **Functionality:** Have the functional claims of the software been confirmed?\r\n- [ ] **Performance:** If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)\r\n\r\n### Documentation\r\n\r\n- [ ] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?\r\n- [ ] **Installation instructions:** Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.\r\n- [ ] **Example usage:** Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).\r\n- [ ] **Functionality documentation:** Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?\r\n- [ ] **Automated tests:** Are there automated tests or manual steps described so that the function of the software can be verified?\r\n- [ ] **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\r\n\r\n### Software paper\r\n\r\n- [ ] **Authors:** Does the `paper.md` file include a list of authors with their affiliations?\r\n- [ ] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?\r\n- [ ] **References:** Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?\r\n\r\n## Review checklist for @jsta\r\n### Conflict of interest\r\n\r\n- [x] As the reviewer I confirm that I have read the [JOSS conflict of interest policy](https://github.com/openjournals/joss/blob/master/COI.md) and that there are no conflicts of interest for me to review this work.\r\n\r\n### Code of Conduct\r\n\r\n- [x] I confirm that I read and will adhere to the [JOSS code of conduct](https://joss.theoj.org/about#code_of_conduct).\r\n\r\n### General checks\r\n\r\n- [ ] **Repository:** Is the source code for this software available at the <a target=\"_blank\" href=\"https://marcoalopez.github.io/GrainSizeTools/\">repository url</a>?\r\n\r\nNo, per [this comment](https://github.com/openjournals/joss-reviews/issues/863#issuecomment-412172870) the repository url should be https://github.com/marcoalopez/GrainSizeTools. Also the documentation lists three different download mirrors. Is it too much to maintain a sourceforge, figshare, and Github?\r\n\r\n- [x] **License:** Does the repository contain a plain-text LICENSE file with the contents of an [OSI approved](https://opensource.org/licenses/alphabetical) software license?\r\n- [x] **Version:** Does the release version given match the GitHub release (v2.0)?\r\n- [x] **Authorship:** Has the submitting author (@marcoalopez) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?\r\n\r\n### Functionality\r\n\r\n- [x] **Installation:** Does installation proceed as outlined in the documentation?\r\n- [x] **Functionality:** Have the functional claims of the software been confirmed?\r\n- [x] **Performance:** If there are any performance claims of the software, have they been confirmed? (If there are no claims, please check off this item.)\r\n\r\n### Documentation\r\n\r\n- [x] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?\r\n- [x] **Installation instructions:** Is there a clearly-stated list of dependencies? Ideally these should be handled with an automated package management solution.\r\n- [x] **Example usage:** Do the authors include examples of how to use the software (ideally to solve real-world analysis problems).\r\n- [x] **Functionality documentation:** Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?\r\n- [x] **Automated tests:** Are there automated tests or manual steps described so that the function of the software can be verified?\r\n\r\nThere is an extensive set of manual steps described in the documentation to verify software function. All of them run with minimal machine specific modification.\r\n\r\n- [ ] **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\r\n\r\n### Software paper\r\n\r\n- [x] **Authors:** Does the `paper.md` file include a list of authors with their affiliations?\r\n- [x] **A statement of need:** Do the authors clearly state what problems the software is designed to solve and who the target audience is?\r\n- [x] **References:** Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/openjournals/joss-reviews/issues/comments/414826461","html_url":"https://github.com/openjournals/joss-reviews/issues/863#issuecomment-414826461","issue_url":"https://api.github.com/repos/openjournals/joss-reviews/issues/863","id":414826461,"node_id":"MDEyOklzc3VlQ29tbWVudDQxNDgyNjQ2MQ==","user":{"login":"marcoalopez","id":10434005,"node_id":"MDQ6VXNlcjEwNDM0MDA1","avatar_url":"https://avatars2.githubusercontent.com/u/10434005?v=4","gravatar_id":"","url":"https://api.github.com/users/marcoalopez","html_url":"https://github.com/marcoalopez","followers_url":"https://api.github.com/users/marcoalopez/followers","following_url":"https://api.github.com/users/marcoalopez/following{/other_user}","gists_url":"https://api.github.com/users/marcoalopez/gists{/gist_id}","starred_url":"https://api.github.com/users/marcoalopez/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/marcoalopez/subscriptions","organizations_url":"https://api.github.com/users/marcoalopez/orgs","repos_url":"https://api.github.com/users/marcoalopez/repos","events_url":"https://api.github.com/users/marcoalopez/events{/privacy}","received_events_url":"https://api.github.com/users/marcoalopez/received_events","type":"User","site_admin":false},"created_at":"2018-08-21T21:23:57Z","updated_at":"2018-08-21T21:23:57Z","author_association":"NONE","body":"Hi @jsta, thank you for this initial review. Regarding the **community guidelines**, I mention in the FAQ section https://github.com/marcoalopez/GrainSizeTools/blob/master/DOCS/FAQ.md the following: \r\n\r\n> ***Can I report bugs or submit ideas to improve the script?***  \r\nSure. If you have issues using the script, found a bug or see an error in the documentation please just let me know by dropping me an email or open an issue [here](https://github.com/marcoalopez/GrainSizeTools/issues) (you can find my email here: https://github.com/marcoalopez ). Feedback from users is always welcome and important to develop a better and reliable script. Lastly, you can also fork the project and develop your own based on the GST script since it is open source and free.\r\n\r\nI guess this text has two problems: (1) it is not obvious to find the community guidelines in the FAQ, and (2) maybe it is too short or not very detailed. Any ideas on how to improve this and give it more visibility? Perhaps I could indicate this more explicitly on the main website.\r\n\r\nPS. I fixed a typo in the original FAQ text I copied above. However, the meaning of the text remains the same as the original."}}
{"actor":{"display_login":"marcoalopez"}}