OpenEnergyPlatform / OpenEnergyPlatform/oeplatform

[OPR] Explain the open peer review process to the user when it is started.

Open
#1,208 3 comments 0 reactions 3 assignees View on GitHub

@vismayajochem is already working on this.

Since Mar 3, 2026.

open peer review priority: high ⚡ time: M (week) 🕗
Dominant language
Python
Stars
65
Forks
29
Avg merge
15h 25m
Merged PRs (30d)
32

Description

After the reviewer has started the review, we should provide information that visually explains the entire review process as an overview.
This information must also be presented to the contributor after they have submitted data or after they pick up a review that has been conducted for one of their data sources.

In this way, we can ensure that it is understood that the process can last over a longer period of time and that several interactions between the reviewer and the contributor are necessary.

  • create a visual overview of the opr (for reviewer and contributor pov)
  • implement visualisation in oep and show it when either the reviewer or contributor collaborates on a reviewe (show it only once per review.
  • In general, add helper text to any ui element if necessary

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.