github / github/issue-labeler

Issue Labeler - Description Textbox: Display over-limit prompt: "exceeds by N characters" when the description exceeds 100 characters.

Ouverte
#99 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
TypeScript
Étoiles
237
Forks
55
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

# Description

Currently, GitHub Issue labeler shows a generic error for overlong descriptions:

`Description is too long (maximum is 100 characters)` (see screenshot below).

This increases the time users spend editing the **Description** field in cases of overlong description because they cannot see how many characters to remove without using an external character counter tool.

# Suggested Solution

* Prompt the minimum number of characters to be reduced. For instance, " Trim the message by 17 characters (limit: 100)".
or
* Prompt the number of characters over the limit. For instance, "Over by 17 characters (limit:100)".

# Alternate Solution

* Continue with current sub-optimal error prompt which requires users to use an external tool to determine minimum number of characters to trim.

# Code to demonstrate issue
Image

# Checklist for Completion

* [ ] Add the logic to compute `excess - max(0, input_length - 100)` when input > 100
* [ ] Customize the error prompter to prompt one of the suggested solutions
* [ ] Add unit / integration tests for boundary / edge cases (99 / 100 / 101 characters)
* [ ] Update relevant documentation for the Description field error behavior

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par localiser la validation du champ Description et ses tests existants de messages d’erreur dans la TypeScript GitHub Action. Vérifiez les cas limites de 99, 100 et 101 caractères, puis ajoutez la couverture nécessaire et mettez à jour la documentation pertinente du champ Description afin que l’erreur indique clairement le dépassement.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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