Skip to content

Commit 9dd3327

Browse files
MatthewMatthew Fisher
authored andcommitted
feat(github): add pull request template
This pull request template describes the typical workflow each pull request goes through. This just formalizes it so users and core contributors have a checklist to go through when reviewing pull requests.
1 parent f1ee725 commit 9dd3327

1 file changed

Lines changed: 52 additions & 0 deletions

File tree

.github/PULL_REQUEST_TEMPLATE

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Summary of Changes
2+
3+
Please explain what this PR changes, and include what unit tests you've written (we hope you wrote tests!)
4+
5+
# Issue(s) that this PR Closes
6+
7+
Please list the issue(s) that this PR closes, similar to the below:
8+
9+
closes #1234
10+
closes #5678
11+
12+
# Associated [End To End Test](https://github.com/deis/workflow-e2e) PR(s)
13+
14+
If your change requires any additions or changes to the [end to end tests](https://github.com/deis/workflow-e2e), please submit them as 1 or more pull requests against that repo and refer to them here.
15+
16+
refs deis/workflow-e2e#1234
17+
refs deis/workflow-e2e#5678
18+
19+
# Associated [Documentation](https://github.com/deis/workflow) PR(s)
20+
21+
If your change requires any additions or changes to the [official documentation](https://github.com/deis/workflow), please submit them as 1 or more pull requests against that repo and refer to them here.
22+
23+
refs deis/workflow#1234
24+
refs deis/workflow#5678
25+
26+
# Associated [Design Document](http://docs.deis.io/en/latest/contributing/design-documents)(s)
27+
28+
If your change was inspired by 1 or more design document(s), please provide a list of links to them here.
29+
30+
# Testing Instructions
31+
32+
Please provide a detailed list for how to test the changes in this PR.
33+
34+
1. Create a Deis Cluster
35+
2. Register an app
36+
3. Your steps here
37+
38+
Also, please provide a description of the desired result after the tester completes the above steps.
39+
40+
1. The app called "abcd" should be deployed
41+
2. `kubectl get pod --namespace=abcd` should show 2 pods running
42+
3. etc.
43+
44+
# Pull Request Hygiene TODOs
45+
46+
Please make sure the below checklist is complete.
47+
48+
- [ ] Your pull request is concise and to the point (make another PR for refactoring nearby code)
49+
- [ ] Your commits are squashed into logical units of work
50+
- [ ] Your commits follow the [commit style guidelines](http://docs.deis.io/en/latest/contributing/standards/#commit-style-guide)
51+
52+
:cherry_blossom: Thank you! :cherry_blossom:

0 commit comments

Comments
 (0)