Skip to content

Commit

Permalink
doc: add details about review workflow
Browse files Browse the repository at this point in the history
Add Mermaid chart to explain the review workflow with alpha and beta builds, and also between dev, a11y, Q/A and design teams

Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
  • Loading branch information
pylapp committed Jul 19, 2024
1 parent c9e25fe commit 4162650
Showing 1 changed file with 31 additions and 1 deletion.
32 changes: 31 additions & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ Feature requests are welcome. But take a moment to find out whether your idea fi

## Pull requests

Good pull requestspatches, improvements, new featuresare a fantastic help. They should remain focused in scope and avoid containing unrelated commits.
Good pull requests (patches, improvements, new features) are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

**Please ask first** before embarking on any **significant** pull request (e.g. implementing features, refactoring code, porting to a different language), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project. For trivial things, or things that don't require a lot of your time, you can go ahead and make a PR.

Expand Down Expand Up @@ -142,6 +142,36 @@ Signed-off-by: First author firstname and lastname <first author email>
Signed-off-by: Second author firstname and lastname <second author email>
```

## Review workflow

Because we want to define and provide an amazing design system for developers, we want to onboard for any evolutions the Q/A team for tests and also the design ans accessibiltiy (a11y) teams so as to check the fixes, patches or evolutions have been well implemented and tested.

The following chart explain how the review is done with also the intermediate alpha builds.
In few words, alpha builds are made for reviewers, and the merge is processed if and only if any review have been done.
The [task-list-completed GitHub app](https://github.com/apps/task-list-completed) prevents pull requests to be merged if some mandatory / not optional prerequisites are not filled.

```mermaid
flowchart TD
A[New evolution needed, feature or bug fix] --> |Define needs and acceptance criteria| B(Create issue on GitHub)
B --> C(Implementation or refactoring in GitHub branch)
C --> |Code review| D{Code review OK?}
D --> |No| C
D --> |Yes| E(Build alpha version on TestFlight)
E --> F(Update GitHub issue with details of alpha build)
F --> G{Feature ready for review}
G --> |Test of feature| H{Tests OK?}
H --> |No| C
G -->|Design review| I{Design review OK?}
I --> |No| C
G -->|A11Y review| J{A11Y review OK?}
J --> |No| C
H --> |Yes| K
I --> |Yes| K
J --> |Yes| K
K[Merge in develop branch] --> |Nightly build| L(Beta build on TestFlight)
L --> M(Update GitHub issue with details of beta build)
```

## License

By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).

0 comments on commit 4162650

Please sign in to comment.