|
1 |
| -## Motivation and Context |
2 |
| -<!-- Describe the purpose of the changes being proposed for the Client Advisor module. What problem does it solve or functionality does it add? --> |
| 1 | +## Purpose |
| 2 | +<!-- Describe the intention of the changes being proposed. What problem does it solve or functionality does it add? --> |
3 | 3 | * ...
|
4 | 4 |
|
5 |
| -## Description |
6 |
| -<!-- Provide a detailed description of the changes. Include any relevant information, such as design decisions, architectural considerations, and dependencies specific to Client Advisor. --> |
| 5 | +## Does this introduce a breaking change? |
| 6 | +<!-- Mark one with an "x". --> |
| 7 | + |
| 8 | +- [ ] Yes |
| 9 | +- [ ] No |
| 10 | + |
| 11 | +<!-- Please prefix your PR title with one of the following: |
| 12 | + * `feat`: A new feature |
| 13 | + * `fix`: A bug fix |
| 14 | + * `docs`: Documentation only changes |
| 15 | + * `style`: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| 16 | + * `refactor`: A code change that neither fixes a bug nor adds a feature |
| 17 | + * `perf`: A code change that improves performance |
| 18 | + * `test`: Adding missing tests or correcting existing tests |
| 19 | + * `build`: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm) |
| 20 | + * `ci`: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs) |
| 21 | + * `chore`: Other changes that don't modify src or test files |
| 22 | + * `revert`: Reverts a previous commit |
| 23 | + * !: A breaking change is indicated with a `!` after the listed prefixes above, e.g. `feat!`, `fix!`, `refactor!`, etc. |
| 24 | +--> |
| 25 | + |
| 26 | +## Golden Path Validation |
| 27 | +- [ ] I have tested the primary workflows (the "golden path") to ensure they function correctly without errors. |
| 28 | + |
| 29 | +## Deployment Validation |
| 30 | +- [ ] I have validated the deployment process successfully and all services are running as expected with this change. |
| 31 | + |
| 32 | +## What to Check |
| 33 | +Verify that the following are valid |
7 | 34 | * ...
|
8 | 35 |
|
9 |
| -## Contribution Checklist |
10 |
| -- [ ] I have built and tested the Client Advisor module locally and in a deployed environment. |
11 |
| -- [ ] I have pulled the latest code from the main branch, built the frontend for Client Advisor, and committed all necessary files. |
12 |
| -- [ ] I have ensured that this change is applicable to all Client Advisor users and does not include organization-specific code or assets. |
13 |
| -- [ ] Existing functionality within the Client Advisor module remains unaffected. |
14 |
| - |
15 |
| -## Golden Path Verification |
16 |
| -- [ ] I have tested the primary workflows for Client Advisor (the "golden path") to ensure they function correctly without errors. |
17 |
| - |
18 |
| -## Documentation Updates |
19 |
| -<!-- Mark one with an "x" and provide details if applicable. --> |
20 |
| -- [ ] Updated README.md specific to the Client Advisor module (if applicable) |
21 |
| -- [ ] Updated SolutionArchitecture.md for Client Advisor (if applicable). |
22 |
| -- [ ] Updated Troubleshooting.md for Client Advisor (if applicable). |
23 |
| - |
24 |
| -Details of documentation updates: |
25 |
| -* ... |
26 |
| - |
27 |
| -## Screenshots (If Applicable) |
28 |
| -* Provide before and after screenshots to illustrate the changes made in the Client Advisor module. |
29 |
| - |
30 |
| -## Related Issues |
31 |
| -<!-- List any related issues or tickets for the Client Advisor module. --> |
32 |
| -* Closes #... |
33 |
| - |
34 |
| -## Additional Information |
35 |
| -* Any other information that would be helpful for reviewers of the Client Advisor module. |
36 |
| -* ... |
| 36 | +## Other Information |
| 37 | +<!-- Add any other helpful information that may be needed here. --> |
0 commit comments