Skip to content

Commit feb76f3

Browse files
author
TheSnoozer
committed
improve issue templates
1 parent d041bab commit feb76f3

5 files changed

Lines changed: 152 additions & 51 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 35 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: Bug Report
2+
description: Create a bug report to help us fix an issue
3+
labels: [ "bug", "to-triage" ]
4+
assignees: [ ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow the instructions below.
10+
We will close issues that don't provide enough information.
11+
- type: textarea
12+
id: describe-the-bug
13+
attributes:
14+
label: Describe the bug (required)
15+
description: Please provide a brief summary of the issue and provide a summarised description in the title above.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: plugin-configuration
20+
attributes:
21+
label: Tell us about your plugin configuration (required)
22+
description: Include the **full** configuration of the plugin.
23+
value: |
24+
```xml
25+
<plugin>
26+
...
27+
</plugin>
28+
```
29+
validations:
30+
required: true
31+
- type: input
32+
id: plugin-version
33+
attributes:
34+
label: Tell us about the Plugin version used (required)
35+
description: What version of the Plugin are you using?
36+
validations:
37+
required: true
38+
- type: textarea
39+
id: maven-version
40+
attributes:
41+
label: Tell us about the Maven version used (required)
42+
description: What version of Maven are you running?
43+
value: |
44+
```bash
45+
mvn --version
46+
// ????
47+
```
48+
validations:
49+
required: true
50+
- type: textarea
51+
id: steps-to-reproduce
52+
attributes:
53+
label: Steps to Reproduce (required)
54+
description: |
55+
Please provide all the steps to experience the issue.
56+
value: |
57+
I run the plugin with ``mvn clean deploy`` VS ``mvn deploy:deploy``...
58+
validations:
59+
required: true
60+
- type: textarea
61+
id: steps-to-reproduce-stack-traces
62+
attributes:
63+
label: Are there any stacktraces or any error messages? (required)
64+
description: |
65+
Include any stack-traces or any error messages that are included.
66+
For your own troubleshooting you may want to enable the `verbose` mode of the plugin in your `pom.xml`:
67+
```xml
68+
<plugin>
69+
<groupId>io.github.git-commit-id</groupId>
70+
<artifactId>git-commit-id-maven-plugin</artifactId>
71+
<version>5.0.0</version>
72+
<configuration>
73+
<verbose>true</verbose>
74+
<!-- your settings ... -->
75+
</configuration>
76+
</plugin>
77+
```
78+
value: |
79+
**WARNING** You may **NOT** want to paste all the output that is produced with `verbose` publicly,
80+
since it **MAY** contain information you deem sensitive.
81+
Review this **CAREFULLY** before posting your issue!
82+
83+
```bash
84+
mvn clean deploy
85+
// ????
86+
```
87+
validations:
88+
required: true
89+
- type: textarea
90+
id: steps-to-reproduce-public-project
91+
attributes:
92+
label: Is there a (public) project where this issue can be reproduced? (optional)
93+
description: |
94+
You can use [this template](https://github.com/TheSnoozer/git-commit-id-debugging) to showcase your problem.
95+
validations:
96+
required: false
97+
- type: textarea
98+
id: environment
99+
attributes:
100+
label: Your Environment (optional)
101+
description: |
102+
Include as many relevant details about the environment you experienced the bug in.
103+
Are you running inside Windows Terminal, Powershell, Git Bash, /bin/bash, ...?
104+
On what Operating System you experience the bug (on Linux run ``lsb_release -a`` or ``cat /etc/*release*``)?
105+
validations:
106+
required: false
107+
- type: textarea
108+
id: context
109+
attributes:
110+
label: Context (optional)
111+
description: |
112+
Feel free to add any other context or screenshots about the bug.
113+
How are you affected? What is your goal? Anything else?
114+
validations:
115+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 16 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
labels: [ "enhancement", "to-triage" ]
4+
assignees: [ ]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please follow the instructions below.
10+
We will close issues that don't provide enough information.
11+
- type: textarea
12+
id: describe-the-idea
13+
attributes:
14+
label: Describe the idea (required)
15+
description: Please provide a brief summary of your idea and provide a summarised description in the title above.
16+
validations:
17+
required: true
18+
- type: textarea
19+
id: expected-behaviour
20+
attributes:
21+
label: Tell us about the expected behaviour (required)
22+
description: |
23+
If you're suggesting a change/improvement, tell us a bit more about the problem you attempt to solve and how you idea helps to solve it.
24+
Include a brief description of what you think should happen, maybe even how it should work and how you plan on using it.
25+
Ex. I'm always frustrated when [...]
26+
validations:
27+
required: true
28+
- type: textarea
29+
id: context
30+
attributes:
31+
label: Context (optional)
32+
description: |
33+
Feel free to add any other context or screenshots about the feature.
34+
How are you affected? What is your goal? Anything else?
35+
validations:
36+
required: false

0 commit comments

Comments
 (0)