Skip to content

Commit dcd51eb

Browse files
authored
Merge pull request #591 from LiliC/lili/add-issue-pr-template
Add Issue and PR templates to the project
2 parents bb12c1a + f225b9b commit dcd51eb

File tree

5 files changed

+124
-0
lines changed

5 files changed

+124
-0
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
<!---
2+
Thanks for filing an issue! Before you submit, please read the following:
3+
4+
Check the other issue templates if you are trying to submit a bug report, feature request, or question. Search open/closed issues before submitting since someone might have asked the same thing before!
5+
-->

.github/ISSUE_TEMPLATE/Bug_report.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
me: Bug Report
3+
about: If things aren't working as expected.
4+
5+
---
6+
7+
## Bug Report
8+
9+
<!--
10+
Thanks for filing an issue! Before hitting the button, please answer these questions.
11+
12+
Fill in as much of the template below as you can. If you leave out information, we can't help you as well.
13+
-->
14+
15+
**What did you do?**
16+
A clear and concise description of the steps you took (or insert a code snippet).
17+
18+
**What did you expect to see?**
19+
A clear and concise description of what you expected to happen (or insert a code snippet).
20+
21+
**What did you see instead? Under which circumstances?**
22+
A clear and concise description of what you expected to happen (or insert a code snippet).
23+
24+
25+
**Environment**
26+
* operator-sdk version:
27+
28+
Insert operator-sdk release or Git SHA here. If you have paste the Gopkg.lock operator-sdk information here.
29+
30+
* Kubernetes version information:
31+
32+
Insert output of `kubectl version` here
33+
34+
* Kubernetes cluster kind:
35+
36+
* Are you writing your operator in ansible or go?
37+
38+
**Possible Solution**
39+
<!--- Only if you have suggestions on a fix for the bug -->
40+
41+
**Additional context**
42+
Add any other context about the problem here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
me: Feature Request
3+
about: Suggest a feature
4+
5+
---
6+
7+
## Feature Request
8+
9+
**Is your feature request related to a problem? Please describe.**
10+
A clear and concise description of what the problem is. Example: "I have an issue when [...]"
11+
12+
**Describe the solution you'd like**
13+
A clear and concise description of what you want to happen. Add any considered drawbacks.
14+

.github/ISSUE_TEMPLATE/Question.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
me: Question
3+
about: Any support questions you might have.
4+
5+
---
6+
<!--
7+
Thanks for filing an issue! Before hitting the button, please answer these questions.
8+
9+
Fill in as much of the template below as you can. If you leave out information, we can't help you as well.
10+
11+
We will try our best to answer the question, but we also have a mailing list and slack channel for any other questions.
12+
-->
13+
14+
## Type of question
15+
16+
**Are you asking about community best practices, how to implement a specific feature, or about general context and help around the operator-sdk?**
17+
18+
19+
## Question
20+
21+
**What did you do?**
22+
A clear and concise description of the steps you took (or insert a code snippet).
23+
24+
**What did you expect to see?**
25+
A clear and concise description of what you expected to happen (or insert a code snippet).
26+
27+
**What did you see instead? Under which circumstances?**
28+
A clear and concise description of what you expected to happen (or insert a code snippet).
29+
30+
31+
**Environment**
32+
* operator-sdk version:
33+
34+
insert release or Git SHA here
35+
36+
* Kubernetes version information:
37+
38+
insert output of `kubectl version` here
39+
40+
* Kubernetes cluster kind:
41+
42+
**Additional context**
43+
Add any other context about the question here.
44+

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!--
2+
3+
Before making a PR, please read our contributing guidelines https://github.com/operator-framework/operator-sdk/blob/master/CONTRIBUTING.MD
4+
5+
Note: Make sure your branch is rebased to the latest upstream master.
6+
7+
--!>
8+
9+
**Description of the change:**
10+
11+
12+
**Motivation for the change:**
13+
14+
<!--
15+
16+
Note: If this PR is fixing an issue make sure to add a note saying:
17+
Closes #<ISSUE_NUMBER>
18+
19+
--!>

0 commit comments

Comments
 (0)