From c683d97b3b6b90e0e648202ccb3e0387d79f8519 Mon Sep 17 00:00:00 2001 From: Benjamin Granados <40007659+benjagm@users.noreply.github.com> Date: Tue, 16 Apr 2024 00:30:05 +0200 Subject: [PATCH 1/2] Update CONTRIBUTING to clarify the need to link PRs to issues Update CONTRIBUTING to clarify the need to link PRs to issues --- CONTRIBUTING.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6e882562c..88cf4de58 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,9 +70,14 @@ If you would like to contribute with designs, we encourage you to join `#design` ### ⌨️ Pull requests -We welcome pull requests for editorial suggestions and resolving open issues. +We welcome pull requests for editorial suggestions and for resolving open issues. -If the pull request would solve a particular issue, reference the issue in the pull request description using a [supported descriptor](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) that will automatically close that issue. +If your pull request addresses a specific issue, please reference this issue in your pull request description using a [supported descriptor](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). This helps automatically link and close the issue when the pull request is merged. + +We strongly encourage linking every pull request to an existing issue. If no corresponding issue exists, please create one first. This allows the community to discuss the required changes. If you are addressing an existing issue, ensure the scope is clear and consider the following: + +- If the issue is several years old, verify its relevance by asking in the comments. +- Ensure the discussion within the issue has led to a clear, actionable decision. Generally, pull requests should be made to the `main` branch. From 9332c1bc369bc55ef94746b20e43aa1937fe57b2 Mon Sep 17 00:00:00 2001 From: Benjamin Granados Date: Tue, 16 Apr 2024 00:31:44 +0200 Subject: [PATCH 2/2] Fix wording --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 88cf4de58..75a3a9d1e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,7 @@ If you would like to contribute with designs, we encourage you to join `#design` ### ⌨️ Pull requests -We welcome pull requests for editorial suggestions and for resolving open issues. +We welcome pull requests for editorial suggestions and resolving open issues. If your pull request addresses a specific issue, please reference this issue in your pull request description using a [supported descriptor](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). This helps automatically link and close the issue when the pull request is merged.