-
Couldn't load subscription status.
- Fork 43
chore: Add KEP to the supported PR titles #66
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
Conversation
Signed-off-by: Saad Zaher <szaher@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
Pull Request Test Coverage Report for Build 17143541281Details
💛 - Coveralls |
Signed-off-by: Saad Zaher <szaher@redhat.com>
| fix | ||
| feat | ||
| revert | ||
| KEP |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we really need it? I think we should use feat: KEP-NN
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say yes, KEP is different from features. features are new features that we introduce to the sdk but KEP is a proposal or enhancement proposal.
| ci | ||
| docs | ||
| examples | ||
| proposals |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can just use feat(docs): KEP-NN for that
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
proposal are not really docs... wDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I kind of agree with @kramaranya, we can use (docs) scope for KEPs. Otherwise, we can just to feat: KEP-nn, since scope is not required.
I would like us to keep feat, fix in the title name since it is easier to group them in CHANGELOG later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if we use feat it will be confusing to users or whoever reads the changelog or release notes. Users would assume this feature is already implemented as the release notes mentions it as one of the PRs.
If we add KEP it clearly signals this is a TODO or planned feature...
feat: Local Execution >>> contains KEP
feat: Local Execution >>> Actual implementation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, but we can group them in the dedicated subsection in the CHANGELOG, like we did here:
https://github.com/kubeflow/trainer/blob/master/CHANGELOG.md#llm-trainer-v2
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, KFP also uses docs prefix for KEPs: kubeflow/pipelines#11551
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we add the KEP type I think it will be consistent with the following.

which I believe is cleaner.
With KEP type
KEP 2: Local execution
feat: Local execution
Without KEP type (Current Behaviour)
docs: KEP-2 Local exection
feat: Local execution
Which one do you think is cleaner?
I believe we can group both or leave both in the release notes in the respective sections
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I suggest that we use feat: and fix: prefix, and we add the KEP number after.
E.g.:
feat: KEP-2 - Add local backend for KF Trainer
fix: KEP-2 - Update the runtime return type
chore: KEP-2 Add unit tests for utils
Since that will be simpler to group fixes, chores, and features dedicated to the particular KEP.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with @andreyvelich, that would be much cleaner. Also, if we add a KEP prefix, it could confuse contributors, and they might end up using both options:
feat: KEP-NN - ...
KEP-NN: ...
So I think it’s better to stick with one clear format to keep it consistent
What this PR does / why we need it:
SDK PRs needs to support a new type for proposals
Which issue(s) this PR fixes (optional, in
Fixes #<issue number>, #<issue number>, ...format, will close the issue(s) when PR gets merged):Fixes #
Checklist: