Skip to content

Commit c5a5a6d

Browse files
author
Aaron Schlesinger
committed
doc(.github): add pull request and issue templates
1 parent e0d06f8 commit c5a5a6d

2 files changed

Lines changed: 87 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Summary
2+
3+
Please provide a summary of this issue.
4+
5+
## If You Are Reporting a Bug
6+
7+
If you're reporting a bug, please provide a detailed description of the problem.
8+
9+
## If You Are Submitting a Feature Request
10+
11+
If you're submitting a feature request, please provide as much details on what you'd like to see and 1 or more use cases. The more detail we have, the more quickly and efficiently we can discuss, decide and implement the feature.
12+
If this is a bug: provide a description of the problem
13+
14+
## Everything Else
15+
16+
If you're not submitting a bug or feature request, we still want to hear from you! Please feel free to write us and we'd love to have a conversation. As always, constructive conversation and details, where appropriate, are appreciated.
17+
18+
# For Bugs: Replication Steps
19+
20+
If you're submitting a bug, please provide a detailed list of steps to reproduce it.
21+
22+
1. Create a Deis Cluster
23+
2. Register an app
24+
3. Your Steps Here...
25+
26+
Also, please provide a description of the desired result after the tester completes the above steps.
27+
28+
1. The app called "abcd" should be deployed
29+
2. `kubectl get pod --namespace=abcd` should show 2 pods running
30+
3. etc...
31+
32+
# Related Issues
33+
34+
Do any issues in this repository relate to this one? If so, refer to them here and explain why they relate
35+
36+
This bug is a symptom of #1234
37+
This bug would be fixed by the feature requested in #5678

.github/PULL_REQUEST_TEMPLATE

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
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+
Ref deis/workflow-e2e#1234
17+
Ref deis/workflow-e2e#5678
18+
19+
# Associated [Documentation](https://github.com/deis/docs-v2) PR(s)
20+
21+
If your change requires any additions or changes to the [official documentation](https://github.com/deis/docs-v2), please submit them as 1 or more pull requests against that repo and refer to them here.
22+
23+
Ref deis/docs-v2#1234
24+
Ref deis/docs-v2#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.html#commit-style)

0 commit comments

Comments
 (0)