mirror of
https://github.com/spf13/viper
synced 2024-11-05 04:37:02 +00:00
chore: add GitHub issue forms
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
This commit is contained in:
Mark Sagi-Kazar
Márk Sági-Kazár
parent
e866eaa591
commit
ab4b05adc6
5 changed files with 150 additions and 56 deletions
2
.github/.editorconfig
vendored
2
.github/.editorconfig
vendored
|
|
@ -1,2 +1,2 @@
|
|||
[*.yml]
|
||||
[{*.yml,*.yaml}]
|
||||
indent_size = 2
|
||||
|
|
|
|||
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,34 +0,0 @@
|
|||
---
|
||||
name: 🐛 Bug report
|
||||
about: Report a bug to help us improve Viper
|
||||
labels: kind/bug
|
||||
---
|
||||
<!--
|
||||
Thank you for sending a bug report! Here are some tips:
|
||||
|
||||
1. Please fill out the template below to make it easier to debug your problem.
|
||||
2. If you are not sure if it is a bug or not, you can ask in the Gophers slack channel `#viper`.
|
||||
-->
|
||||
|
||||
**Expected behavior (what you expected to happen)**:
|
||||
|
||||
**Actual behavior (what actually happened)**:
|
||||
|
||||
**Repl.it link**:
|
||||
<!-- you can use the following example: https://repl.it/@sagikazarmark/Viper-example -->
|
||||
|
||||
**Code reproducing the issue**:
|
||||
<!-- just to make sure the content of the repl doesn't get lost -->
|
||||
|
||||
```go
|
||||
|
||||
```
|
||||
|
||||
<!-- include configuration file example if necessary -->
|
||||
|
||||
**Environment**:
|
||||
- Viper version:
|
||||
- Config source: <!-- flag, env, file, etc -->
|
||||
- File format: <!-- JSON, YAML, TOML, etc -->
|
||||
|
||||
**Anything else we should know?**:
|
||||
110
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
110
.github/ISSUE_TEMPLATE/bug_report.yaml
vendored
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
name: 🐛 Bug report
|
||||
description: Report a bug to help us improve Viper
|
||||
labels: [kind/bug]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for submitting a bug report!
|
||||
|
||||
Please fill out the template below to make it easier to debug your problem.
|
||||
|
||||
If you are not sure if it is a bug or not, you can contact us via the available [support channels](https://github.com/spf13/viper/issues/new/choose).
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Preflight Checklist
|
||||
description: Please ensure you've completed all of the following.
|
||||
options:
|
||||
- label: I have searched the [issue tracker](https://www.github.com/spf13/viper/issues) for an issue that matches the one I want to file, without success.
|
||||
required: true
|
||||
- label: I am not looking for support or already pursued the available [support channels](https://github.com/spf13/viper/issues/new/choose) without success.
|
||||
required: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Version
|
||||
description: What version of Viper are you using?
|
||||
placeholder: 1.8.1
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Config Source
|
||||
description: What sources do you load configuration from?
|
||||
options:
|
||||
- Manual set
|
||||
- Flags
|
||||
- Environment variables
|
||||
- Files
|
||||
- Remove K/V stores
|
||||
- Defaults
|
||||
multiple: true
|
||||
validations:
|
||||
required: true
|
||||
- type: dropdown
|
||||
attributes:
|
||||
label: Format
|
||||
description: Which file formats do you use?
|
||||
options:
|
||||
- JSON
|
||||
- YAML
|
||||
- TOML
|
||||
- Dotenv
|
||||
- HCL
|
||||
- Java properties
|
||||
- INI
|
||||
- Other (specify below)
|
||||
multiple: true
|
||||
- type: input
|
||||
attributes:
|
||||
label: Repl.it link
|
||||
description: Complete example on Repl.it reproducing the issue. [Here](https://repl.it/@sagikazarmark/Viper-example) is an example you can use.
|
||||
placeholder: https://repl.it/@sagikazarmark/Viper-example
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Code reproducing the issue
|
||||
description: Please provide a Repl.it link if possible.
|
||||
render: go
|
||||
placeholder: |
|
||||
package main
|
||||
|
||||
import (
|
||||
"github.com/spf13/viper"
|
||||
)
|
||||
|
||||
func main() {
|
||||
v := viper.New()
|
||||
|
||||
// ...
|
||||
|
||||
var config Config
|
||||
|
||||
err = v.Unmarshal(&config)
|
||||
if err != nil {
|
||||
panic(err)
|
||||
}
|
||||
}
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: A clear and concise description of what you expected to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: A clear description of what actually happens.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Steps To Reproduce
|
||||
description: Steps to reproduce the behavior if it is not self-explanatory.
|
||||
placeholder: |
|
||||
1. In this environment...
|
||||
2. With this config...
|
||||
3. Run '...'
|
||||
4. See error...
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Links? References? Anything that will give us more context about the issue that you are encountering!
|
||||
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
21
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
|
@ -1,21 +0,0 @@
|
|||
---
|
||||
name: 🚀 Feature request
|
||||
about: Suggest an idea for Viper
|
||||
labels: kind/enhancement
|
||||
---
|
||||
<!--
|
||||
Thank you for sending a feature request!
|
||||
Please describe what you would like to change/add and why in detail by filling out the template below.
|
||||
-->
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
|
||||
|
||||
**Describe the solution you'd like to see**
|
||||
<!-- A clear and concise description of what would you like to happen. -->
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
|
||||
|
||||
**Additional context**
|
||||
<!-- Add any other context or screenshots about the feature request here. -->
|
||||
39
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
39
.github/ISSUE_TEMPLATE/feature_request.yaml
vendored
Normal file
|
|
@ -0,0 +1,39 @@
|
|||
name: 🚀 Feature request
|
||||
description: Suggest an idea for Viper
|
||||
labels: [kind/enhancement]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thank you for submitting a feature request!
|
||||
|
||||
Please describe what you would like to change/add and why in detail by filling out the template below.
|
||||
|
||||
If you are not sure if your request fits into Viper, you can contact us via the available [support channels](https://github.com/spf13/viper/issues/new/choose).
|
||||
- type: checkboxes
|
||||
attributes:
|
||||
label: Preflight Checklist
|
||||
description: Please ensure you've completed all of the following.
|
||||
options:
|
||||
- label: I have searched the [issue tracker](https://www.github.com/spf13/viper/issues) for an issue that matches the one I want to file, without success.
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Problem Description
|
||||
description: A clear and concise description of the problem you are seeking to solve with this feature request.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: A clear and concise description of what would you like to happen.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Alternatives Considered
|
||||
description: A clear and concise description of any alternative solutions or features you've considered.
|
||||
- type: textarea
|
||||
attributes:
|
||||
label: Additional Information
|
||||
description: Add any other context about the problem here.
|
||||
Loading…
Reference in a new issue