chore: github form templates

This commit is contained in:
CrazyMax
2023-05-05 00:30:29 +02:00
parent d3981a5601
commit 85c29d6910
4 changed files with 117 additions and 39 deletions

96
.github/ISSUE_TEMPLATE/bug.yml vendored Normal file
View File

@@ -0,0 +1,96 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Bug Report
description: Report a bug
labels:
- status/triage
body:
- type: checkboxes
attributes:
label: Support guidelines
description: Please read the support guidelines before proceeding.
options:
- label: I've read the [support guidelines](https://github.com/crazy-max/diun/blob/master/.github/SUPPORT.md)
required: true
- type: checkboxes
attributes:
label: I've found a bug and checked that ...
description: |
Make sure that your request fulfills all of the following requirements. If one requirement cannot be satisfied, explain in detail why.
options:
- label: ... the documentation does not mention anything about my problem
- label: ... there are no open or closed issues that are related to my problem
- type: textarea
attributes:
label: Description
description: |
Please provide a brief description of the bug in 1-2 sentences.
validations:
required: true
- type: textarea
attributes:
label: Expected behaviour
description: |
Please describe precisely what you'd expect to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behaviour
description: |
Please describe precisely what is actually happening.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
Please describe the steps to reproduce the bug.
placeholder: |
1. ...
2. ...
3. ...
validations:
required: true
- type: input
attributes:
label: Diun version
validations:
required: true
- type: textarea
attributes:
label: Docker info
description: |
Output of `docker info` command.
render: text
validations:
required: true
- type: textarea
attributes:
label: Docker Compose config
description: |
Output of `docker compose config` command (if applicable).
render: yaml
- type: textarea
attributes:
label: Logs
description: |
Please provide the container logs (set log-level to debug and enable log-caller).
render: text
validations:
required: true
- type: textarea
attributes:
label: Additional info
description: |
Please provide any additional information that seem useful.

View File

@@ -1,39 +0,0 @@
---
name: Bug report
about: Create a report to help us improve
---
## Behaviour
### Steps to reproduce this issue
1.
2.
3.
### Expected behaviour
> Tell me what should happen
### Actual behaviour
> Tell me what happens instead
## Configuration
* Diun version :
* Platform (windows/linux) :
* System info (type `uname -a`) :
> Paste your configuration files here
> * docker-compose.yml
> * k8s deployment configuration
> * environment variables
> * diun config file
> * ...
### Logs
```
# paste logs here (set log-level to debug and enable log-caller)
```

6
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,6 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
blank_issues_enabled: true
contact_links:
- name: Questions and Discussions
url: https://github.com/crazy-max/diun/discussions/new
about: Use Github Discussions to ask questions and/or open discussion topics.

15
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@@ -0,0 +1,15 @@
# https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
name: Feature request
description: Missing functionality? Come tell us about it!
labels:
- kind/enhancement
- status/triage
body:
- type: textarea
id: description
attributes:
label: Description
description: What is the feature you want to see?
validations:
required: true