|
1 | | -<!-- Before submit your Pull Request, make sure you picked |
2 | | - the right branch: |
| 1 | +[//]: # ( |
| 2 | + * Before submit your Pull Request, make sure you've picked the right branch and your code is up-to-date with it. |
| 3 | + * For critical hot-fixes, select "master" as the target branch. |
| 4 | + * For bug-fixes, improvements and new features, select "develop" as the target branch. |
| 5 | + * If your PR is part of a project/team, select project/team's dedicated feature branch. |
| 6 | + * If you have a JIRA ticket, prefix the ticket number [ENG-*****] to the PR title. |
| 7 | +) |
3 | 8 |
|
4 | | - - For hotfixes, select "master" as the target branch |
5 | | - - For new features, select "develop" as the target branch |
6 | | - - For release feature fixes, select the relevant release branch (release/X.Y.Z) as the target branch --> |
| 9 | +## Ticket |
| 10 | + |
| 11 | +[//]: # (Link to a JIRA ticket if available.) |
| 12 | + |
| 13 | +* [ENG-*****]() |
7 | 14 |
|
8 | 15 | ## Purpose |
9 | 16 |
|
10 | | -<!-- Describe the purpose of your changes --> |
| 17 | +[//]: # (Briefly describe the purpose of this PR.) |
11 | 18 |
|
12 | 19 | ## Changes |
13 | 20 |
|
14 | | -<!-- Briefly describe or list your changes --> |
| 21 | +[//]: # (Briefly describe or list your changes.) |
15 | 22 |
|
16 | | -## QA Notes |
| 23 | +## Side Effects |
17 | 24 |
|
| 25 | +[//]: # (Any possible side effects?) |
18 | 26 |
|
19 | | -<!-- Please make verification statements inspired by your code and what your code touches. |
20 | | - - Verify |
21 | | - - Verify |
22 | | - What are the areas of risk? |
23 | | - Any concerns/considerations/questions that development raised? |
24 | | ---> |
| 27 | +## QE Notes |
25 | 28 |
|
26 | | -## Documentation |
| 29 | +[//]: # ( |
| 30 | + * Any QA testing notes for QE? |
| 31 | + * Make verification statements inspired by your code and what your code touches. |
| 32 | + * What are the areas of risk? |
| 33 | + * Any concerns/considerations/questions that development raised? |
| 34 | + * If you have a JIRA ticket, make sure the ticket also contains the QE notes. |
| 35 | +) |
27 | 36 |
|
28 | | -<!-- Does any internal or external documentation need to be updated? |
29 | | - - If the API was versioned, update the developer.osf.io changelog. |
30 | | - - If changes were made to the API, link the developer.osf.io PR here. |
31 | | ---> |
| 37 | +## CE Notes |
32 | 38 |
|
33 | | -## Side Effects |
34 | | - |
35 | | -<!-- Any possible side effects? --> |
| 39 | +[//]: # ( |
| 40 | + * Any server configuration and deployment notes for CE? |
| 41 | + * Is model migration required? |
| 42 | + * Is data migration/backfill/popualation required? |
| 43 | + * If there is migration, is it reversible and is there roll-back plan? |
| 44 | + * Does server settings needs to be updated? |
| 45 | + * If there are settings update, have you checked existing settings for affected servers with CE? |
| 46 | + * Are there any deployment dependencies to other services? |
| 47 | + * If you have a JIRA ticket, make sure the ticket also contains the CE notes. |
| 48 | +) |
36 | 49 |
|
37 | | -## Ticket |
| 50 | +## Documentation |
38 | 51 |
|
39 | | -<!-- Link to Jira ticket, if applicable e.g. https://openscience.atlassian.net/browse/OSF-1234 --> |
| 52 | +[//]: # ( |
| 53 | + * Does any internal or external documentation need to be updated? |
| 54 | + * If the API was versioned, update the developer.osf.io changelog. |
| 55 | + * If changes were made to the API, link the developer.osf.io PR here. |
| 56 | +) |
0 commit comments