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

Add pull request template #487

Merged
merged 1 commit into from
Jan 31, 2020

Conversation

corneliusweig
Copy link
Contributor

When small PRs are opened they often contain only very little description about the issue. In particular, they

  • don't reference existing issues
  • don't set related issues to auto-close
  • open PRs without issues

This template should help out to improve this. Also, it explicitly mentions tests, so we hopefully see more of those :)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jan 30, 2020
@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. approved Indicates a PR has been approved by an approver from all required OWNERS files. labels Jan 30, 2020
@codecov-io
Copy link

codecov-io commented Jan 30, 2020

Codecov Report

Merging #487 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #487   +/-   ##
=======================================
  Coverage   56.47%   56.47%           
=======================================
  Files          19       19           
  Lines         926      926           
=======================================
  Hits          523      523           
  Misses        350      350           
  Partials       53       53

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5ceeae5...b807c3a. Read the comment docs.

@ahmetb
Copy link
Member

ahmetb commented Jan 30, 2020

I'm -1 b/c it's too long. I don't find the long PR/issue templates productive.

  • don't reference existing issues
  • don't set related issues to auto-close
  • open PRs without issues

If all you're trying to address is these points, this will do:

Fixes #...
Related issue: #...
<!-- For proposed features, make sure there's an issue it's discussed first -->

@corneliusweig
Copy link
Contributor Author

corneliusweig commented Jan 30, 2020

We can definitely shorten more. Another goal is to remind submitters to add test.

Sooo.. the checklist has become rather short and hard to ignore 😄

@ahmetb
Copy link
Member

ahmetb commented Jan 30, 2020

Lets not do checklists if we can. Not everything warrants a test, and we can easily say please add tests.

@ahmetb
Copy link
Member

ahmetb commented Jan 30, 2020

IMO lets not have any [ ] at all. I don’t want progress bars floating around for no good reason. Most people don’t even know GFM has that feature. If we can cap at 3 consecutive lines and no checkmarks I am happier.

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jan 30, 2020
@corneliusweig
Copy link
Contributor Author

Alright let's keep it minimal then. It's anyway just restating what is in our contributor guidelines.

@ahmetb
Copy link
Member

ahmetb commented Jan 30, 2020

Do you mind removing empty lines. They aren’t required for newlines in PR descriptions.

@corneliusweig
Copy link
Contributor Author

Right, I should have known 🤣

@ahmetb
Copy link
Member

ahmetb commented Jan 31, 2020

/lgtm
/approve
Thanks!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 31, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ahmetb, corneliusweig

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [ahmetb,corneliusweig]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 7842e57 into kubernetes-sigs:master Jan 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants