Skip to content

Commit

Permalink
Update CONTRIBUTING to clarify the need to link PRs to issues
Browse files Browse the repository at this point in the history
Update CONTRIBUTING to clarify the need to link PRs to issues
  • Loading branch information
benjagm authored Apr 15, 2024
1 parent 11471ab commit c683d97
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit c683d97

Please sign in to comment.