diff options
| author | bors <bors@rust-lang.org> | 2020-06-23 13:40:02 +0000 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2020-06-23 13:40:02 +0000 |
| commit | 9504efc94ea6784164dcad89cf4af87c439d138d (patch) | |
| tree | 0c3bc2f26584d9a1aa2d7da5e09ec66f2a6cb6aa | |
| parent | b452ad3c0bf27ddfe0bc018a5f3cd64538f64399 (diff) | |
| parent | 51c3b42ef33f14cb40aa440d2d432e4c70e028b0 (diff) | |
| download | rust-9504efc94ea6784164dcad89cf4af87c439d138d.tar.gz rust-9504efc94ea6784164dcad89cf4af87c439d138d.zip | |
Auto merge of #5735 - lzutao:issue-temp, r=flip1995
Add more specific GitHub issue templates changelog: Make it easier to create feature request and bug reports with issue templates.
| -rw-r--r-- | .github/ISSUE_TEMPLATE.md | 8 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/blank_issue.md | 4 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/bug_report.md | 47 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/config.yml | 5 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/ice.md | 53 | ||||
| -rw-r--r-- | .github/ISSUE_TEMPLATE/new_lint.md | 35 | ||||
| -rw-r--r-- | .github/PULL_REQUEST_TEMPLATE.md | 1 |
7 files changed, 145 insertions, 8 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md deleted file mode 100644 index 15006a07b44..00000000000 --- a/.github/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,8 +0,0 @@ -<!-- -Hi there! Whether you've come to make a suggestion for a new lint, an improvement to an existing lint or to report a bug or a false positive in Clippy, you've come to the right place. - -For bug reports and false positives, please include the output of `cargo clippy -V` in the report. - -Thank you for using Clippy! - -Write your comment below this line: --> diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md new file mode 100644 index 00000000000..9aef3ebe637 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank_issue.md @@ -0,0 +1,4 @@ +--- +name: Blank Issue +about: Create a blank issue. +--- diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000000..d8f0c44148c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,47 @@ +--- +name: Bug Report +about: Create a bug report for Clippy +labels: L-bug +--- +<!-- +Thank you for filing a bug report! 🐛 Please provide a short summary of the bug, +along with any information you feel relevant to replicating the bug. +--> + +I tried this code: + +```rust +<code> +``` + +I expected to see this happen: *explanation* + +Instead, this happened: *explanation* + +### Meta + +- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20) +- `rustc -Vv`: + ``` + rustc 1.46.0-nightly (f455e46ea 2020-06-20) + binary: rustc + commit-hash: f455e46eae1a227d735091091144601b467e1565 + commit-date: 2020-06-20 + host: x86_64-unknown-linux-gnu + release: 1.46.0-nightly + LLVM version: 10.0 + ``` + +<!-- +Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your +environment. E.g. `RUST_BACKTRACE=1 cargo clippy`. +--> +<details><summary>Backtrace</summary> + <p> + + ``` + <backtrace> + ``` + + </p> +</details> diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..bd7dc0ac95c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: true +contact_links: + - name: Rust Programming Language Forum + url: https://users.rust-lang.org + about: Please ask and answer questions about Rust here. diff --git a/.github/ISSUE_TEMPLATE/ice.md b/.github/ISSUE_TEMPLATE/ice.md new file mode 100644 index 00000000000..3abe76bf2c4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/ice.md @@ -0,0 +1,53 @@ +--- +name: Internal Compiler Error +about: Create a report for an internal compiler error in Clippy. +labels: L-bug, L-crash +--- +<!-- +Thank you for finding an Internal Compiler Error! 🧊 If possible, try to provide +a minimal verifiable example. You can read "Rust Bug Minimization Patterns" for +how to create smaller examples. + +http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/ + +--> + +### Code + +```rust +<code> +``` + +### Meta + +- `cargo clippy -V`: e.g. clippy 0.0.212 (f455e46 2020-06-20) +- `rustc -Vv`: + ``` + rustc 1.46.0-nightly (f455e46ea 2020-06-20) + binary: rustc + commit-hash: f455e46eae1a227d735091091144601b467e1565 + commit-date: 2020-06-20 + host: x86_64-unknown-linux-gnu + release: 1.46.0-nightly + LLVM version: 10.0 + ``` + +### Error output + +``` +<output> +``` + +<!-- +Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in your +environment. E.g. `RUST_BACKTRACE=1 cargo clippy`. +--> +<details><summary>Backtrace</summary> + <p> + + ``` + <backtrace> + ``` + + </p> +</details> diff --git a/.github/ISSUE_TEMPLATE/new_lint.md b/.github/ISSUE_TEMPLATE/new_lint.md new file mode 100644 index 00000000000..70445d7ef25 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/new_lint.md @@ -0,0 +1,35 @@ +--- +name: New lint suggestion +about: Suggest a new Clippy lint. +labels: L-lint +--- + +### What it does + +*What does this lint do?* + +### Categories (optional) + +- Kind: *See <https://github.com/rust-lang/rust-clippy/blob/master/README.md#clippy> for list of lint kinds* + +*What benefit of this lint over old code?* + +For example: +- Remove bounce checking inserted by ... +- Remove the need to duplicating/storing/typo ... + +### Drawbacks + +None. + +### Example + +```rust +<code> +``` + +Could be written as: + +```rust +<code> +``` diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 97aa220afea..137a7363094 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -28,4 +28,5 @@ Delete this line and everything above before opening your PR. --- +*Please keep the line below* changelog: none |
