Skip to content
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

Create PULL_REQUEST_TEMPLATE.md #2554

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Pull Request Description
Copy link
Contributor

Choose a reason for hiding this comment

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

I think heading level 1 might be too big? I think it might be better with like level 3 or 4?

- KEP-< ISSUE NUMBER >: < KEP NAME >
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we also add a note here to link the k/enhancements issue instead of typing out the number? I think having the link would be a lot useful in the description :)

Copy link
Author

Choose a reason for hiding this comment

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

Yeah good idea!

Choose a reason for hiding this comment

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

I'd rather we just add a line following this one with :

Issue link:

- One-line PR description: <!-- short description of work done in PR e.g. updating milestone, adding new KEP, adding test requirements… -->

_Please use the following format when naming your PR: **< Issue Number >:< Issue Description >** (e.g. KEP-000: adding beta graduation criteria)_
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure if we want to make this visible or make it a comment. what do you think @kikisdeliveryservice?

Choose a reason for hiding this comment

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

I think make it a comment