github / github/issue-labeler

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

Aperta
#99 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
237
Fork
55
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

# 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

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.