Skip to content
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

content: clarify review process #191

Merged
merged 1 commit into from
Apr 25, 2024
Merged

content: clarify review process #191

Show file tree
Hide file tree
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
8 changes: 4 additions & 4 deletions content/docs/guides/contribute/review-process.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Here's a suggested workflow.

**It is necessary to communicate via instant messaging (Matrix, Slack, etc.) in order to guarantee the smooth flow of PR validation.**
**It can be useful to communicate via instant messaging (Matrix, Slack, etc.) in order to guarantee the smooth flow of PR validation.**

```mermaid
sequenceDiagram
Expand All @@ -11,10 +11,10 @@ sequenceDiagram
R->>A: Answers yes or no

loop Loop between author and reviewer
R-->>+A: Comments, asks for changes
R-->>A: Comments, asks for changes
shenriotpro marked this conversation as resolved.
Show resolved Hide resolved
A-->>R: Answers to comments or requested changes
A-->>-R: Makes necessary changes in dedicated "fixups"
R-->>A: Reviews changes
A-->>R: Makes necessary changes in dedicated "fixups"
R-->>A: Reviews, tests changes, and comments again
R-->>A: Resolves requested changes/conversations if ok
end

Expand Down
10 changes: 5 additions & 5 deletions content/docs/guides/contribute/review-process.fr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Voici une proposition de flux de travail.

**Il est nécessaire de communiquer par messagerie instantanée (Matrix, Slack, etc.) afin de garantir le fonctionnement du flux de la validation d'une PR.**
**Il peut être utile de communiquer par messagerie instantanée (Matrix, Slack, etc.) afin de garantir le fonctionnement du flux de la validation d'une PR.**

```mermaid
sequenceDiagram
Expand All @@ -12,14 +12,14 @@ sequenceDiagram

loop Boucle entre auteur et reviewer
R-->>A: Commente, demande des changements
A-->>R: Répond à chaque commentaire/requested changes
A-->>R: Répond à chaque commentaire/demande de changement
A-->>R: Corrige le code si nécessaire dans des « fixups » dédiés
R-->>A: Vérifie et commente à nouveau le code
R-->>A: Résoud les conversations/requested changes le cas échéant
R-->>A: Vérifie, teste, et commente à nouveau le code
R-->>A: Résout les conversations/demandes de changement le cas échéant
shenriotpro marked this conversation as resolved.
Show resolved Hide resolved
end

A->>R: Rebase si nécessaire
R->>A: Vérifie l'historique des commits
R->>A: Approuve ou ferme la PR
Note left of R: Et fusionne si mainteneur
```
```
Loading