Skip to content

Adjust documentation on Pull Request reviewing #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
freddidierRTE merged 1 commit into from
Sep 10, 2026
Merged

Adjust documentation on Pull Request reviewing #50

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions Workflow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,26 @@ The Pull request must pass all tests and checks before being allowed to merge.

The pull request must be reviewed and approved by at least one person, and by a code owner before being allowed to merge. As the process of defining code owners is still in progress, the last point applies only for repositories with a CODEOWNERS file.

Owner reviews are not necessarily full functional reviews: for small changes an owner may simply give a formal approval. For larger contributions (new components, API changes, architectural decisions), the review may be more thorough.

The code owner is not expected to verify that the code behaves as intended, but rather to check that it is well structured, maintainable, and consistent with the rest of the codebase. Consequently, the owner is not expected to read the code line by line, but rather to assess its overall structure and the design decisions made. For small changes, the owner may simply give a formal approval. For larger contributions (new components, API changes, architectural decisions), the review may be more thorough.


The lifecycle of a pull request is as follows:

1. **Author** — when your PR is ready for review, add the **`waiting-for-review`**
1. **Author** — when your PR is ready and has been reviewed by another developer, add the **`waiting-for-review`**
label. This is the signal that it is ready to be picked up by an owner.
2. **Owner assignment** — an owner picks up the PR, **removes** the
`waiting-for-review` label, and **assigns themselves** to it.
3. **Approvals** — the PR needs two approvals to be mergeable:
- one from **another developer**, and
- one from the **owner**.
- one from an **owner**.
4. **Merge** — once both approvals are in, the **author (developer) can merge**
the pull request.


The approval of another owner is not required if the author or the reviewer is an owner.


## Build and Test

All repositories are configured to build, run unit tests, and perform checks on pull requests using GitHub Actions.
Expand Down