1691: Update issue templates r=pksunkara a=CreepySkeleton



Co-authored-by: CreepySkeleton <creepy-skeleton@yandex.ru>
This commit is contained in:
bors[bot] 2020-02-14 02:14:16 +00:00 committed by GitHub
commit bbb14f8bd4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 121 additions and 1 deletions

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

@ -0,0 +1,39 @@
---
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.
### Actual Behavior Summary
When I do like *this*, *that* is happening and I think it shouldn't.
**If a project of yours is blocked due to this bug, please, mention it explicitely.**
### Expected 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,27 @@
---
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.
**If a project of yours is blocked on this feature, please, mention it explicitely.**
### Describe the solution you'd like
Please explain what the wanted solution should look like. You are **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).

8
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,8 @@
<!-- DO NOT DELETE THIS LINE! Internal hack, the shame is on you, bors! -->
<!--
If your PR closes some issues, please, put `Closes #XXXX`
lines to this comment (no quotes), where `XXXX` is the number
of the issue you want to fix. Each issue goes on it's own line.
YOUR COMMENT GOES BELOW
-->

View file

@ -9,5 +9,5 @@ pr_status = [
timeout_sec = 7200
prerun_timeout_sec = 7200
delete_merged_branches = true
cut_body_after = "\n\n"
cut_body_after = "<!-- DO NOT DELETE THIS LINE!"
block_lables = ["R: blocked", "R: require changes"]