Skip to content

Make pr-template easier to use #2

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.

Sign up for GitHub

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

Closed
PieterjanDeClippel wants to merge 2 commits into from
Closed

Make pr-template easier to use #2

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f14b6c3
Update PULL_REQUEST_TEMPLATE.md
PieterjanDeClippel May 15, 2025
9b102a9
Test
PieterjanDeClippel Jun 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,8 @@ This PR [adds/removes/fixes/replaces] the [feature/bug/etc].
-->

## Related Tickets & Documents
<!--
Please use this format link issue numbers: Fixes #123
https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword
-->
- Closes #

@gemini-code-assist gemini-code-assist Bot May 15, 2025

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This change definitely makes the template visually cleaner by removing the HTML comment block, which is a good step towards making it easier to use at first glance!

However, by removing the previous example format (e.g., Fixes #123) and the direct link to the GitHub documentation, we might be losing some valuable guidance. This information can be particularly helpful for newer contributors or those less familiar with all the available issue linking keywords (Closes, Fixes, Resolves, etc.) and how to link multiple issues effectively.

While - Closes # is very direct, it's a bit prescriptive (focusing only on Closes) and doesn't guide users to learn more if they need to. The original link provided comprehensive information on this GitHub feature.

What are your thoughts on a middle ground that keeps the section concise but retains the essential guidance? For example, something like the suggestion below, which is still a single line and not hidden in a comment, but offers more flexibility and a path to further information:

Suggested change
- Closes #
- Link issues using keywords like Closes #, Fixes #, Resolves #. [More info](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue)



## Screenshots/Recordings

Expand Down