diff options
Diffstat (limited to 'src/tools/clippy/.github/ISSUE_TEMPLATE')
7 files changed, 343 insertions, 0 deletions
diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/blank_issue.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/blank_issue.yml new file mode 100644 index 000000000..89884bfc8 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/blank_issue.yml @@ -0,0 +1,44 @@ +name: Blank Issue +description: Create a blank issue. +body: + - type: markdown + attributes: + value: Thank you for filing an issue! + - type: textarea + id: problem + attributes: + label: Description + description: > + Please provide a description of the issue, along with any information + you feel relevant to replicate it. + validations: + required: true + - type: textarea + id: version + attributes: + label: Version + description: "Rust version (`rustc -Vv`)" + placeholder: | + 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 + render: text + - type: textarea + id: labels + attributes: + label: Additional Labels + description: > + Additional labels can be added to this issue by including the following + command + placeholder: | + @rustbot label +<label> + + Common labels for this issue type are: + * C-an-interesting-project + * C-enhancement + * C-question + * C-tracking-issue diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/bug_report.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 000000000..b6f70a7f1 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,57 @@ +name: Bug Report +description: Create a bug report for Clippy +labels: ["C-bug"] +body: + - type: markdown + attributes: + value: Thank you for filing a bug report! 🐛 + - type: textarea + id: problem + attributes: + label: Summary + description: > + Please provide a short summary of the bug, along with any information + you feel relevant to replicate the bug. + validations: + required: true + - type: textarea + id: reproducer + attributes: + label: Reproducer + description: Please provide the code and steps to reproduce the bug + value: | + I tried this code: + + ```rust + <code> + ``` + + I expected to see this happen: + + Instead, this happened: + - type: textarea + id: version + attributes: + label: Version + description: "Rust version (`rustc -Vv`)" + placeholder: | + 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 + render: text + - type: textarea + id: labels + attributes: + label: Additional Labels + description: > + Additional labels can be added to this issue by including the following + command + placeholder: | + @rustbot label +<label> + + Common labels for this issue type are: + * `I-suggestion-causes-error` diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/config.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 000000000..bd7dc0ac9 --- /dev/null +++ b/src/tools/clippy/.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/src/tools/clippy/.github/ISSUE_TEMPLATE/false_negative.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/false_negative.yml new file mode 100644 index 000000000..25e436d30 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/false_negative.yml @@ -0,0 +1,50 @@ +name: Bug Report (False Negative) +description: Create a bug report about missing warnings from a lint +labels: ["C-bug", "I-false-negative"] +body: + - type: markdown + attributes: + value: Thank you for filing a bug report! 🐛 + - type: textarea + id: problem + attributes: + label: Summary + description: > + Please provide a short summary of the bug, along with any information + you feel relevant to replicate the bug. + validations: + required: true + - type: input + id: lint-name + attributes: + label: Lint Name + description: Please provide the lint name. + - type: textarea + id: reproducer + attributes: + label: Reproducer + description: Please provide the code and steps to reproduce the bug + value: | + I tried this code: + + ```rust + <code> + ``` + + I expected to see this happen: + + Instead, this happened: + - type: textarea + id: version + attributes: + label: Version + description: "Rust version (`rustc -Vv`)" + placeholder: | + 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 + render: text diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/false_positive.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/false_positive.yml new file mode 100644 index 000000000..561b65c93 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/false_positive.yml @@ -0,0 +1,68 @@ +name: Bug Report (False Positive) +description: Create a bug report about a wrongly emitted lint warning +labels: ["C-bug", "I-false-positive"] +body: + - type: markdown + attributes: + value: Thank you for filing a bug report! 🐛 + - type: textarea + id: problem + attributes: + label: Summary + description: > + Please provide a short summary of the bug, along with any information + you feel relevant to replicate the bug. + validations: + required: true + - type: input + id: lint-name + attributes: + label: Lint Name + description: Please provide the lint name. + - type: textarea + id: reproducer + attributes: + label: Reproducer + description: > + Please provide the code and steps to reproduce the bug together with the + output from Clippy. + value: | + I tried this code: + + ```rust + <code> + ``` + + I saw this happen: + + ``` + <output> + ``` + + I expected to see this happen: + - type: textarea + id: version + attributes: + label: Version + description: "Rust version (`rustc -Vv`)" + placeholder: | + 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 + render: text + - type: textarea + id: labels + attributes: + label: Additional Labels + description: > + Additional labels can be added to this issue by including the following + command + placeholder: | + @rustbot label +<label> + + Common labels for this issue type are: + * `I-suggestion-causes-error` diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/ice.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/ice.yml new file mode 100644 index 000000000..81bd9c5e0 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/ice.yml @@ -0,0 +1,48 @@ +name: Internal Compiler Error +description: Create a report for an internal compiler error (ICE) in Clippy. +labels: ["C-bug", "I-ICE"] +body: + - type: markdown + attributes: + value: Thank you for finding an Internal Compiler Error! 🧊 + - type: textarea + id: problem + attributes: + label: Summary + description: | + If possible, try to provide a minimal verifiable example. You can read ["Rust Bug Minimization Patterns"][mve] for how to create smaller examples. Otherwise, provide the crate where the ICE occurred. + + [mve]: http://blog.pnkfx.org/blog/2019/11/18/rust-bug-minimization-patterns/ + validations: + required: true + - type: textarea + id: version + attributes: + label: Version + description: "Rust version (`rustc -Vv`)" + placeholder: | + 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 + render: text + - type: textarea + id: error + attributes: + label: Error output + description: > + Include a backtrace in the code block by setting `RUST_BACKTRACE=1` in + your environment. E.g. `RUST_BACKTRACE=1 cargo clippy`. + value: | + <details><summary>Backtrace</summary> + <p> + + ``` + <backtrace> + ``` + + </p> + </details> diff --git a/src/tools/clippy/.github/ISSUE_TEMPLATE/new_lint.yml b/src/tools/clippy/.github/ISSUE_TEMPLATE/new_lint.yml new file mode 100644 index 000000000..0b43d8d70 --- /dev/null +++ b/src/tools/clippy/.github/ISSUE_TEMPLATE/new_lint.yml @@ -0,0 +1,71 @@ +name: New lint suggestion +description: Suggest a new Clippy lint. +labels: ["A-lint"] +body: + - type: markdown + attributes: + value: Thank you for your lint idea! + - type: textarea + id: what + attributes: + label: What it does + description: What does this lint do? + validations: + required: true + - type: input + id: lint-name + attributes: + label: Lint Name + description: Please provide the lint name. + - type: dropdown + id: category + attributes: + label: Category + description: > + What category should this lint go into? If you're unsure you can select + multiple categories. You can find a category description in the + `README`. + multiple: true + options: + - correctness + - suspicious + - style + - complexity + - perf + - pedantic + - restriction + - cargo + - type: textarea + id: advantage + attributes: + label: Advantage + description: > + What is the advantage of the recommended code over the original code? + placeholder: | + - Remove bounds check inserted by ... + - Remove the need to duplicate/store ... + - Remove typo ... + - type: textarea + id: drawbacks + attributes: + label: Drawbacks + description: What might be possible drawbacks of such a lint? + - type: textarea + id: example + attributes: + label: Example + description: > + Include a short example showing when the lint should trigger together + with the improved code. + value: | + ```rust + <code> + ``` + + Could be written as: + + ```rust + <code> + ``` + validations: + required: true |