-
Notifications
You must be signed in to change notification settings - Fork 1.5k
remove redundant fields from KEP issue template #5293
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
base: master
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: jenshu The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
The simplest solution would be to have all PRs reference the KEP issue with Instead, what people currently do is put some reference to the KEP (link to issue or link to README - we don't have good guidance for it) into the opaque "Additional documentation" section: If I could choose, I would drop that entire "Additional documentation" section. I don't think it is used consistently enough to be useful and creates additional work for those who haven't given up on it yet. If we want the KEP link, then it can be found also through the |
@pohly Agreed, ideally all PRs would mention the KEP issue number in the PR description. What do you think if we make a modification to the k/k PR template here that says you either use |
I think I've seen "Related-to" more often than "Related to". That aside, I think we can tweak that template slightly without making it longer. I wouldn't mention KEPs specifically.
I've removed the Markdown markup inside the comment block. It doesn't get rendered and "._*" at the end of the last line just looked odd. |
@pohly what do you think of the changes here: kubernetes/kubernetes#131944 I didn't explicitly mention "Related-to" since technically the words coming before the issue link can be anything besides the reserved words here https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword |
The KEP issue description often gets out of date, either due to people forgetting to update it or not having edit permissions. This can sometimes cause confusion for the release team since there may be conflicting info between the issue description and other issue fields / KEP files. Removed some of the redundant fields from the template:
sig/node
etc), and the "primary" SIG can be found from the KEP file path (e.g.keps/<sig>/NNNN-kep-name/...
)kep.yaml
.It would be good to eventually get rid of the per-stage list of PRs, but would need to think through a good workflow for ensuring all relevant PRs for the milestone get linked to the issue.
cc @kikisdeliveryservice
Related to #5124