Skip to content

Commit

Permalink
Add issue templates (hashicorp#689)
Browse files Browse the repository at this point in the history
  • Loading branch information
ndhanushkodi authored Nov 18, 2020
1 parent a793e70 commit 68d93b5
Show file tree
Hide file tree
Showing 4 changed files with 111 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
name: Bug Report
about: You're experiencing an issue with the Consul Helm chart that is different than the documented behavior.
labels: bug

---

When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.

### Overview of the Issue

A paragraph or two about the issue you're experiencing.

### Reproduction Steps

Steps to reproduce this issue, eg:

1. When running helm install with the following `values.yml`:
```
global:
domain: consul
datacenter: dc1
server:
replicas: 1
bootstrapExpect: 1
connectInject:
enabled: true
controller:
enabled: true
```
1. View error

### Logs

Include any relevant logs.

<details>
<summary>Logs</summary>

```
output from 'kubectl logs' in relevant components
```

</details>

### Expected behavior

What was the expected result?

### Environment details

If not already included, please provide the following:
- `consul-k8s` version:
- `consul-helm` version:
- `values.yaml` used to deploy the helm chart:

Any other information you can provide about the environment/deployment.

### Additional Context

Additional context on the problem.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Consul on Kubernetes GitHub Issues
url: https://github.com/hashicorp/consul-k8s/issues
about: Are you submitting an issue or feature enhancement for the consul-k8s binary? Please create an issue in the consul-k8s repository.
- name: Consul on Kubernetes Learn Tutorials
url: https://learn.hashicorp.com/collections/consul/kubernetes
about: Please check out our Learn Tutorials. These hands on tutorials deal with many of the tasks common to using Consul on Kubernetes.
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Feature Request
about: If you have something you think Consul Helm could improve or add support for.
labels: enhancement

---

Please search the existing issues for relevant feature requests, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing requests.

#### Is your feature request related to a problem? Please describe.

A clear and concise description of what the problem is.

#### Feature Description

A written overview of the feature.

#### Use Case(s)

Any relevant use-cases that you see.

#### Contributions

Are you able to contribute the changes to make this feature work?

17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
name: Question
about: If you have a question.
labels: question

---
Please search the existing issues for relevant questions, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing questions.

#### Question

Please provide as many details as you can, including but not limited to
- Helm command you're running
- Any values you've configured
- Your current understanding, and what you're trying to figure out

More details will help us answer questions more accurately and with less delay :)

0 comments on commit 68d93b5

Please sign in to comment.