From 1ed126c2425ec00976e759bc48e7c4fe5b616c89 Mon Sep 17 00:00:00 2001 From: Tim Golen Date: Mon, 28 Oct 2024 10:14:11 -0600 Subject: [PATCH 1/4] Add the bugzero checklist as a MD file --- contributingGuides/BUGZERO_CHECKLIST.md | 61 +++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 contributingGuides/BUGZERO_CHECKLIST.md diff --git a/contributingGuides/BUGZERO_CHECKLIST.md b/contributingGuides/BUGZERO_CHECKLIST.md new file mode 100644 index 0000000000000..4c33a8ef12e19 --- /dev/null +++ b/contributingGuides/BUGZERO_CHECKLIST.md @@ -0,0 +1,61 @@ +# BugZero Checklist: + +- [ ] [Contributor] Classify the bug: + +
+Bug classification + +Source of bug: + - [ ] 1a. Result of the original design (eg. a case wasn't considered) + - [ ] 1b. Mistake during implementation + - [ ] 1c. Backend bug + - [ ] 1z. Other: + +How bug was reported: + - [ ] 2a. Reported on production + - [ ] 2b. Reported on staging (deploy blocker) + - [ ] 2c. Reported on a PR + - [ ] 2z. Other: + +Who reported the bug: + - [ ] 3a. Expensify user + - [ ] 3b. Expensify employee + - [ ] 3c. Contributor + - [ ] 3d. QA + - [ ] 3z. Other: + +
+ +- [ ] [Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. + + Link to comment: + +- [ ] [Contributor] If the regression was CRITICAL (eg. interrupts a core flow) A discussion in [#expensify-open-source](https://app.slack.com/client/E047TPA624F/C01GTK53T8Q) has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. + + Link to discussion: + +- [ ] [Contributor] If it was decided to create a regression test for the bug, please propose the [regression test](https://github.com/Expensify/App/blob/main/contributingGuides/REGRESSION_TEST_BEST_PRACTICES.md) steps using the template below to ensure the same bug will not reach production again. + +
+Regression Test Proposal Template + + +- [ ] [BugZero Assignee] Create a GH issue for creating/updating the regression test once above steps have been agreed upon. + + Link to issue: + +## Regression Test Proposal +### Precondition: + + +- + +### Test: + + +1. + +Do we agree 👍 or 👎 + + +
From 4e05c648d865ba2d0de2694ed0a04508701b03f1 Mon Sep 17 00:00:00 2001 From: Tim Golen Date: Mon, 28 Oct 2024 10:17:44 -0600 Subject: [PATCH 2/4] Add some more instructions to the classification --- contributingGuides/BUGZERO_CHECKLIST.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/contributingGuides/BUGZERO_CHECKLIST.md b/contributingGuides/BUGZERO_CHECKLIST.md index 4c33a8ef12e19..d3ab11399dfc1 100644 --- a/contributingGuides/BUGZERO_CHECKLIST.md +++ b/contributingGuides/BUGZERO_CHECKLIST.md @@ -4,6 +4,7 @@
Bug classification + Source of bug: - [ ] 1a. Result of the original design (eg. a case wasn't considered) @@ -11,7 +12,7 @@ Source of bug: - [ ] 1c. Backend bug - [ ] 1z. Other: -How bug was reported: +Where bug was reported: - [ ] 2a. Reported on production - [ ] 2b. Reported on staging (deploy blocker) - [ ] 2c. Reported on a PR From f1e20914e4a9f3065457048e6a396fa0c841b0ad Mon Sep 17 00:00:00 2001 From: Tim Golen Date: Mon, 28 Oct 2024 10:20:22 -0600 Subject: [PATCH 3/4] Make some of the text bold to stand out more --- contributingGuides/BUGZERO_CHECKLIST.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/contributingGuides/BUGZERO_CHECKLIST.md b/contributingGuides/BUGZERO_CHECKLIST.md index d3ab11399dfc1..da69bc21f1938 100644 --- a/contributingGuides/BUGZERO_CHECKLIST.md +++ b/contributingGuides/BUGZERO_CHECKLIST.md @@ -1,6 +1,6 @@ # BugZero Checklist: -- [ ] [Contributor] Classify the bug: +- [ ] **[Contributor]** Classify the bug:
Bug classification @@ -27,21 +27,21 @@ Who reported the bug:
-- [ ] [Contributor] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. +- [ ] **[Contributor]** The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment: -- [ ] [Contributor] If the regression was CRITICAL (eg. interrupts a core flow) A discussion in [#expensify-open-source](https://app.slack.com/client/E047TPA624F/C01GTK53T8Q) has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. +- [ ] **[Contributor]** If the regression was CRITICAL (eg. interrupts a core flow) A discussion in [#expensify-open-source](https://app.slack.com/client/E047TPA624F/C01GTK53T8Q) has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: -- [ ] [Contributor] If it was decided to create a regression test for the bug, please propose the [regression test](https://github.com/Expensify/App/blob/main/contributingGuides/REGRESSION_TEST_BEST_PRACTICES.md) steps using the template below to ensure the same bug will not reach production again. +- [ ] **[Contributor]** If it was decided to create a regression test for the bug, please propose the [regression test](https://github.com/Expensify/App/blob/main/contributingGuides/REGRESSION_TEST_BEST_PRACTICES.md) steps using the template below to ensure the same bug will not reach production again.
Regression Test Proposal Template -- [ ] [BugZero Assignee] Create a GH issue for creating/updating the regression test once above steps have been agreed upon. +- [ ] **[BugZero Assignee]** Create a GH issue for creating/updating the regression test once above steps have been agreed upon. Link to issue: From 0b1623e8b29c1ad3f150ccde98ad5ef4e191b47a Mon Sep 17 00:00:00 2001 From: Tim Golen Date: Mon, 28 Oct 2024 15:07:05 -0600 Subject: [PATCH 4/4] Update contributingGuides/BUGZERO_CHECKLIST.md Co-authored-by: Youssef Lourayad --- contributingGuides/BUGZERO_CHECKLIST.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributingGuides/BUGZERO_CHECKLIST.md b/contributingGuides/BUGZERO_CHECKLIST.md index da69bc21f1938..00075620641ca 100644 --- a/contributingGuides/BUGZERO_CHECKLIST.md +++ b/contributingGuides/BUGZERO_CHECKLIST.md @@ -31,7 +31,7 @@ Who reported the bug: Link to comment: -- [ ] **[Contributor]** If the regression was CRITICAL (eg. interrupts a core flow) A discussion in [#expensify-open-source](https://app.slack.com/client/E047TPA624F/C01GTK53T8Q) has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. +- [ ] **[Contributor]** If the regression was CRITICAL (e.g. interrupts a core flow) A discussion in [#expensify-open-source](https://app.slack.com/client/E047TPA624F/C01GTK53T8Q) has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion: