Skip to content

chore: provide a pr template#2608

Merged
patak-cat merged 9 commits intovitejs:mainfrom
Shinigami92:pr-template
Mar 20, 2021
Merged

chore: provide a pr template#2608
patak-cat merged 9 commits intovitejs:mainfrom
Shinigami92:pr-template

Conversation

@Shinigami92
Copy link
Member

@Shinigami92 Shinigami92 commented Mar 20, 2021

Before submitting the PR, please make sure you do the following

  • Read the Contributing Guidelines.
  • Read the Pull Request Guidelines and follow the Commit Convention.
  • Check that there isn't already a PR that solves the problem the same way to avoid creating a duplicate.
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123).
  • Ideally, include relevant tests that fail without this PR but pass with it.

What is the purpose of this pull request?

  • Bug fix
  • New Feature
  • Documentation update
  • Other

Description

This PR template guides contributors while creating new PRs.
The contributor needs to tick some checkboxes and commits this way that they have read it.
Also they are introduced more to provide a more helpful description text that will help reviewers to understand the PR better and therefore stabilize the project.
In addition to that, core members can faster identify if the PR will introduce breaking changes or just add/improve e.g. some documentation

Addition Context

Reviewer focus:

  • Inclusive wording
  • Spell checking
  • Improvements for sentences

@Shinigami92 Shinigami92 marked this pull request as ready for review March 20, 2021 11:03
@Shinigami92 Shinigami92 requested a review from patak-cat March 20, 2021 11:32
patak-cat
patak-cat previously approved these changes Mar 20, 2021
@patak-cat
Copy link
Member

@antfu If this looks good to you, I think we could merge it

@Shinigami92 Shinigami92 requested a review from patak-cat March 20, 2021 15:16
@patak-cat patak-cat merged commit 23f57ee into vitejs:main Mar 20, 2021
@Shinigami92 Shinigami92 deleted the pr-template branch March 20, 2021 17:10
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 this pull request may close these issues.

4 participants