Skip to content

🏃 Add default PR template #225

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 27, 2018
Merged

🏃 Add default PR template #225

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/breaking_change.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
name: Breaking change (X)
about: A breaking change to the API surface or expected behavior of this project.

---

<!-- please add a :warning: (`:warning:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
Expand Down
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
name: Bug fix (Z)
about: A bug fix that doesn't otherwise change API surface

---

<!-- please add a :bug: (`:bug:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
Expand Down
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/compat_feature.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
name: Backwards-compatible feature (Y)
about: A new feature that adds to the API surface or behavior, but doesn't break backwards compatibility

---

<!-- please add a :sparkles: (`:sparkles:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
name: Documentation
about: A change to the documentation of this repository

---

<!-- please add a :book: (`:book:`) to the title of this PR, and delete this line and similar ones -->

<!-- What docs does this change, and why? -->
6 changes: 0 additions & 6 deletions .github/PULL_REQUEST_TEMPLATE/other.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
---
name: Tests/Infra/Other
about: A change to the tests in this repo, the utilities scripts, or some other piece of infrastructure tooling

---

<!-- please add a :running: (`:running:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
4 changes: 4 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!-- please add a icon to the title of this PR (see VERSIONING.md), and delete this line and similar ones -->
<!-- the icon will be either :warning: (major), :sparkles: (minor), :bug: (patch), :book: (docs), or :running: (other) -->

<!-- What does this do, and why do we need it? -->
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,12 @@ Contributors:

- All code PR must be labeled with :bug: (patch fixes), :sparkles: (backwards-compatible features), or :warning: (breaking changes)
- Breaking changes will find their way into the next major release, other changes will go into an semi-immediate patch or minor release
- For a quick PR template suggesting the right information, use one of these PR templates:
* [Breaking Changes/Features](/.github/PULL_REQUEST_TEMPLATE/breaking_change.md)
* [Backwards-Compatible Features](/.github/PULL_REQUEST_TEMPLATE/compat_feature.md)
* [Bug fixes](/.github/PULL_REQUEST_TEMPLATE/bug_fix.md)
* [Documentation Changes](/.github/PULL_REQUEST_TEMPLATE/docs.md)
* [Test/Build/Other Changes](/.github/PULL_REQUEST_TEMPLATE/other.md)

## Community, discussion, contribution, and support

Expand Down