From 76f10db290b9f3408b55a1d49246ad6a6909214d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tiago=20Ara=C3=BAjo=20=5BSSW=5D?= Date: Thu, 17 Oct 2024 21:20:58 -0700 Subject: [PATCH] Improved rule reading "merge-debt" --- rules/merge-debt/rule.md | 31 ++++++++++++++++++++++--------- 1 file changed, 22 insertions(+), 9 deletions(-) diff --git a/rules/merge-debt/rule.md b/rules/merge-debt/rule.md index fc178216bc..d005803bb3 100644 --- a/rules/merge-debt/rule.md +++ b/rules/merge-debt/rule.md @@ -16,6 +16,7 @@ authors: url: https://ssw.com.au/people/adam-cogan related: - over-the-shoulder + - tofu redirects: [] created: 2023-08-14T00:00:00.000Z archivedreason: null @@ -29,19 +30,31 @@ When a pull request is left open for a long time, it becomes stale and accumulat `youtube: https://www.youtube.com/watch?v=SJdq7mLGdgA` **Video: Merge Debt | Matt Goldman & Luke Cook | Rules (16 min)** -If you are in a team (i.e. an internal contributor), it is the PR author's responsibility to get a PR reviewed and action feedback ASAP. -**Tip:** For internal contributors, it's a good idea to have a [call with the PR reviewers](/over-the-shoulder). +Merge debt can be avoided by: + +* Ensuring PRs don't stay open for too long - you could use [SSW Dory](https://www.sswdory.com) to automatically inform you of any outstanding PRs +* Conducting daily reviews on repos to ensure all PRs that can be merged are merged +* Ensuring that once a PR is ready to be merged, an ["over the shoulder" review](/over-the-shoulder) occurs +* Following the Single Responsibility Principle (SRP) - if a PR covers multiple tasks, it is harder to review and can create more problems + +## Internal contributors + +If you are in a team (i.e. an internal contributor) it is the PR author's responsibility to get a PR reviewed and action feedback ASAP. + +::: greybox +**Tip:** For internal contributors, it's a good idea to have a call with the PR reviewers. +::: + +## Outside contributors If you are **not** part of the team (i.e. an outside contributor), reviewing the PR is the responsibility of the Repo maintainers. Actioning the feedback is still the responsibility of the PR author. + +::: greybox **Tip:** For outside contributors, it's a good idea to chase the reviewers by reaching out with a comment on GitHub, or through the repo's community (e.g. Discord channels). +::: + +--- ::: info **Note:** Remember that before declaring a task 'Done' with a link, your [changes should be live](/include-links-in-emails/#ensure-your-changes-are-live) for verification. ::: - -Merge debt can be avoided by: - -* Ensuring PRs don't stay open for too long - you could use [SSW Dory](https://www.sswdory.com) to automatically inform you of any outstanding PRs -* Conducting daily reviews on repos to ensure all PRs that can be merged are merged -* Ensuring that once a PR is ready to be merged, an [over-the-shoulder](/over-the-shoulder) review occurs -* Following the Single Responsibility Principle (SRP) - if a PR covers multiple tasks, it is harder to review and can create more problems