Skip to content

Commit c3aa17d

Browse files
committed
docs: add pull request template
Mirror the Ionic Framework PR template so contributors get a consistent structure: issue reference, current/new behavior, a breaking-change checkbox with migration guidance, and an other-information section. The breaking-change note points at this repo's BREAKING.md and the Conventional Commits footer format used by the publish pipeline.
1 parent 75195d9 commit c3aa17d

1 file changed

Lines changed: 34 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Issue number: resolves #
2+
3+
---------
4+
5+
<!-- Please do not submit updates to dependencies unless it fixes an issue. -->
6+
7+
<!-- Please try to limit your pull request to one type (bugfix, feature, etc). Submit multiple pull requests if needed. -->
8+
9+
## What is the current behavior?
10+
<!-- Please describe the current behavior that you are modifying. -->
11+
12+
## What is the new behavior?
13+
<!-- Please describe the behavior or changes that are being added by this PR. -->
14+
15+
-
16+
-
17+
-
18+
19+
## Does this introduce a breaking change?
20+
21+
- [ ] Yes
22+
- [ ] No
23+
24+
<!--
25+
If this introduces a breaking change:
26+
1. Describe the impact and migration path for existing applications below.
27+
2. Update the BREAKING.md file with the breaking change.
28+
3. Add "BREAKING CHANGE: [...]" to the commit description when merging. See https://www.conventionalcommits.org/ for more information.
29+
-->
30+
31+
32+
## Other information
33+
34+
<!-- Any other information that is important to this PR such as screenshots of how the change behaves before and after. -->

0 commit comments

Comments
 (0)