Skip to content

Recommend to have why in PR desc #540

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Recommend to have why in PR desc #540

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Summary

<!-- Enter your issue summary here.-->
<!-- Enter your PR summary here. Try to emphasize on WHY this change is needed, followed by what's being done in the PR.
Copy link
Collaborator

@Julien-Ben Julien-Ben Oct 22, 2025

Choose a reason for hiding this comment

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

As a template, I think it should be much more concise. The first line is enough IMO.

Jira tickets are already mentioned in the Checklist

Copy link
Contributor

@anandsyncs anandsyncs Oct 23, 2025

Choose a reason for hiding this comment

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

I have a similar question, is this a substitution for absence of JIRA ticket in the PR?

Copy link
Contributor Author

@viveksinghggits viveksinghggits Oct 23, 2025

Choose a reason for hiding this comment

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

So the point that @Julien-Ben raised is different from the question that you have @anandsyncs.

@Julien-Ben's point was we don't have to mention This is not a replacement for creating jira tickets. this line because we already have have a check box in our PR template checklist for the jira ticket and that would mean a jira ticket is required.

And I think what you are asking is, if you mention why in PR desc, do you not have to create jira ticket anymore. And we knew that people might get into that confusion, that's why I explicitly mentioned, having why in PR desc doesnt mean that you don't have to create the respective jira ticket.

Copy link
Contributor

@lsierant lsierant Oct 28, 2025

Choose a reason for hiding this comment

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

+1, let's keep "Enter your PR summary here. Try to emphasize on WHY this change is needed, followed by what's being done in the PR."
the rest is a bit obvious

Doing this will help reviewers understand the PR better and it will be easier for them to review the PR.
This is not a replacement for creating jira tickets. -->

## Proof of Work

Expand Down