Skip to content
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]: ChAmElEoN: A Customizable Language and Suite of Interpreters for Teaching Concepts of Programming Languages #56

Open
whedon opened this issue Jun 4, 2019 · 18 comments

Comments

Projects
None yet
6 participants
@whedon
Copy link
Collaborator

commented Jun 4, 2019

Submitting author: @saverioperugini (Saverio Perugini)
Repository: https://bitbucket.org/chameleoninterpreter/chameleon-interpreter-in-python-release/
Version: v.1.0.0
Editor: @RobertTalbert
Reviewer: @georgiastuart, @valentina-s
Archive: Pending

Status

status

Status badge code:

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

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

@georgiastuart & @valentina-s, 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/jose-reviews/invitations

The reviewer guidelines are available here: https://jose.theoj.org/about#reviewer_guidelines. Any questions/concerns please let @RobertTalbert know.

Review checklist for @georgiastuart

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 (v.1.0.0)?
  • Authorship: Has the submitting author (@saverioperugini) made substantial 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? (and documentation is sufficient?)
  • 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 the need for this software 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?
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • 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 the need for this software and who the target audience is?
  • References: Do all archival references that should have a DOI list one (e.g., papers, datasets, software)?

Review checklist for @valentina-s

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 (v.1.0.0)?
  • Authorship: Has the submitting author (@saverioperugini) made substantial 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? (and documentation is sufficient?)
  • 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 the need for this software 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?
  • Functionality documentation: Is the core functionality of the software documented to a satisfactory level (e.g., API method documentation)?
  • 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 the need for this software 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.

Copy link
Collaborator Author

commented Jun 4, 2019

Hello human, I'm @whedon, a robot that can help you with some common editorial tasks. @georgiastuart, 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/jose-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/jose-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.

Copy link
Collaborator Author

commented Jun 4, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 4, 2019

PDF failed to compile for issue #56 with the following error:

/app/vendor/bundle/ruby/2.4.0/gems/json-1.8.6/lib/json/common.rb:155:in parse': 784: unexpected token at '20 May 2019' (JSON::ParserError) from /app/vendor/bundle/ruby/2.4.0/gems/json-1.8.6/lib/json/common.rb:155:in parse'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-379fcd917139/lib/whedon/compilers.rb:106:in pdf_from_markdown' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-379fcd917139/lib/whedon/compilers.rb:12:in generate_pdf'
from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-379fcd917139/bin/whedon:56:in prepare' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/command.rb:27:in run'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in invoke_command' from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor.rb:387:in dispatch'
from /app/vendor/bundle/ruby/2.4.0/gems/thor-0.20.3/lib/thor/base.rb:466:in start' from /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-379fcd917139/bin/whedon:116:in <top (required)>'
from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in load' from /app/vendor/bundle/ruby/2.4.0/bin/whedon:23:in

'

@labarba

This comment has been minimized.

Copy link
Member

commented Jun 4, 2019

@georgiastuart, @valentina-s — Thank you for agreeing to review for JOSE! This is where the action happens: work your way through the review checklist, feel free to ask questions or post comments here, and also open issues in the submission repository as needed. Godspeed!

@saverioperugini — Our system is having problems compiling your paper. I cannot see the error. @arfon : like the other submission I just pinged you on, whedon is choking here on the date. What could be happening?

@arfon

This comment has been minimized.

Copy link
Member

commented Jun 5, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 5, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 5, 2019

PDF failed to compile for issue #56 with the following error:

Could not find data file /app/vendor/bundle/ruby/2.4.0/bundler/gems/whedon-379fcd917139/resources/jose/latex.template
Looks like we failed to compile the PDF

@arfon

This comment has been minimized.

Copy link
Member

commented Jun 5, 2019

@whedon generate pdf

@whedon

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 5, 2019

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

This comment has been minimized.

Copy link
Collaborator Author

commented Jun 5, 2019

@saverioperugini

This comment has been minimized.

Copy link

commented Jun 5, 2019

@georgiastuart

This comment has been minimized.

Copy link
Collaborator

commented Jun 11, 2019

To run in interactive mode, $ ./run -i does not work on my computer (Ubuntu). When I simply use $ ./run I get the chAmElEoN> prompt, though. Is this the intended method? @saverioperugini

@saverioperugini

This comment has been minimized.

Copy link

commented Jun 11, 2019

@georgiastuart

This comment has been minimized.

Copy link
Collaborator

commented Jun 11, 2019

Ok, great. Please update the documentation everywhere it says ./run -i to fix that.

@saverioperugini

This comment has been minimized.

Copy link

commented Jun 13, 2019

@georgiastuart

This comment has been minimized.

Copy link
Collaborator

commented Jun 13, 2019

I'm still working on verifying the functionality, but here are a couple shallow things that need to be fixed:

  1. References in the .bib don't list DOIs (see under the Software paper requirement in the checklist)
  2. I don't see any community guidelines. Did I miss them somehow? I am not as familiar with bitbucket.
@saverioperugini

This comment has been minimized.

Copy link

commented Jun 13, 2019

@georgiastuart

This comment has been minimized.

Copy link
Collaborator

commented Jun 13, 2019

I think a file of that sort would be sufficient. Here is the JOSE requirement:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.