Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

ITS: Bug reporting form is inappropriate (designed for behavioral bugs)

Ouverte
  • Quelque chose ne va pas ?
#2,000 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
45/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
github
Domaine
tooling

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

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/pdf

This 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.
Device

Tell us what kind of device you're using to access the content.
Operating system

If the problem is with the book or the published files, we need to know what operating system you run on your device.
Browser/application + version

What 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:
image

Indeed, there are numerous issues with that form. Notably:

  1. It conflates issues with issue reports (for example in "Please create one issue per bug").
  2. The section title "Which version of the book is affected?" does not match its content.
  3. 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).
Langage dominant
CSS
Étoiles
6.6k
Forks
2.1k
Aucune PR mergée en 30 j

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de progit/progit2

Toutes les issues de progit/progit2

Issues similaires

Plus d'issues DevTools

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.