New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REVIEW]: ElGateau: A Library for Using the Elgato Stream Deck for Experimental Psychology Research #1070

Closed
whedon opened this Issue Nov 8, 2018 · 25 comments

Comments

Projects
None yet
5 participants
@whedon
Collaborator

whedon commented Nov 8, 2018

Submitting author: @cMadan (Christopher R Madan)
Repository: https://github.com/cMadan/ElGateau
Version: v1.0.1
Editor: @Kevin-Mattheus-Moerman
Reviewer: @JonathanReardon
Archive: 10.5281/zenodo.1525298

Status

status

Status badge code:

HTML: <a href="http://joss.theoj.org/papers/1c91fd713053854676d7a3554e374f6a"><img src="http://joss.theoj.org/papers/1c91fd713053854676d7a3554e374f6a/status.svg"></a>
Markdown: [![status](http://joss.theoj.org/papers/1c91fd713053854676d7a3554e374f6a/status.svg)](http://joss.theoj.org/papers/1c91fd713053854676d7a3554e374f6a)

Reviewers and authors:

Please avoid lengthy details of difficulties in the review thread. Instead, please create a new issue in the target repository 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.)

Reviewer instructions & questions

@JonathanReardon, please carry out your review in this issue by updating the checklist below. If you cannot edit the checklist please:

  1. Make sure you're logged in to your GitHub account
  2. Be sure to accept the invite at this URL: https://github.com/openjournals/joss-reviews/invitations

The reviewer guidelines are available here: https://joss.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @Kevin-Mattheus-Moerman know.

Please try and complete your review in the next two weeks

Review checklist for @JonathanReardon

Conflict of interest

Code of Conduct

General checks

  • Repository: Is the source code for this software available at the repository url?
  • License: Does the repository contain a plain-text LICENSE file with the contents of an OSI approved software license?
  • Version: Does the release version given match the GitHub release (v1.0.0)?
  • Authorship: Has the submitting author (@cMadan) made major contributions to the software? Does the full list of paper authors seem appropriate and complete?

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 function 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

  • Authors: Does the paper.md file include a list of authors with their affiliations?
  • A statement of need: Do the authors clearly state what problems the software is designed to solve and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?
@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 8, 2018

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @JonathanReardon it looks like you're currently assigned as the reviewer for this paper 🎉.

⭐️ Important ⭐️

If you haven't already, you should seriously consider unsubscribing from GitHub notifications for this (https://github.com/openjournals/joss-reviews) repository. As a reviewer, you're probably currently watching this repository which means for GitHub's default behaviour you will receive notifications (emails) for all reviews 😿

To fix this do the following two things:

  1. Set yourself as 'Not watching' https://github.com/openjournals/joss-reviews:

watching

  1. You may also like to change your default settings for this watching repositories in your GitHub profile here: https://github.com/settings/notifications

notifications

For a list of things I can do to help you, just type:

@whedon commands
@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 8, 2018

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 8, 2018

@cMadan

This comment has been minimized.

Member

cMadan commented Nov 19, 2018

@JonathanReardon, let me know if there is anything I can do to help!

@Kevin-Mattheus-Moerman

This comment has been minimized.

Member

Kevin-Mattheus-Moerman commented Nov 20, 2018

@JonathanReardon can you provide an estimate of when you will be able to work on this review? Thanks.

@JonathanReardon

This comment has been minimized.

Collaborator

JonathanReardon commented Nov 20, 2018

Apologies for the delay in getting back to you, I will be able to work on the review tomorrow, Thursday, and Friday.

@JonathanReardon

This comment has been minimized.

Collaborator

JonathanReardon commented Nov 24, 2018

Hi all, I have now completed the review. The library works as described in the documentation and I experienced no problems during all parts of testing. @cMadan, it might be a good idea to add 'Ubuntu 18.10 (Linux)' to the 'tested on..' statement in the README.md file, since this was the operating system that I tested the library on. Thanks all.

@cMadan

This comment has been minimized.

Member

cMadan commented Nov 25, 2018

Awesome, thanks for the review, @JonathanReardon.

Great that everything worked in Ubuntu, I'll add that to the 'tested on' statement.

@cMadan

This comment has been minimized.

Member

cMadan commented Nov 26, 2018

@Kevin-Mattheus-Moerman, looks like we're all set!

The DOI for the archived code is 10.5281/zenodo.1525298.

@cMadan

This comment has been minimized.

Member

cMadan commented Nov 26, 2018

I changed the photo in the paper (and readme) to be a photo of the device running one of the demos, rather than a photo I had found online.

@cMadan

This comment has been minimized.

Member

cMadan commented Nov 26, 2018

@whedon generate pdf

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

Attempting PDF compilation. Reticulating splines etc...
@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

@Kevin-Mattheus-Moerman

This comment has been minimized.

Member

Kevin-Mattheus-Moerman commented Nov 26, 2018

Thanks @JonathanReardon for the review work!

@Kevin-Mattheus-Moerman

This comment has been minimized.

Member

Kevin-Mattheus-Moerman commented Nov 26, 2018

@arfon I recommend we accept this submission. The version is now at v1.0.1. The DOI of the archived version is: 10.5281/zenodo.1525298.

@arfon

This comment has been minimized.

Member

arfon commented Nov 26, 2018

@whedon set 10.5281/zenodo.1525298 as archive

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

OK. 10.5281/zenodo.1525298 is the archive.

@arfon

This comment has been minimized.

Member

arfon commented Nov 26, 2018

@whedon accept

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

Attempting dry run of processing paper acceptance...
@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

Check final proof 👉 openjournals/joss-papers#82

If the paper PDF and Crossref deposit XML look good in openjournals/joss-papers#82, then you can now move forward with accepting the submission by compiling again with the flag deposit=true e.g.

@whedon accept deposit=true
@arfon

This comment has been minimized.

Member

arfon commented Nov 26, 2018

@whedon accept deposit=true

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

Doing it live! Attempting automated processing of paper acceptance...

@whedon whedon added the accepted label Nov 26, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

🚨🚨🚨 THIS IS NOT A DRILL, YOU HAVE JUST ACCEPTED A PAPER INTO JOSS! 🚨🚨🚨

Here's what you must now do:

  1. Check final PDF and Crossref metadata that was deposited 👉 openjournals/joss-papers#83
  2. Wait a couple of minutes to verify that the paper DOI resolves https://doi.org/10.21105/joss.01070
  3. If everything looks good, then close this review issue.
  4. Party like you just published a paper! 🎉🌈🦄💃👻🤘

Any issues? notify your editorial technical team...

@arfon

This comment has been minimized.

Member

arfon commented Nov 26, 2018

@JonathanReardon - many thanks for your review here and to @Kevin-Mattheus-Moerman for editing this submission

@cMadan - your paper is now accepted into JOSS ⚡️🚀💥

@arfon arfon closed this Nov 26, 2018

@whedon

This comment has been minimized.

Collaborator

whedon commented Nov 26, 2018

🎉🎉🎉 Congratulations on your paper acceptance! 🎉🎉🎉

If you would like to include a link to your paper from your README use the following code snippets:

Markdown:
[![DOI](http://joss.theoj.org/papers/10.21105/joss.01070/status.svg)](https://doi.org/10.21105/joss.01070)

HTML:
<a style="border-width:0" href="https://doi.org/10.21105/joss.01070">
  <img src="http://joss.theoj.org/papers/10.21105/joss.01070/status.svg" alt="DOI badge" >
</a>

reStructuredText:
.. image:: http://joss.theoj.org/papers/10.21105/joss.01070/status.svg
   :target: https://doi.org/10.21105/joss.01070

This is how it will look in your documentation:

DOI

We need your help!

Journal of Open Source Software is a community-run journal and relies upon volunteer effort. If you'd like to support us please consider doing either one (or both) of the the following:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment