Skip to content

Commit 201d680

Browse files
committed
Add default PR template
The template picker only works for issues, but you can still have multiple PR templates that can be used with a query parameter, but that's kind-of unweildy. We'll have the default PR template, and keep the separate ones around linked-to from the readme as examples.
1 parent 4346537 commit 201d680

File tree

7 files changed

+10
-30
lines changed

7 files changed

+10
-30
lines changed

.github/PULL_REQUEST_TEMPLATE/breaking_change.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
name: Breaking change (X)
3-
about: A breaking change to the API surface or expected behavior of this project.
4-
5-
---
6-
71
<!-- please add a :warning: (`:warning:`) to the title of this PR, and delete this line and similar ones -->
82

93
<!-- What does this do, and why do we need it? -->

.github/PULL_REQUEST_TEMPLATE/bug_fix.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
name: Bug fix (Z)
3-
about: A bug fix that doesn't otherwise change API surface
4-
5-
---
6-
71
<!-- please add a :bug: (`:bug:`) to the title of this PR, and delete this line and similar ones -->
82

93
<!-- What does this do, and why do we need it? -->
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
name: Backwards-compatible feature (Y)
3-
about: A new feature that adds to the API surface or behavior, but doesn't break backwards compatibility
4-
5-
---
6-
71
<!-- please add a :sparkles: (`:sparkles:`) to the title of this PR, and delete this line and similar ones -->
82

93
<!-- What does this do, and why do we need it? -->

.github/PULL_REQUEST_TEMPLATE/docs.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
name: Documentation
3-
about: A change to the documentation of this repository
4-
5-
---
6-
71
<!-- please add a :book: (`:book:`) to the title of this PR, and delete this line and similar ones -->
82

93
<!-- What docs does this change, and why? -->
-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
---
2-
name: Tests/Infra/Other
3-
about: A change to the tests in this repo, the utilities scripts, or some other piece of infrastructure tooling
4-
5-
---
6-
71
<!-- please add a :running: (`:running:`) to the title of this PR, and delete this line and similar ones -->
82

93
<!-- What does this do, and why do we need it? -->

.github/pull_request_template.md

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<!-- please add a icon to the title of this PR (see VERSIONING.md), and delete this line and similar ones -->
2+
<!-- the icon will be either :warning: (major), :sparkles: (minor), :bug: (patch), :book: (docs), or :running: (other) -->
3+
4+
<!-- What does this do, and why do we need it? -->

README.md

+6
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,12 @@ Contributors:
2727

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

3137
## Community, discussion, contribution, and support
3238

0 commit comments

Comments
 (0)