Skip to content

Conversation

@viveksinghggits
Copy link
Contributor

Summary

Adding why a particular PR is needed, is important in PR desc. This help reviewers understand the PR better.
This PR encourages authors to do that by updating the PR template.

Proof of Work

NA

@viveksinghggits viveksinghggits added the skip-changelog Use this label in Pull Request to not require new changelog entry file label Oct 20, 2025
@viveksinghggits viveksinghggits marked this pull request as ready for review October 20, 2025 20:07
@viveksinghggits viveksinghggits requested a review from a team as a code owner October 20, 2025 20:07
@github-actions
Copy link

⚠️ (this preview might not be accurate if the PR is not rebased on current master branch)

MCK 1.6.0 Release Notes

New Features

  • MongoDBCommunity: Added support to configure custom cluster domain via newly introduced spec.clusterDomain resource field. If spec.clusterDomain is not set, environment variable CLUSTER_DOMAIN is used as cluster domain. If the environment variable CLUSTER_DOMAIN is also not set, operator falls back to cluster.local as default cluster domain.
  • Helm Chart: Introduced two new helm fields operator.podSecurityContext and operator.securityContext that can be used to configure securityContext for Operator deployment through Helm Chart.

Bug Fixes

  • Fixed parsing of the customEnvVars Helm value when values contain = characters.

# 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

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

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

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

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-changelog Use this label in Pull Request to not require new changelog entry file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants