Skip to content

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

Description

@nuest

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:

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions