Skip to content

Reviewer Guidelines

Stuart Chalk edited this page Jan 22, 2024 · 2 revisions

Guidelines for reviewers to review new contributions are as follows:

  • Must be submitted by a PR, either from:
    • the contributing author
    • an admin submitting the contribution on behalf of an author that provided files to a contribution issue.
  • Content
    • At the top of each file, right after the title (Markdown top level header) a metadata dropdown with the following fields
      • Author: Author of the contribution with ORCID
      • Reviewer: Empty entry that will be populated by the admin adding the recipe to the Cookbook
      • Topics: A list of important topics that outlined in the recipe
      • Format: Markdown file OR Jupyter Notebook OR other?
      • Scenarios: (optional) when might someone need to use this recipe
      • Skills: Skills that the reader should have before looking at a recipe to get the best out of it
      • Learning Outcomes: What the reader will learn from this recipe
      • Citation: Standard citation provided by the admin and including a W3ID
      • Reuse: Statement relative to the reuse of the recipe. Defaults to CC BY-SA.
    • Free of typos and using appropriate descriptive language in English
    • Uses appropriate header levels and thus navigation (right side on website)