-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
docs: add a bug report template (#82)
Showing
1 changed file
with
46 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
# Taken and adapted from the Symfony project | ||
# @see https://github.com/symfony/symfony/blob/7.1/.github/ISSUE_TEMPLATE/1_Bug_report.yaml | ||
name: 🐛 Bug Report | ||
description: ⚠️ NEVER report security issues, read https://github.com/strangebuzz/MicroSymfony?tab=security-ov-file | ||
labels: Bug | ||
|
||
body: | ||
- type: input | ||
id: affected-versions | ||
attributes: | ||
label: MicroSymfony version(s) affected | ||
placeholder: x.y.z | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: A clear and concise description of the problem | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: how-to-reproduce | ||
attributes: | ||
label: How to reproduce | ||
description: | | ||
⚠️ This is the most important part of the report ⚠️ | ||
Without a way to easily reproduce your issue, there is little chance we will be able to help you and work on a fix. | ||
Please, take the time to show us some code and/or config that is needed for others to reproduce the problem easily. | ||
Most of the time, creating a "bug reproducer" as explained in the URL below is the best way to help us | ||
and increases the chances someone will have a look at it. | ||
To create a reproducer you can clone an existing [tag](https://github.com/strangebuzz/MicroSymfony/tags). | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: possible-solution | ||
attributes: | ||
label: Possible Solution | ||
description: | | ||
Optional: only if you have suggestions on a fix/reason for the bug | ||
Don't hesitate to create a pull request with your solution, it helps get faster feedback. | ||
- type: textarea | ||
id: additional-context | ||
attributes: | ||
label: Additional Context | ||
description: "Optional: any other context about the problem: log messages, screenshots, etc." |