This is an automated email from the ASF dual-hosted git repository.
kvn pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/apisix-ingress-controller.git
The following commit(s) were added to refs/heads/master by this push:
new 4a6509c chore: Issue & PR template (#771)
4a6509c is described below
commit 4a6509c798a28c766c93a11468c205b64d742e98
Author: Mayo Cream <[email protected]>
AuthorDate: Tue Dec 14 17:05:32 2021 +0800
chore: Issue & PR template (#771)
---
.github/ISSUE_TEMPLATE/bug-report.md | 26 --------------
.github/ISSUE_TEMPLATE/bug_report.yml | 61 +++++++++++++++++++++++++++++++++
.github/ISSUE_TEMPLATE/request-help.md | 16 ---------
.github/ISSUE_TEMPLATE/request_help.yml | 31 +++++++++++++++++
.github/PULL_REQUEST_TEMPLATE | 47 ++++++++++++-------------
5 files changed, 116 insertions(+), 65 deletions(-)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md
b/.github/ISSUE_TEMPLATE/bug-report.md
deleted file mode 100644
index 7cf97a6..0000000
--- a/.github/ISSUE_TEMPLATE/bug-report.md
+++ /dev/null
@@ -1,26 +0,0 @@
----
-name: Bug report template
-about: Please use this template for reporting suspected bugs.
-title: 'bug: '
-labels: ''
-assignees: ''
-
----
-
-### Issue description
-
-### Environment
-
-* your apisix-ingress-controller version (output of `apisix-ingress-controller
version --long`);
-* your Kubernetes cluster version (output of `kubectl version`);
-* if you run apisix-ingress-controller in Bare-metal environment, also show
your OS version (`uname -a`).
-
-### Minimal test code / Steps to reproduce the issue
-
-1.
-2.
-3.
-
-### What's the actual result? (including assertion message & call stack if
applicable)
-
-### What's the expected result?
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml
b/.github/ISSUE_TEMPLATE/bug_report.yml
new file mode 100644
index 0000000..108d8b4
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,61 @@
+name: "Bug report"
+description: Create a report to help us improve
+title: "bug: "
+body:
+ - type: markdown
+ attributes:
+ value: |
+ The more information you fill in, the better we can help you.
+
+ - Please use English on public channel.
+ - Encourage using words rather than pictures to describe errors.
+ - Encourage pre-searching with keywords in the issue.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Issue description
+ description: Provide a clear and concise description of what you're
running into.
+ validations:
+ required: true
+ - type: textarea
+ id: environment
+ attributes:
+ label: Environment
+ description: Bug report without environment information will be ignored
or closed.
+ value: |
+ - your apisix-ingress-controller version (output of
apisix-ingress-controller version --long):
+ - your Kubernetes cluster version (output of kubectl version):
+ - if you run apisix-ingress-controller in Bare-metal environment, also
show your OS version (uname -a):
+ validations:
+ required: true
+ - type: textarea
+ id: steps
+ attributes:
+ label: Minimal test code / Steps to reproduce
+ description: Bug report without steps to reproduce will be ignored or
closed.
+ placeholder: |
+ 1.
+ 2.
+ 3.
+ validations:
+ required: true
+ - type: textarea
+ id: actual
+ attributes:
+ label: Actual result
+ description: What's the actual result? (including assertion message &
call stack if applicable).
+ validations:
+ required: true
+ - type: textarea
+ id: Error
+ attributes:
+ label: Error log
+ description: You can adjust the [error log
level](https://github.com/apache/apisix/blob/617c325628f33961be67f61f0fa8002afc370e42/docs/en/latest/FAQ.md#how-to-change-the-log-level)
and paste more related error.log.
+ validations:
+ required: true
+ - type: textarea
+ id: expected
+ attributes:
+ label: Expected result
+ description: What's the expected result?
diff --git a/.github/ISSUE_TEMPLATE/request-help.md
b/.github/ISSUE_TEMPLATE/request-help.md
deleted file mode 100644
index f97199e..0000000
--- a/.github/ISSUE_TEMPLATE/request-help.md
+++ /dev/null
@@ -1,16 +0,0 @@
----
-name: Request help template
-about: Please use this template for requesting help.
-title: 'request help: '
-labels: ''
-assignees: ''
-
----
-
-### Issue description
-
-### Environment
-
-* your apisix-ingress-controller version (output of `apisix-ingress-controller
version --long`);
-* your Kubernetes cluster version (output of `kubectl version`);
-* if you run apisix-ingress-controller in Bare-metal environment, also show
your OS version (`uname -a`).
diff --git a/.github/ISSUE_TEMPLATE/request_help.yml
b/.github/ISSUE_TEMPLATE/request_help.yml
new file mode 100644
index 0000000..e20e2ae
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/request_help.yml
@@ -0,0 +1,31 @@
+name: "Request help"
+description: Please use this template for requesting help.
+title: "request help: "
+body:
+ - type: markdown
+ attributes:
+ value: |
+ The more information you fill in, the better we can help you.
+
+ - Please use English on public channel.
+ - Encourage using words rather than pictures to describe errors.
+ - Encourage pre-searching with keywords in the issue.
+
+ - type: textarea
+ id: description
+ attributes:
+ label: Issue description
+ description: Provide a clear and concise description of the help you
need.
+ validations:
+ required: true
+ - type: textarea
+ id: environment
+ attributes:
+ label: Environment
+ description: Request help without environment information will be
ignored or closed.
+ value: |
+ - your apisix-ingress-controller version (output of
apisix-ingress-controller version --long):
+ - your Kubernetes cluster version (output of kubectl version):
+ - if you run apisix-ingress-controller in Bare-metal environment, also
show your OS version (uname -a):
+ validations:
+ required: true
diff --git a/.github/PULL_REQUEST_TEMPLATE b/.github/PULL_REQUEST_TEMPLATE
index 74f8569..3e65585 100644
--- a/.github/PULL_REQUEST_TEMPLATE
+++ b/.github/PULL_REQUEST_TEMPLATE
@@ -1,29 +1,30 @@
-Please answer these questions before submitting a pull request
+<!-- Please answer these questions before submitting a pull request -->
+
+### Type of change:
+
+<!-- Please delete options that are not relevant. -->
-- Why submit this pull request?
- [ ] Bugfix
- [ ] New feature provided
- [ ] Improve performance
- [ ] Backport patches
-- Related issues
-
-___
-### Bugfix
-- Description
-
-- How to fix?
-
-___
-### New feature or improvement
-- Describe the details and related test reports.
-
-___
-### Backport patches
-- Why need to backport?
-
-- Source branch
-
-- Related commits and pull requests
-
-- Target branch
+### What this PR does / why we need it:
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here. -->
+
+### Pre-submission checklist:
+
+<!--
+Please follow the requirements:
+1. Use Draft if the PR is not ready to be reviewed
+2. Test is required for the feat/fix PR, unless you have a good reason
+3. Doc is required for the feat PR
+4. Use a new commit to resolve review instead of `push -f`
+5. Use "request review" to notify the reviewer once you have resolved the
review
+-->
+
+* [ ] Did you explain what problem does this PR solve? Or what new features
have been added?
+* [ ] Have you added corresponding test cases?
+* [ ] Have you modified the corresponding document?
+* [ ] Is this PR backward compatible? **If it is not backward compatible,
please discuss on the [mailing
list](https://github.com/apache/apisix-ingress-controller#community) first**
