Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Add note in the Contributing guide about linking issues to a PR #32174

Merged
merged 6 commits into from
Apr 12, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ Because we will only merge a Pull Request for which all tests pass. The followin

If you have missed a step, don't worry, the Continuous Integration will run a thorough test on your commits and the maintainers of the project can assist.

Additionally, if your pull request is aimed towards resolving a certain problem for which there's an open issue, make sure to link the PR to that issue.
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved
You can do that by using any [supported GitHub keyword](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) in the PR description.
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved
Not only this makes it easier to understand the motivation behind the PR as it also automatically closes the issue once the PR is merged.
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved

#### Checks and how to fix them

If any of the checks fails click on the _Details_
Expand Down