Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Tweak bug report template #44409

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 2, 2021
Merged

Tweak bug report template #44409

merged 1 commit into from
Dec 2, 2021

Conversation

fabpot
Copy link
Member

@fabpot fabpot commented Dec 2, 2021

Q A
Branch? 6.1
Bug fix? no
New feature? no
Deprecations? no
Tickets n/a
License MIT
Doc PR n/a

Let's make it clear that without a way to reproduce a bug, there is little chance we will be able to help or fix.

/cc @xabbuh as you are doing that manually a lot, let's try to fix the root cause ;)

@carsonbot carsonbot added this to the 6.1 milestone Dec 2, 2021
@derrabus derrabus modified the milestones: 6.1, 4.4 Dec 2, 2021
.github/ISSUE_TEMPLATE/1_Bug_report.md Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1_Bug_report.md Outdated Show resolved Hide resolved
@fabpot fabpot force-pushed the bug-report-tweaks branch from 790f4bc to 65f0c90 Compare December 2, 2021 08:43
<!-- ⚠️ 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.
If it's a complex bug, create a "bug reproducer" as explained in:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should suggest to create a bug reproducer by default? I often see people posting code fragments which would be enough to reproduce something, but still requires someone to try it out to copy and paste these snippets into an application. That's something that takes time and we could make it more clear IMO that making it as easy as possible to reproduce an issue increases the likelihood for someone to look into it.

Though I have no idea how to phrase that in a short way.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xabbuh I've tweaked the text, how does that sound to you?

@stof
Copy link
Member

stof commented Dec 2, 2021

Maybe we can turn this into an issue form rather than a markdown template, which allows us to put more visible help texts on each field (and mark some as required), instead of having HTML comments in the markdown.

@fabpot fabpot force-pushed the bug-report-tweaks branch from 65f0c90 to cf48023 Compare December 2, 2021 10:58
@fabpot
Copy link
Member Author

fabpot commented Dec 2, 2021

@stof Done, not sure if we need to keep both the md and the yaml files.

@fabpot fabpot force-pushed the bug-report-tweaks branch from cf48023 to dd24a9e Compare December 2, 2021 11:00
@stof
Copy link
Member

stof commented Dec 2, 2021

@fabpot no. GitHub will ignore the md file if it has a yaml template for the same name

@stof
Copy link
Member

stof commented Dec 2, 2021

shouldn't this be done in the 4.4 branch ? IIRC, we have managed those templates in the oldest maintained branch and merged them up until now (including the recent change done by @nicolas-grekas)

@fabpot fabpot force-pushed the bug-report-tweaks branch from dd24a9e to a7c7712 Compare December 2, 2021 13:30
@fabpot fabpot changed the base branch from 6.1 to 4.4 December 2, 2021 13:31
@fabpot
Copy link
Member Author

fabpot commented Dec 2, 2021

Rebased on 4.4, where the md files do not exist.
For some reasons, they exist on 5.3, they are removed here #44420

@fabpot fabpot merged commit 95a85fd into symfony:4.4 Dec 2, 2021
@fabpot fabpot deleted the bug-report-tweaks branch December 2, 2021 13:43
@fabpot
Copy link
Member Author

fabpot commented Dec 2, 2021

FYI, I've resync all Github issue templates from 4.4 to 6.1 so that in the future, we can always merge in the lowest maintained branch like for translations (even if Github will only always use the main branch version).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.