|
1 | | -<!-- |
2 | | -Thank you for submitting a pull request! We appreciate your time and effort. |
3 | | -
|
4 | | -Please make sure to provide enough information so that we can review your pull |
5 | | -request. The Summary and Testing sections below contain guidance on what to |
6 | | -include. |
7 | | ---> |
8 | | - |
9 | | -## Summary |
| 1 | +## Rational for this change |
10 | 2 |
|
11 | 3 | <!-- |
12 | | -If this PR is related to a tracked effort, please link to the relevant issue |
13 | | -here (e.g., `Closes: #123`). Otherwise, feel free to ignore / delete this. |
14 | | -
|
15 | | -In this section, please: |
16 | | -
|
17 | | -1. Explain the rationale for this change. |
18 | | -2. Summarize the changes included in this PR. |
| 4 | +Why are you proposing this change, and what is its impact. |
| 5 | +Is it part of a long term effort, or a bigger change? |
19 | 6 |
|
20 | | -A general rule of thumb is that larger PRs should have larger summaries. If |
21 | | -there are a lot of changes, please help us review the code by explaining what |
22 | | -was changed and why. |
23 | | -
|
24 | | -If there is an issue or discussion attached, there is no need to duplicate all |
25 | | -the details, but clarity is always preferred over brevity. |
| 7 | +If this PR is related to a tracked effort or an open issue, please link to the relevant issue. |
26 | 8 | --> |
27 | 9 |
|
28 | | -Closes: #000 |
| 10 | +- Closes: #000 |
29 | 11 |
|
| 12 | +## What changes are included in this PR? |
30 | 13 | <!-- |
31 | | -## API Changes |
32 | | -
|
33 | | -Uncomment this section if there are any user-facing changes. |
34 | | -
|
35 | | -Consider whether the change affects users in one of the following ways: |
36 | | -
|
37 | | -1. Breaks public APIs in some way. |
38 | | -2. Changes the underlying behavior of one of the engine integrations. |
39 | | -3. Should some documentation be updated to reflect this change? |
40 | | -
|
41 | | -If a public API is changed in a breaking manner, make sure to add the |
42 | | -appropriate label. |
| 14 | +No need to duplicate information from the previous section, but if you're touching many |
| 15 | +parts of the code base, its worth explicitly noting the important changes or how they are tested. |
43 | 16 | --> |
44 | 17 |
|
45 | | -## Testing |
| 18 | +## What APIs are changed? Are there any user-facing changes? |
46 | 19 |
|
47 | 20 | <!-- |
48 | | -Please describe how this change was tested. Here are some common categories for |
49 | | -testing in Vortex: |
50 | | -
|
51 | | -1. Verifying existing behavior is maintained. |
52 | | -2. Verifying new behavior and functionality works correctly. |
53 | | -3. Serialization compatibility (backwards and forwards) should be maintained or |
54 | | - explicitly broken. |
| 21 | +Are there any user-facing changes that might require documentation updates |
| 22 | +Is any public API changed? |
55 | 23 | --> |
0 commit comments