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 a PR template for the website #3936

Open
varodrig opened this issue Dec 1, 2024 · 11 comments · May be fixed by #3965
Open

Create a PR template for the website #3936

varodrig opened this issue Dec 1, 2024 · 11 comments · May be fixed by #3965
Assignees

Comments

@varodrig
Copy link
Contributor

varodrig commented Dec 1, 2024

Create a PR template for the website to required information and pre-reqs are done before PR is submitted.

After reviewing some of the 79 PRs pending, https://github.com/kubeflow/website/pulls , I noticed some PR were missing the commits sign off

Reference:

https://github.com/kubeflow/pipelines/blob/master/.github/pull_request_template.md

@varodrig
Copy link
Contributor Author

varodrig commented Dec 1, 2024

@hbelmiro anyone else to comment on this issue?
@andreyvelich

@hbelmiro
Copy link
Contributor

hbelmiro commented Dec 2, 2024

Sounds good to me.
I think Andrey is enough.

@andreyvelich
Copy link
Member

That sounds good to me @varodrig.
Any ideas on how we can design our PR template for contributors ?
Maybe we should ask them to put component name in the PR title. For example:

Training: <Training Operator PR>
Katib: <Katib PR>
Pipelines: <KFP PR>

WDYT @hbelmiro @varodrig ?

@hbelmiro
Copy link
Contributor

hbelmiro commented Dec 2, 2024

I like your idea @andreyvelich.
Also, some PRs don't target any component, like more website-focused PRs. For example, fixing the Kubeflow logo.
In those cases, we can use General. (Any other better idea?)
We could use Website, but I think it may confuse users, like using Website when they should use Pipelines because they are sending a PR to the website.

@andreyvelich
Copy link
Member

andreyvelich commented Dec 2, 2024

General makes sense to me.

@varodrig
Copy link
Contributor Author

/assign @varodrig

@jaiakash
Copy link
Contributor

Here we could add -

  • Commit sign-off
  • Closes/Fixes Checkbox
  • Screenshot
  • Owners

One of the good I found is https://github.com/keploy/keploy/blob/main/.github/PULL_REQUEST_TEMPLATE.md

@andreyvelich
Copy link
Member

As @varodrig mention, I would suggest that we add the component name into PR title for the website.
That will help to assign correct reviewers for various Kubeflow Components:
For example:

pipelines:
notebooks:
trainer:
katib:
model-registry:
spark-operator:

@jaiakash
Copy link
Contributor

jaiakash commented Jan 17, 2025

Got it, So for now what i understood is -

PR title

<component name>: <PR explanation>

PR Body

Closes #<issue number>
  • I signed off all the commits. See this
<Explanation>

<Screnshots>

@varodrig varodrig linked a pull request Jan 19, 2025 that will close this issue
@varodrig
Copy link
Contributor Author

status: PR created on hold till address issue #3967

@varodrig
Copy link
Contributor Author

/hold

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants