ITS: Bug reporting form is inappropriate (designed for behavioral bugs)
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- github
- Domain
- tooling
Research direction
Start by reviewing the repository's GitHub issue form configuration and the specialized bug-report form described in this issue. Compare its fields and beta warning with the requested alternatives; done means the form is disabled in favor of a blank template, or its wording, scope, and warning are corrected.
Written by the indexing model from the issue text.
Description
When reporting an issue on this tracker, the first form basically asks which type of issue is being reported. One option is "Bug report", which brings to a form with more than 10 input fields (mostly checkboxes and text fields), which looks like the following:
There's no existing/similar bug report.
Please search to see if an issue already exists for the bug you encountered.
I have searched the existing issues *
This report is about a single actionable bug.Please create one issue per bug, split up your bug reports if needed.
I'm reporting a single actionable bug *
This report is about the ProGit book, version 2, English language.Bug reports about translations or the first version of the book are not accepted.
This bug is not about a translation or old version *
Bug covers book website/pdfThis bug is about the book as found on the website or the PDF.
I confirm the bug is about the book as found on the website/pdf
Problem is present in the Pro Git book on the website?If you found an issue in the pdf/epub/mobi files, you've checked if the problem is also present in the Pro Git book on the website.
This bug also affects the Pro Git book as published on the website.
Which version of the book is affected?It's important for us to know if the problem is in the source or in the tooling that creates the pdf/epub/mobi files.
Therefore, please select which versions are affected.
Describe the bug:A clear and concise description of what the bug is.
Steps to reproduce:Please write the steps needed to reproduce the bug here.
[...]
Expected behavior:A clear and concise description of what you expected to happen.
Screenshots:If applicable, add screenshots to help explain your problem.
Additional context:Add any other context about the problem here.
You can also put references to similar bugs here.
DeviceTell us what kind of device you're using to access the content.
Operating systemIf the problem is with the book or the published files, we need to know what operating system you run on your device.
Browser/application + versionWhat browser/application are you using? We also need the version number of the browser/application.
The form is discreetly marked as beta at the right:
Indeed, there are numerous issues with that form. Notably:
- It conflates issues with issue reports (for example in "Please create one issue per bug").
- The section title "Which version of the book is affected?" does not match its content.
- It assumes the bug is behavioral, requiring to specify reproductions steps and expected behavior. While this is often the case with software, this assumption is particularly incorrect since… Pro Git is not software.😅
I would recommend to:
- Disable that specialized reporting form until it is mature, directing bug reporters to a blank template instead, even though the intention is of course noble.
- If not, make the beta warning sufficiently prominent (minimally, remove the misleading green color, perhaps replacing with orange/yellow).
- Dominant language
- CSS
- Stars
- 6.6k
- Forks
- 2.1k
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from progit/progit2
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 82/100
-
enhancement
Difficulty 1/5 1-3 hours Newbie friendliness 65/100
-
enhancement
Difficulty 1/5 Under an hour Newbie friendliness 62/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 90/100
duckdb/duckdb-python#627 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
phpstan/phpstan-doctrine#794 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
nearform/ag-grid-url-sync#160 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
idean3885/claude-ops-agent#521 ·