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

Updates PR Template to include Version label #1048

Merged
merged 2 commits into from
Mar 25, 2019

Conversation

supernova-at
Copy link
Contributor

@supernova-at supernova-at commented Mar 21, 2019

Description

This PR updates our pull request template to add a checklist step for PR authors to propose a SemVer change level of their changes (patch, minor, major).

Related Issue

Closes #1047 .

Motivation and Context

We'd like to determine MAJOR, MINOR, or PATCH changes at the PR level while we have context into the change instead of at release time when it will be easier to forget or miss the impact of a change.

Three new labels exist for this purpose:

  1. version: Major
  2. version: Minor
  3. version: Patch

To get PR authors to add these labels, this PR adds a step to the PR checklist.

Verification

Reading the new PR Template for accuracy.

How Has This Been Tested?

n/a

Screenshots (if appropriate):

Proposed Labels for Change Type/Package

DOCUMENTATION

n/a

Checklist:

  • I have read the CONTRIBUTING document.
  • I have linked an issue to this PR.
  • I have indicated the change type and relevant package(s).
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All CI checks are green (linting, build/deploy, etc).
  • At least one core contributor has approved this PR.

@vercel
Copy link

vercel bot commented Mar 21, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

@supernova-at supernova-at added the version: Patch This changeset includes backwards compatible bug fixes. label Mar 21, 2019
@coveralls
Copy link

coveralls commented Mar 21, 2019

Coverage Status

Coverage remained the same at 76.672% when pulling 9596775 on supernova/1047-add_version_label_to_pr_template into 822591e on develop.

@supernova-at
Copy link
Contributor Author

I added / fixed up a couple other minor things in the PR Template while I was in there.

I don't know how / that we're using the answers to the "Proposed Labels for Change Type/Package" question, so that could be a good one to drop. That change seemed out of scope for this ticket though.

@jcalcaben
Copy link
Contributor

I agree with dropping the labels/package question. I also propose dropping the last two checkbox items as they will never be checked on initial create.

@tjwiebell tjwiebell self-assigned this Mar 25, 2019
Copy link
Contributor

@tjwiebell tjwiebell left a comment

Choose a reason for hiding this comment

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

LGTM, but wanted to check if we want to sneak the removal of those two loosely used checkboxes in the scope of this PR. I'm leaning towards no, and we just merge. @supernova-at, agree?

@tjwiebell tjwiebell merged commit 747868e into develop Mar 25, 2019
@supernova-at supernova-at deleted the supernova/1047-add_version_label_to_pr_template branch May 2, 2019 18:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
version: Patch This changeset includes backwards compatible bug fixes.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update PR Template to include Version label
5 participants