|
| 1 | +## Description |
| 2 | + |
1 | 3 | <!--
|
2 |
| -Thanks for your contribution! |
| 4 | +Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: |
3 | 5 |
|
4 |
| -Please ensure that any applicable requirements below are satisfied before submitting this pull request. This will help ensure a quick and efficient review cycle. |
| 6 | +* What is the current state of things and why does it need to change? |
| 7 | +* What is the solution your changes offer and how does it work? |
| 8 | +* What packages are you updating? |
| 9 | +* Are you introducing a breaking change to a package (renaming or removing a part of a public interface)? |
5 | 10 | -->
|
6 | 11 |
|
7 |
| -**PR Title** |
8 |
| - |
9 |
| -- A brief description of changes. If the PR has breaking changes add `BREAKING:` |
10 |
| - to the start of the PR title. |
11 |
| - |
12 |
| -**Description** |
13 |
| - |
14 |
| -_Itemize the changes you have made into the categories below_ |
15 |
| - |
16 |
| -- BREAKING: |
17 |
| - |
18 |
| - - _Describe the how to patch your code for the breaking changes_ |
19 |
| - - _Create PRs for other projects with patches to breaking changes_ |
20 |
| - |
21 |
| -- FIXED: |
22 |
| - |
23 |
| - - _Describe the fix/bug addressed_ |
| 12 | +## Changes |
24 | 13 |
|
25 |
| -- CHANGED: |
26 |
| - |
27 |
| - - _Describe the change you have made to existing functionality_ |
28 |
| - |
29 |
| -- REMOVED: |
30 |
| - |
31 |
| - - _Describe functionality removed and why_ |
32 |
| - |
33 |
| -- ADDED: |
| 14 | +<!-- |
| 15 | +Pretend that you're updating a changelog. How would you categorize your changes? |
34 | 16 |
|
35 |
| - - _Describe functionality added and why_ |
| 17 | +CATEGORY is one of: |
36 | 18 |
|
37 |
| -- DEPRECATED: |
| 19 | +- BREAKING |
| 20 | +- ADDED |
| 21 | +- CHANGED |
| 22 | +- DEPRECATED |
| 23 | +- REMOVED |
| 24 | +- FIXED |
38 | 25 |
|
39 |
| - - _Describe what was deprecated and why_ |
| 26 | +(Security-related changes should go through the Security Advisory process.) |
| 27 | +--> |
40 | 28 |
|
41 |
| -- SECURITY: |
| 29 | +- **<CATEGORY>**: Your change here |
| 30 | +- **<CATEGORY>**: Your change here |
| 31 | +- **<CATEGORY>**: Your change here |
42 | 32 |
|
43 |
| - - _These should not be in a standard PR and addressed using the Security Advisory process_ |
| 33 | +## References |
44 | 34 |
|
45 |
| -**Checklist** |
| 35 | +<!-- |
| 36 | +Are there any issues or other links that reviewers should consult to understand this pull request better? For instance: |
46 | 37 |
|
47 |
| -- [ ] Tests are included if applicable |
48 |
| -- [ ] Any added code is fully documented |
| 38 | +* Fixes #12345 |
| 39 | +* See: #67890 |
| 40 | +--> |
49 | 41 |
|
50 |
| -**Issue** |
| 42 | +## Checklist |
51 | 43 |
|
52 |
| -Resolves #??? |
| 44 | +- [ ] I've updated the test suite for new or updated code as appropriate |
| 45 | +- [ ] I've updated documentation for new or updated code as appropriate (note: this will usually be JSDoc) |
| 46 | +- [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate |
0 commit comments