|
1 |
| -<!-- Describe what has changed in this PR --> |
2 |
| -**What changed?** |
3 |
| - |
4 |
| - |
5 |
| -<!-- Tell your future self why have you made these changes --> |
6 |
| -**Why?** |
7 |
| - |
8 |
| - |
9 |
| -<!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> |
10 |
| -**How did you test it?** |
11 |
| - |
12 |
| - |
13 |
| -<!-- Assuming the worst case, what can be broken when deploying this change to production? --> |
14 |
| -**Potential risks** |
15 |
| - |
16 |
| -<!-- Is it notable for release? e.g. schema updates, configuration or data migration required? If so, please mention it, and also update CHANGELOG.md --> |
17 |
| -**Release notes** |
18 |
| - |
19 |
| -<!-- Is there any documentation updates should be made for config, https://cadenceworkflow.io/docs/operation-guide/setup/ ? If so, please open an PR in https://github.com/uber/cadence-docs --> |
20 |
| -**Documentation Changes** |
| 1 | +### Summary |
| 2 | +[Brief summary of the change, including the rationale and intended effect] |
| 3 | + |
| 4 | +### Type of Change |
| 5 | +- [x] Add new API(s) |
| 6 | +- [ ] Add new data type(s) |
| 7 | +- [ ] Add new field(s) to existing data type |
| 8 | +- [ ] Remove field(s) from data type |
| 9 | +- [ ] Remove data type(s) |
| 10 | +- [ ] Remove API(s) |
| 11 | +- [ ] Other (please provide detailed description) |
| 12 | + |
| 13 | +### Data Effect |
| 14 | +- [ ] Does it change the data stored in database? |
| 15 | + |
| 16 | +### Detailed Description |
| 17 | +[In-depth description of the changes made to the IDL, specifying new fields, removed fields, or modified data structures] |
| 18 | + |
| 19 | +### Impact Analysis |
| 20 | +- **Backward Compatibility**: [Analysis of backward compatibility] |
| 21 | +- **Forward Compatibility**: [Analysis of forward compatibility] |
| 22 | + |
| 23 | +### Testing Plan |
| 24 | +- **Unit Tests**: [Do we have unit test covering the change?] |
| 25 | +- **Persistence Tests**: [If the change is related to a data type which is persisted, do we have persistence tests covering the change?] |
| 26 | +- **Integration Tests**: [Do we have integration test covering the change?] |
| 27 | +- **Compatibility Tests**: [Have we done tests to test the backward and forward compatibility?] |
| 28 | + |
| 29 | +### Rollout Plan |
| 30 | +- What is the rollout plan? |
| 31 | +- Does the order of deployment matter? |
| 32 | +- Is it safe to rollback? Does the order of rollback matter? |
| 33 | +- Is there a kill switch to mitigate the impact immediately? |
0 commit comments