Improve issue and pull request template (#4866)
This commit is contained in:
Manuel Alejandro de Brito Fontes
GitHub
parent
c2d6dcd162
commit
a5a5eb0c07
5 changed files with 195 additions and 56 deletions
49
.github/ISSUE_TEMPLATE.md
vendored
49
.github/ISSUE_TEMPLATE.md
vendored
|
|
@ -1,49 +0,0 @@
|
|||
<!-- Thanks for filing an issue! Before hitting the button, please answer these questions.-->
|
||||
|
||||
**Is this a request for help?** (If yes, you should use our troubleshooting guide and community support channels, see https://kubernetes.io/docs/tasks/debug-application-cluster/troubleshooting/.):
|
||||
|
||||
**What keywords did you search in NGINX Ingress controller issues before filing this one?** (If you have found any duplicates, you should instead reply there.):
|
||||
|
||||
---
|
||||
|
||||
**Is this a BUG REPORT or FEATURE REQUEST?** (choose one):
|
||||
|
||||
<!--
|
||||
If this is a BUG REPORT, please:
|
||||
- Fill in as much of the template below as you can. If you leave out
|
||||
information, we can't help you as well.
|
||||
|
||||
If this is a FEATURE REQUEST, please:
|
||||
- Describe *in detail* the feature/behavior/change you'd like to see.
|
||||
|
||||
In both cases, be ready for followup questions, and please respond in a timely
|
||||
manner. If we can't reproduce a bug or think a feature already exists, we
|
||||
might close your issue. If we're wrong, PLEASE feel free to reopen it and
|
||||
explain why.
|
||||
-->
|
||||
|
||||
**NGINX Ingress controller version**:
|
||||
|
||||
|
||||
**Kubernetes version** (use `kubectl version`):
|
||||
|
||||
|
||||
**Environment**:
|
||||
|
||||
- **Cloud provider or hardware configuration**:
|
||||
- **OS** (e.g. from /etc/os-release):
|
||||
- **Kernel** (e.g. `uname -a`):
|
||||
- **Install tools**:
|
||||
- **Others**:
|
||||
|
||||
|
||||
**What happened**:
|
||||
|
||||
|
||||
**What you expected to happen**:
|
||||
|
||||
|
||||
**How to reproduce it** (as minimally and precisely as possible):
|
||||
|
||||
|
||||
**Anything else we need to know**:
|
||||
98
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
98
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,98 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Problems and issues with code or docs
|
||||
title: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
|
||||
Welcome to ingress-nginx! For a smooth issue process, try to answer the following questions.
|
||||
Don't worry if they're not all applicable; just try to include what you can :-)
|
||||
|
||||
If you need to include code snippets or logs, please put them in fenced code
|
||||
blocks. If they're super-long, please use the details tag like
|
||||
<details><summary>super-long log</summary> lots of stuff </details>
|
||||
|
||||
-->
|
||||
|
||||
<!--
|
||||
|
||||
IMPORTANT!!!
|
||||
|
||||
Please complete the next sections or the issue will be closed.
|
||||
This questions are the first thing we need to know to understand the context.
|
||||
|
||||
-->
|
||||
|
||||
**NGINX Ingress controller version**:
|
||||
|
||||
**Kubernetes version** (use `kubectl version`):
|
||||
|
||||
**Environment**:
|
||||
|
||||
- **Cloud provider or hardware configuration**:
|
||||
- **OS** (e.g. from /etc/os-release):
|
||||
- **Kernel** (e.g. `uname -a`):
|
||||
- **Install tools**:
|
||||
- **Others**:
|
||||
|
||||
**What happened**:
|
||||
|
||||
<!-- (please include exact error messages if you can) -->
|
||||
|
||||
**What you expected to happen**:
|
||||
|
||||
<!-- What do you think went wrong? -->
|
||||
|
||||
**How to reproduce it**:
|
||||
<!---
|
||||
|
||||
As minimally and precisely as possible. Keep in mind we do not have access to your cluster or application.
|
||||
Help up us (if possible) reproducing the issue using minikube or kind.
|
||||
|
||||
## Install minikube/kind
|
||||
|
||||
- Minikube https://minikube.sigs.k8s.io/docs/start/
|
||||
- Kind https://kind.sigs.k8s.io/docs/user/quick-start/
|
||||
|
||||
## Install the ingress controller
|
||||
|
||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/mandatory.yaml
|
||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/baremetal/service-nodeport.yaml
|
||||
|
||||
## Install an application that will act as default backend (is just an echo app)
|
||||
|
||||
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/docs/examples/http-svc.yaml
|
||||
|
||||
## Create an ingress (please add any additional annotation required)
|
||||
|
||||
echo "
|
||||
apiVersion: networking.k8s.io/v1beta1
|
||||
kind: Ingress
|
||||
metadata:
|
||||
name: foo-bar
|
||||
spec:
|
||||
rules:
|
||||
- host: foo.bar
|
||||
http:
|
||||
paths:
|
||||
- backend:
|
||||
serviceName: http-svc
|
||||
servicePort: 80
|
||||
path: /
|
||||
" | kubectl apply -f -
|
||||
|
||||
## make a request
|
||||
|
||||
POD_NAME=$(k get pods -n ingress-nginx -l app.kubernetes.io/name=ingress-nginx -o NAME)
|
||||
kubectl exec -it -n ingress-nginx $POD_NAME -- curl -H 'Host: foo.bar' localhost
|
||||
|
||||
--->
|
||||
|
||||
**Anything else we need to know**:
|
||||
|
||||
<!-- If this is actually about documentation, add `/kind documentation` below -->
|
||||
|
||||
/kind bug
|
||||
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
30
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Suggest an idea for this project or its docs
|
||||
title: ''
|
||||
labels: kind/feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
|
||||
Welcome to ingress-nginx! For a smooth feature request process, try to
|
||||
answer the following questions. Don't worry if they're not all applicable; just
|
||||
try to include what you can :-)
|
||||
|
||||
If you need to include code snippets or logs, please put them in fenced code
|
||||
blocks. If they're super-long, please use the details tag like
|
||||
<details><summary>super-long log</summary> lots of stuff </details>
|
||||
|
||||
-->
|
||||
|
||||
<!-- What do you want to happen? -->
|
||||
|
||||
<!-- Is there currently another issue associated with this? -->
|
||||
|
||||
<!-- Does it require a particular kubernetes version? -->
|
||||
|
||||
<!-- If this is actually about documentation, add `/kind documentation` below -->
|
||||
|
||||
/kind feature
|
||||
37
.github/ISSUE_TEMPLATE/support-question.md
vendored
Normal file
37
.github/ISSUE_TEMPLATE/support-question.md
vendored
Normal file
|
|
@ -0,0 +1,37 @@
|
|||
---
|
||||
name: Question
|
||||
about: Any questions you might have.
|
||||
title: ''
|
||||
labels: triage/support
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
|
||||
Welcome to ingress-nginx!
|
||||
|
||||
You probably didn't want to be one this page. It shouldn't really be here anyway.
|
||||
|
||||
* If you want a quick response to a question, ask on the Kubernetes Slack instance in #ingress-nginx.
|
||||
|
||||
* If this is actually a bug or a feature request, file one of those. If you're
|
||||
not sure which, just take a guess and we can always re-label.
|
||||
|
||||
* If you think this might turn into a bug or feature request, but you're not
|
||||
sure, try asking in Slack first.
|
||||
|
||||
-->
|
||||
|
||||
<!--
|
||||
|
||||
Still here? Double-check that this hasn't been asked before, then put your question below
|
||||
with as many details as possible.
|
||||
|
||||
If you need to include code snippets or logs, please put them in fenced code
|
||||
blocks. If they're super-long, please use the details tag like
|
||||
<details><summary>super-long log</summary> lots of stuff </details>
|
||||
|
||||
-->
|
||||
|
||||
/triage support
|
||||
37
.github/PULL_REQUEST_TEMPLATE.md
vendored
37
.github/PULL_REQUEST_TEMPLATE.md
vendored
|
|
@ -1,10 +1,33 @@
|
|||
<!-- Thanks for sending a pull request! Here are some tips for you:
|
||||
1. If this is your first time, read our contributor guidelines https://git.k8s.io/community/contributors/guide/pull-requests.md#the-pull-request-submit-process and developer guide https://git.k8s.io/community/contributors/devel/development.md#development-guide
|
||||
2. If you want *faster* PR reviews, read how: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
|
||||
<!--- Provide a general summary of your changes in the Title above --->
|
||||
<!--- Please don't @-mention people in PR or commit messages (do so in an additional comment). --->
|
||||
|
||||
## 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. -->
|
||||
|
||||
## Types of changes
|
||||
<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
|
||||
|
||||
## Which issue/s this PR fixes
|
||||
<!--
|
||||
(optional, in `fixes #<issue number>` format, will close that issue when PR gets merged):
|
||||
|
||||
fixes #
|
||||
-->
|
||||
|
||||
**What this PR does / why we need it**:
|
||||
## How Has This Been Tested?
|
||||
<!--- Please describe in detail how you tested your changes. -->
|
||||
<!--- Include details of your testing environment, and the tests you ran to -->
|
||||
<!--- see how your change affects other areas of the code, etc. -->
|
||||
|
||||
**Which issue this PR fixes** *(optional, in `fixes #<issue number>(, fixes #<issue_number>, ...)` format, will close that issue when PR gets merged)*: fixes #
|
||||
|
||||
**Special notes for your reviewer**:
|
||||
## Checklist:
|
||||
<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
|
||||
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
|
||||
- [ ] My change requires a change to the documentation.
|
||||
- [ ] I have updated the documentation accordingly.
|
||||
- [ ] I've read the [CONTRIBUTION](https://github.com/kubernetes/ingress-nginx/blob/master/CONTRIBUTING.md) guide
|
||||
- [ ] I have added tests to cover my changes.
|
||||
- [ ] All new and existing tests passed.
|
||||
|
|
|
|||
Loading…
Reference in a new issue