Docs: Add "Related Issues" section in the PR template - Githubissues

petermsouzajr / qa-shadow-report

Streamline your team's testing workflow with qa-shadow-report, an open-source tool that automatically consolidates Cypress & Playwright test data into Google Sheets or CSV for enhanced visibility and team collaboration.

https://www.npmjs.com/package/qa-shadow-report

MIT License

5 stars 5 forks source link

Docs: Add "Related Issues" section in the PR template #47

Closed adiati98 closed 9 months ago

adiati98 commented 9 months ago

Description

When I created an issue, I don't see a section to link the issue that related to the PR. I added it manually in the PR.

Linking a PR to an issue will give below benefits:

Clean organization: It's easier for maintainers to track the progress and history of the project because every PR is linked to an issue.
Automation: Maintainers don't have to close issues manually after they close PRs. This will save them time and increase productivity.

Here is a resource about linking a PR to an issue.

Suggested solution

In the PR template:

Add a section — you can call it "Related Issues" or anything you want — to link the related issue.
In the section, add a comment out instructions to link the issue. Something like:

Add the prefix "Closes", "Fixes", or "Resolves" followed by the related issue number. For example, "Closes #123"

adiati98 commented 9 months ago

Sorry, when I created a PR, there wasn't a section for this, so I created an issue. Just realized that it's been resolved. 🙂👍