Skip to content

Reviewing for ACCESS-Hive

Any member of the ACCESS-Hive Github Community (to join) can join the reviewers team. Please ask one of the maintainers to invite you to join the reviewers team.

Reviewer Guidelines

Firstly, thank you so much for helping to review links submitted to the ACCESS-Hive, we’re delighted to have your help. This document is designed to outline our editorial guidelines and help you understand our requirements for accepting a pull request (PR).

Guiding principles

If the submitting authors have followed the contribution guidelines then the review should be rapid. An important requirement is the ACCESS-Hive is a portal to documentation, it does not host the documentation itself.

For those PRs that don’t quite meet the requirements, please try to give clear feedback on what needs fixing. Our goal is to maintain a high quality platform for exchanging links to relevant documentation and you, as a reviewer, have a key role to play.

A review involves checking submissions against a checklist of essential features and details described at the top of each PR. This should be objective, not subjective; it should be based on the materials in the submission as perceived without distortion by personal feelings, prejudices, or interpretations.

Some continuous tests such as hyperlink references checks and preview deployments are automatically triggered by submitting a PR.

Reviewers should:

  1. Ensure that the tests are passing without errors.
  2. Do a visual check using the preview.
  3. Do a Github pull request review. See GitHub's extensive documentation
  4. Once you have approved the PR. Tag the editors team @ACCESS-Hive/editors in the discussion.

We encourage reviewers to provide feedback from within the PR discussion.

You can include in your review links to any new issues that you the reviewer believe to be impeding the acceptance of the pull request.

Last update: May 31, 2023
Created: May 31, 2023