CODECHECK community workflow for editors

See also the CODECHECK community workflow overview and discuss your issues.

Editor tasks

The main tasks for the CODECHECK editor are assigning and assisting (mentoring) codecheckers, and validating the publication of the certificate and all metadata.

When a new issue is assigned to a codecheck editor in the register, here are a few things you need to do.

  1. First checks
    • Briefly check the submitted repository - does the workflow look at all codecheckable?
    • Ensure that a preprint is linked or a real manuscript is published within the repository, or that a reference to a journal submission is provided to which you have contacts.
    • Make sure the author has completed the required author tasks.
  2. Manage CODECHECK workflow
    • Edit the first comment of the issue and add the next available Certificate identifier in YYYY-NNN format by checking existing open issues with id assigned for the next available number; add the badge id assigned to the issue.
    • Find a codechecker and invite them by @-mentioning in the register issue. Remove the needs codechecker label when you found one who accepted the task. Good job so far!
    • Use the following labels to document the current state of the check: work in progress, metadata pending
    • Support the codechecker as needed (sent reminders, technical support, mediate between author and codechecker, et cetera); all communication should happen within the GitHub issue on the register unless there are sensitive information to share.
    • Ensure that a reference to the certificate is/will be added to the manuscript.
  3. Certificate publication and register
    • Wait until the article is published in a citable form.
    • Ask the codechecker to update all required metadata in the codecheck.yml and update the certificate report (especially the final DOIs!); double-check the information in the metadata and the actual certificate; wait until the certificate is published with its own DOI.
      • Alternatively, you may make edits to the metadata in the forked repository yourself, request write access to the OSF repository to edit the metadata, or handle edits via Zenodo yourself (metadata editing in CODECHECK community, or even at the stage of a shared draft of a Zenodo record).
    • Trigger a rebuild of the register by adding the CODECHECK to the register.csv file; you may add a closes #N statement in the commit message to close the isue.
    • Clear up the labels of the register issue - all labels except the community/journal/conference/workshop should be removed.
    • “Archive” the repository clone in the codecheckers organisation on GitHub/the cdchk organisation on GitLab (instructions for GitHub, instructions for GitLab)
    • Close the issue on the register.