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

Add automated checking of code repository to help codecheckers or (CODECHECK) editors #24

Open
nuest opened this issue May 3, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@nuest
Copy link
Member

nuest commented May 3, 2021

Let's try to capture some steps of the human evaluation process in a tool so that we can "pre-check" the contents of a workflow repository:

  • Is there a README?
  • Is there a license?
  • Does the README mention the figures and tables from the paper (clear connection between outputs and code files)?
  • Is there an environment documentation or file (cf. repo2docker REES spec)
  • Do all links (and DOIs) resolve?
  • Are execution times mentioned in the README?
  • If HPC is mentioned, is a sample dataset also mentioned?
  • Are any full paths in documentation or code files (/home/.., C:\Users\.., etc.)
  • ...

Tools that show how the interaction could work:

@nuest nuest added the enhancement New feature or request label May 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant