Update issue templates

This commit is contained in:
CreepySkeleton 2020-02-13 23:43:23 +03:00 committed by GitHub
parent a2dfbec2bc
commit 23bb900dca
4 changed files with 108 additions and 0 deletions

37
.github/ISSUE_TEMPLATE/bug_report.md vendored Normal file
View file

@ -0,0 +1,37 @@
---
name: Bug report
about: An issue with clap, clap_derive or clap_generate
title: ''
labels: 'T: bug'
assignees: ''
---
<!--
Please use the following template to assist with creating an issue and to ensure a speedy resolution. If an area is not applicable, feel free to delete the area or mark with `N/A`
-->
### Rust Version
Use the output of `rustc -V`
### Affected Version of `clap*`
Can be found in Cargo.lock or Cargo.toml of your project (i.e. `grep clap Cargo.lock`). PLEASE DO NOT PUT "latest" HERE, use precise version. Put `master` (or other branch) if you're using the repo directly.
### Expected Behavior Summary
When I do like *this*, *that* is happening and I think it shouldn't.
### Actual Behavior Summary
I think *this* should happen instead.
### Steps to reproduce the issue
1. Write *this* code '...'
2. Run `cargo run` '....'
3. See error
### Additional context
Add any other context about the problem here.

View file

@ -0,0 +1,24 @@
---
name: Documentation issue
about: An issue with our docs, like typo, something's missing, incorrect docs, etc...
title: ''
labels: 'C: docs'
assignees: ''
---
### Clap version
Can be found in Cargo.lock or Cargo.toml of your project (i.e. grep clap Cargo.lock). PLEASE DO NOT PUT "latest" HERE, use precise version. Put master (or other branch) if you're using the repo directly.
### Where?
A hyperlink, file path, some item, *something*.
### What's wrong
Explain what the issue is about, like - "The doc says that the sun is green!".
### How to fix
Any solution you think is right, like - "Everybody knows that the sun is blue!". Optional.

View file

@ -0,0 +1,25 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: 'T: new feature'
assignees: ''
---
### Describe your use case
Describe the problem you're trying to solve. This is not mandatory and we *do* consider features without a specific use case, but real problems have priority.
Also, please follow your explanation with a snippet of code, if applicable.
### Describe the solution you'd like
Please explain what the wanted solution should look like. You **strongly encouraged** to attach a snippet of (pseudo)code.
### Alternatives, if applicable
A clear and concise description of any alternative solutions or features you've managed to come up with.
### Additional context
Add any other context about the feature request here.

22
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View file

@ -0,0 +1,22 @@
---
name: Question
about: You've come here to seek help. You've come to the right place!
title: ''
labels: 'T: RFC / question'
assignees: ''
---
### What are you trying to do?
Explain **in detail** what your problem is.
Please include examples of the CLI you desire to make. Examples of command line invocations are **strongly encouraged**.
```bash
$ app we --opt val subcmd --val
```
### What have you tried already?
Describe solutions you have already tried (if any) but they didn't work for some reason (describe the reason).