Skip to content

Commit fed6271

Browse files
committed
Update PR template
1 parent 392535e commit fed6271

File tree

1 file changed

+41
-24
lines changed

1 file changed

+41
-24
lines changed

PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,56 @@
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+
)
38

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-*****]()
714

815
## Purpose
916

10-
<!-- Describe the purpose of your changes -->
17+
[//]: # (Briefly describe the purpose of this PR.)
1118

1219
## Changes
1320

14-
<!-- Briefly describe or list your changes -->
21+
[//]: # (Briefly describe or list your changes.)
1522

16-
## QA Notes
23+
## Side Effects
1724

25+
[//]: # (Any possible side effects?)
1826

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
2528

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+
)
2736

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
3238

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+
)
3649

37-
## Ticket
50+
## Documentation
3851

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

Comments
 (0)