Skip to content

Commit 2eebf56

Browse files
authored
Merge pull request #1057 from DirectXMan12/infra/pr-templates-fixup
Fixup PR/issue templates
2 parents 2c99223 + 2af6849 commit 2eebf56

File tree

4 files changed

+87
-39
lines changed

4 files changed

+87
-39
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+23-21
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
name: Bug report
3-
about: Problems and issues
3+
about: Problems and issues with code or docs
44
title: ''
5-
labels: kind/bug
65
assignees: ''
76

87
---
@@ -15,32 +14,35 @@ assignees: ''
1514
1615
-->
1716

18-
/kind bug
19-
2017
<!--
21-
Thanks for filing an issue! Before hitting the button, please answer these questions.
22-
Fill in as much of the template below as you can. If you leave out information, we can't help you as well.
18+
19+
Hiya! Welcome to KubeBuilder! For a smooth issue process, try to answer the following questions.
20+
Don't worry if they're not all applicable; just try to include what you can :-)
21+
22+
If you need to include code snippets or logs, please put them in fenced code
23+
blocks. If they're super-long, please use the details tag like
24+
<details><summary>super-long log</summary> lots of stuff </details>
25+
2326
-->
2427

25-
**What did you do?**
26-
A clear and concise description of the steps you took (or insert a code snippet).
28+
<!-- What broke (please include exact error messages if you can) -->
29+
30+
<!-- What did you expect to happen? What do you think went wrong? -->
2731

28-
**What did you expect to see?**
29-
A clear and concise description of what you expected to happen (or insert a code snippet).
32+
<!-- If you don't know what broke, but have a minimal reproducer, that would be super-helpful helpful! -->
3033

31-
**What did you see instead? Under which circumstances?**
32-
A clear and concise description of what you expected to happen (or insert a code snippet).
34+
<!--
3335
34-
**Environment**
35-
* go version:
36+
What versions of software are you using? Specifically, the following are often useful:
3637
37-
<!--- Insert the output of `go version` here -->
38+
* go version
39+
* kubebuilder version (`kubebuilder version`) and scaffolding version (check your `PROJECT` file)
40+
* controller-runtime version (check your `go.mod` file)
41+
* controller-tools version
42+
* Kubernetes & kubectl versions (just run `kubectl version` against your API server)
3843
39-
* Kubernetes version information:
40-
<!--- Insert the output of `kubectl version` here -->
44+
-->
4145

42-
**Possible Solution**
43-
<!--- Only if you have suggestions on a fix for the bug -->
46+
<!-- If this is actually about documentation, add `/kind documentation` below -->
4447

45-
**Additional context**
46-
Add any other context about the problem here.
48+
/kind bug

.github/ISSUE_TEMPLATE/feature_request.md

+20-6
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Feature request
3-
about: Suggest an idea for this project
3+
about: Suggest an idea for this project or its docs
44
title: ''
55
labels: kind/feature
66
assignees: ''
@@ -15,10 +15,24 @@ assignees: ''
1515
1616
-->
1717

18-
/kind feature
18+
<!--
19+
20+
Hiya! Welcome to KubeBuilder! For a smooth feature request process, try to
21+
answer the following questions. Don't worry if they're not all applicable; just
22+
try to include what you can :-)
23+
24+
If you need to include code snippets or logs, please put them in fenced code
25+
blocks. If they're super-long, please use the details tag like
26+
<details><summary>super-long log</summary> lots of stuff </details>
27+
28+
-->
1929

20-
**Is your feature request related to a problem? Please describe.**
21-
A clear and concise description of what the problem is. Example: "I have an issue when (...)"
30+
<!-- What do you want to happen? -->
2231

23-
**Describe the solution you'd like**
24-
A clear and concise description of what you want to happen. Add any considered drawbacks.
32+
<!-- Is there currently another issue associated with this? -->
33+
34+
<!-- Does it require a particular kubernetes version? -->
35+
36+
<!-- If this is actually about documentation, add `/kind documentation` below -->
37+
38+
/kind feature

.github/ISSUE_TEMPLATE/support-question.md

+31-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Question
33
about: Any questions you might have.
44
title: ''
5-
labels: kind/question
5+
labels: triage/support
66
assignees: ''
77

88
---
@@ -15,4 +15,33 @@ assignees: ''
1515
1616
-->
1717

18-
kind question
18+
<!--
19+
20+
Hiya! Welcome to KubeBuilder!
21+
22+
You probably didn't want to be one this page. It shouldn't really be here anyway.
23+
24+
* Double-check the docs https://book.kubebuilder.io and https://godoc.org/sigs.k8s.io/controller-runtime.
25+
26+
* If you want a quick response to a question, ask on the Kubernetes Slack instance in #kubebuilder.
27+
28+
* If this is actually a bug or a feature request, file one of those. If you're
29+
not sure which, just take a guess and we can always re-label.
30+
31+
* If you think this might turn into a bug or feature request, but you're not
32+
sure, try asking in Slack first.
33+
34+
-->
35+
36+
<!--
37+
38+
Still here? Double-check that this hasn't been asked before, then put your question below
39+
with as many details as possible.
40+
41+
If you need to include code snippets or logs, please put them in fenced code
42+
blocks. If they're super-long, please use the details tag like
43+
<details><summary>super-long log</summary> lots of stuff </details>
44+
45+
-->
46+
47+
/triage support

.github/PULL_REQUEST_TEMPLATE.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
<!--
22
3-
Note: Make sure your branch is rebased to the latest upstream master.
3+
Hiya! Welcome to KubeBuilder! For a smooth PR process, please ensure
4+
that you include the following information:
45
5-
-->
6-
7-
**Description of the change:**
6+
* a description of the change
7+
* the movtivation for the change
8+
* what issue it fixes, if any, in GitHub syntax (e.g. Fixes #XYZ)
89
10+
Both the description and motivation may reference other issues and PRs,
11+
but should be mostly understandable without following the links (e.g. when
12+
reading the git commit log).
913
10-
**Motivation for the change:**
14+
Please don't @-mention people in PR or commit messages (do so in an
15+
additional comment).
1116
12-
<!--
17+
**PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING THE PR** (the bits
18+
between the arrows)
1319
14-
Note: If this PR is fixing an issue make sure to add a note saying:
15-
Closes #<ISSUE_NUMBER>
16-
17-
-->
20+
-->

0 commit comments

Comments
 (0)