From a9b0e7a637346af7d77e917db1568fe172e3b0c0 Mon Sep 17 00:00:00 2001 From: Samuel Hawksby-Robinson Date: Wed, 13 Mar 2024 23:28:34 +0000 Subject: [PATCH] Added report or fix flowchart --- _docs/policies/tests.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/_docs/policies/tests.md b/_docs/policies/tests.md index d0abb3787..d7785779c 100644 --- a/_docs/policies/tests.md +++ b/_docs/policies/tests.md @@ -35,6 +35,21 @@ Determine who caused the flaky test. - If the test does not appear in https://github.com/status-im/status-go/labels/E%3AFlaky%20Test or in the last three nightly test runs, it is most likely that the flakiness was introduced by your changes and needs to be addressed before proceeding with the merge. - Else the test is already documented as a flaky test (appears in the GitHub issues or in the nightly test runs), proceed to below. +```mermaid +flowchart TB + A[PR ready for merge] --> B{Have any test failed?} + B -->|No| C[🎉 Proceed with merge 🪄] + B -->|Yes| D{Did you write the test for this PR?} + D -->|No| E[Check rerun reports.] + D -->|Yes| F[You MUST fix the test before merge is acceptable.] + F --> A + E --> G{Does the test appear in `E:Flaky Test` issues
or in the last three nightly test runs?
} + G -->|Yes| I[The flakiness MUST be reported] + G -->|No| H[It is likely your changes introduced the flakiness] + H --> F + I --> J[Proceed to Reporting flow] +``` + #### Reporting Flaky Tests - If an old test fails and/or seems flaky either locally or in CI, you MUST report the event. - Check the `status-go` GitHub repo issues for the test name(s) failing. @@ -51,3 +66,4 @@ Determine who caused the flaky test. - The issue title should include the flaky test name - The issue should use the https://github.com/status-im/status-go/labels/E%3AFlaky%20Test label - Detail that you have experienced the test being flaky and in what context (local vs CI, link to the PR or branch). +