Skip to content

Commit e4da776

Browse files
authored
docs: update issue form to include version info (#5682)
Given the amount of issues due to using outdated versions: - Require users to reproduce issues with the latest Super-linter version. - Remind users to use super-linter/super-linter, and not the deprecated github/super-linter. - Ask contributors to check that CI jobs pass. - Ask maintainers to put a PR in a milestone.
1 parent a86fbaf commit e4da776

File tree

3 files changed

+33
-8
lines changed

3 files changed

+33
-8
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,34 @@ body:
1313
label: Is there an existing issue for this?
1414
description: Search to see if an issue already exists for the bug you encountered.
1515
options:
16-
- label: I have searched the existing issues
17-
required: true
16+
- label: I have searched the existing issues
17+
required: true
18+
- type: checkboxes
19+
attributes:
20+
label: Are you using the latest Super-linter version available?
21+
description: |
22+
Ensure that you're using the latest Super-linter version.
23+
https://github.com/super-linter/super-linter/releases/latest
24+
options:
25+
- label: I am using the latest Super-linter version.
26+
required: true
27+
- label: |
28+
I can reproduce the issue running Super-linter using complete version identifier (example: vX.Y.Z), and not just with a partial one (example: vX)
29+
required: true
30+
- label: |
31+
I am using the super-linter/super-linter action or container image, and not the deprecated github/super-linter action or container image.
32+
required: true
33+
- type: checkboxes
34+
attributes:
35+
label: Are you resonably sure that it's a Super-linter issue, and not an issue related to a tool that Super-linter runs?
36+
description: |
37+
If you encounter a specific issue, ensure that the issue is about
38+
Super-linter, and not about a tool that Super-linter runs. For example,
39+
if a linter reports an unexpected or a surprising error, you may check
40+
if there are similar issues reported in that linter's issue tracker.
41+
options:
42+
- label: I think that this is a Super-linter issue.
43+
required: true
1844
- type: textarea
1945
attributes:
2046
label: Current Behavior
@@ -45,6 +71,7 @@ body:
4571
Copy and paste any relevant log output.
4672
This will be automatically formatted into code, so no need for backticks.
4773
Enable debug logging, either on GitHub Actions, or when running locally.
74+
Not attaching debug logging will delay the issue triaging process.
4875
render: shell
4976
validations:
5077
required: true
@@ -67,7 +94,5 @@ body:
6794
label: Anything else?
6895
description: |
6996
Links? References? Anything that will give us more context about the issue you are encountering!
70-
71-
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
7297
validations:
7398
required: false

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,7 @@ body:
3434
attributes:
3535
label: Anything else?
3636
description: |
37-
Links? References? Anything that will give us more context about the issue you are encountering!
38-
39-
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
37+
Links? References? Anything that will give us more context about the issue you are encountering.
4038
validations:
4139
required: false
4240

.github/pull_request-template.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,17 @@ In order to have this pull request merged, complete the following tasks.
88

99
### Pull request author tasks
1010

11+
- [ ] I checked that all workflows return a success.
1112
- [ ] I included all the needed documentation for this change.
1213
- [ ] I provided the necessary tests.
1314
- [ ] I squashed all the commits into a single commit.
1415
- [ ] I followed the [Conventional Commit v1.0.0 spec](https://www.conventionalcommits.org/en/v1.0.0/).
1516
- [ ] I wrote the necessary upgrade instructions in the [upgrade guide](../docs/upgrade-guide.md).
1617
- [ ] If this pull request is about and existing issue,
17-
I added the `Fix #ISSUE_NUMBER` label to the description of the pull request.
18+
I added the `Fix #ISSUE_NUMBER` or `Close #ISSUE_NUMBER` text to the description of the pull request.
1819

1920
### Super-linter maintainer tasks
2021

2122
- [ ] Label as `breaking` if this change breaks compatibility with the previous released version.
2223
- [ ] Label as either: `automation`, `bug`, `documentation`, `enhancement`, `infrastructure`.
24+
- [ ] Add the pull request to a milestone, eventually creating one, that matches with the version that release-please proposes.

0 commit comments

Comments
 (0)