Skip to content

Commit 970b863

Browse files
authored
Merge pull request #237 from xFrednet/000-issue-templates
Chore: Add magnificent new issue templates
2 parents 4ec73a6 + 4128968 commit 970b863

File tree

5 files changed

+122
-0
lines changed

5 files changed

+122
-0
lines changed

.github/ISSUE_TEMPLATE/blank_issue.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
name: Blank Issue
3+
about: 'Create an issue 📨.'
4+
labels: 'S-needs-triage'
5+
---

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Bug Report
2+
description: Create a bug report to help us improve
3+
title: "[Bug]: "
4+
labels: ["C-bug", "S-needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for reporting a bug! 🐛
9+
- type: textarea
10+
id: summary
11+
attributes:
12+
label: Summary
13+
description: |
14+
Summarize the issue and include any required information.
15+
- type: textarea
16+
id: reproducer
17+
attributes:
18+
label: Reproducer
19+
description: |
20+
Describe how the bug can be reproduced. Please include the following information if applicable:
21+
* The checked code that causes the bug
22+
* The lint implementation
23+
placeholder: |
24+
1. Take this code
25+
```rust
26+
```
27+
2. This lint crate check
28+
```rust
29+
```
30+
3. Run `cargo marker`
31+
4. See error
32+
- type: textarea
33+
id: version
34+
attributes:
35+
label: Version
36+
description: "Marker's version (`cargo marker -V`)"
37+
placeholder: |
38+
cargo-marker 0.2.1
39+
render: text
40+
- type: textarea
41+
id: logs
42+
attributes:
43+
label: Logs
44+
description: |
45+
Please try to include the full log, by setting the relevant environment values:
46+
* `MARKER_ERROR_TRACE=1 MARKER_LOG=info cargo marker`
47+
placeholder: |
48+
$ MARKER_ERROR_TRACE=1 MARKER_LOG=info cargo marker
49+
[...]
50+
render: text

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: Suggest A Feature
2+
description: Suggest a new feature
3+
title: "[Feat]: "
4+
labels: ["C-enhancement", "S-needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for suggesting a feature! 🪄
9+
- type: textarea
10+
id: summary
11+
attributes:
12+
label: Summary
13+
description: |
14+
Describe the feature or addition you would like to see.
15+
Please include a use case of this feature or describe the motivation behind this suggestion.

.github/ISSUE_TEMPLATE/panic.yml

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
name: Panic Report
2+
description: Report a panic or internal compiler error(ICE)
3+
title: "[Panic]: "
4+
labels: ["C-bug", "I-panic", "S-needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: Thank you for reporting a panic! ⚠️
9+
- type: textarea
10+
id: summary
11+
attributes:
12+
label: Summary
13+
description: |
14+
Summarize the issue and include any required information.
15+
- type: textarea
16+
id: reproducer
17+
attributes:
18+
label: Reproducer
19+
description: |
20+
Describe how the panic can be reproduced. Please include the following information if applicable:
21+
* The checked code that causes the bug
22+
* The lint implementation
23+
placeholder: |
24+
1. Take this code
25+
```rust
26+
```
27+
2. This lint crate check
28+
```rust
29+
```
30+
3. Run `cargo marker`
31+
4. See error
32+
- type: textarea
33+
id: version
34+
attributes:
35+
label: Version
36+
description: "Marker's version (`cargo marker -V`)"
37+
placeholder: |
38+
cargo-marker 0.2.1
39+
render: text
40+
- type: textarea
41+
id: logs
42+
attributes:
43+
label: Logs and Backtrace
44+
description: |
45+
Please try to include the full log and backtrace, by setting the relevant environment values:
46+
* `MARKER_ERROR_TRACE=1 MARKER_LOG=info RUST_BACKTRACE=1 cargo marker`
47+
placeholder: |
48+
$ MARKER_ERROR_TRACE=1 MARKER_LOG=info RUST_BACKTRACE=1 cargo marker
49+
[...]
50+
render: text

cargo-marker/src/cli.rs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ use std::collections::HashMap;
99
/// This binary should be invoked by Cargo with the new `marker` subcommand. If
1010
/// you're reading this, consider manually adding `marker` as the first argument.
1111
#[derive(Parser, Debug)]
12+
#[command(name = "cargo")]
13+
#[command(author, version, about)]
1214
struct MarkerApp {
1315
#[clap(subcommand)]
1416
subcommand: MarkerSubcommand,

0 commit comments

Comments
 (0)