Skip to content

Commit e2fb93e

Browse files
committed
Add PR templates
This adds PR templates for the different classes of changes we support, according to VERSIONING.md.
1 parent 8991a78 commit e2fb93e

File tree

5 files changed

+49
-0
lines changed

5 files changed

+49
-0
lines changed
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Breaking change (X)
3+
about: A breaking change to the API surface or expected behavior of this project.
4+
5+
---
6+
7+
<!-- please add a :warning: (`:warning:`) to the title of this PR, and delete this line and similar ones -->
8+
9+
<!-- What does this do, and why do we need it? -->
10+
11+
<!-- Why does this have to be a breaking change (what else did you consider)? -->
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
name: Bug fix (Z)
3+
about: A bug fix that doesn't otherwise change API surface
4+
5+
---
6+
7+
<!-- please add a :bug: (`:bug:`) to the title of this PR, and delete this line and similar ones -->
8+
9+
<!-- What does this do, and why do we need it? -->
10+
11+
<!-- What issue does this fix (e.g. Fixes #XYZ) -->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
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+
7+
<!-- please add a :sparkles: (`:sparkles:`) to the title of this PR, and delete this line and similar ones -->
8+
9+
<!-- What does this do, and why do we need it? -->

.github/PULL_REQUEST_TEMPLATE/docs.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Documentation
3+
about: A change to the documentation of this repository
4+
5+
---
6+
7+
<!-- please add a :book: (`:book:`) to the title of this PR, and delete this line and similar ones -->
8+
9+
<!-- What docs does this change, and why? -->
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
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+
7+
<!-- please add a :running: (`:running:`) to the title of this PR, and delete this line and similar ones -->
8+
9+
<!-- What does this do, and why do we need it? -->

0 commit comments

Comments
 (0)