Skip to content

Commit

Permalink
docs: update issue form to include version info (#5682)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ferrarimarco committed May 25, 2024
1 parent a86fbaf commit e4da776
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
33 changes: 29 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,34 @@ body:
label: Is there an existing issue for this?
description: Search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- label: I have searched the existing issues
required: true
- type: checkboxes
attributes:
label: Are you using the latest Super-linter version available?
description: |
Ensure that you're using the latest Super-linter version.
https://github.com/super-linter/super-linter/releases/latest
options:
- label: I am using the latest Super-linter version.
required: true
- label: |
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)
required: true
- label: |
I am using the super-linter/super-linter action or container image, and not the deprecated github/super-linter action or container image.
required: true
- type: checkboxes
attributes:
label: Are you resonably sure that it's a Super-linter issue, and not an issue related to a tool that Super-linter runs?
description: |
If you encounter a specific issue, ensure that the issue is about
Super-linter, and not about a tool that Super-linter runs. For example,
if a linter reports an unexpected or a surprising error, you may check
if there are similar issues reported in that linter's issue tracker.
options:
- label: I think that this is a Super-linter issue.
required: true
- type: textarea
attributes:
label: Current Behavior
Expand Down Expand Up @@ -45,6 +71,7 @@ body:
Copy and paste any relevant log output.
This will be automatically formatted into code, so no need for backticks.
Enable debug logging, either on GitHub Actions, or when running locally.
Not attaching debug logging will delay the issue triaging process.
render: shell
validations:
required: true
Expand All @@ -67,7 +94,5 @@ body:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
validations:
required: false
4 changes: 1 addition & 3 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,7 @@ body:
attributes:
label: Anything else?
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
Links? References? Anything that will give us more context about the issue you are encountering.
validations:
required: false

Expand Down
4 changes: 3 additions & 1 deletion .github/pull_request-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,17 @@ In order to have this pull request merged, complete the following tasks.

### Pull request author tasks

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

### Super-linter maintainer tasks

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

0 comments on commit e4da776

Please sign in to comment.