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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: improve pull request template #7576

Merged
merged 8 commits into from
Oct 28, 2020

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Oct 27, 2020

Changes:

  • Use active voice
  • Simplify text
  • Be clear when things are required from the contributor, I think the old pull request is a bit too hand wavy on hard requirements. This is a tone/style thing that affects the way the Renovate project feels to newcomers, so feel free to adjust this with a review. 馃槈
  • Add proper headings for sections
  • Add documentation and testing check-boxes

Context:

The pull request template needs to be updated.
This pull request template incorporates the good stuff from the discussion at issue #5189.

Closes #5189

Documentation (please tick one)

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • Unit tests + ran on a real repository

@HonkingGoose
Copy link
Collaborator Author

By the way, I'm using the new template here. So you can see how it looks. 馃槃

viceice
viceice previously approved these changes Oct 27, 2020
Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

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

like it

.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
.github/pull_request_template.md Outdated Show resolved Hide resolved
Co-authored-by: Rhys Arkins <rhys@arkins.net>
@rarkins
Copy link
Collaborator

rarkins commented Oct 27, 2020

I think the conventional commits reference is a bit "heavy" and could put people off who aren't familiar with it. I suggest either:

  • We create our own very short description with examples to link to, OR
  • Leave it off because it's really easy for any maintainer to edit the PR title once it's created anyway

@HonkingGoose
Copy link
Collaborator Author

I've removed the reference to the Conventional Commits style guide. Less is more. 馃槃

@HonkingGoose
Copy link
Collaborator Author

@rarkins I've implemented your review feedback, fixed the small Prettier linting issue that your suggestion caused, and merged the current master branch.

I think this is ready for another round of review. 馃槃

@rarkins rarkins merged commit bcff733 into renovatebot:master Oct 28, 2020
@HonkingGoose HonkingGoose deleted the chore/5189 branch October 28, 2020 13:17
@renovate-release
Copy link
Collaborator

馃帀 This PR is included in version 23.61.6 馃帀

The release is available on:

Your semantic-release bot 馃摝馃殌

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 15, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve PR Template For Contributors
4 participants