Skip to content
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

[FEATURE]: Warn about using #1 in issue descriptions #2824

Open
HardlyDifficult opened this issue Jul 9, 2022 · 0 comments
Open

[FEATURE]: Warn about using #1 in issue descriptions #2824

HardlyDifficult opened this issue Jul 9, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@HardlyDifficult
Copy link
Contributor

HardlyDifficult commented Jul 9, 2022

Problem / opportunity:

When an issue description includes the text like #1(without graves) then github will auto inline irrelevant issue titles as shown here:

image

and here:
Screen Shot 2022-07-09 at 10 45 14 AM

Desired outcome

Discourage warden's from doing this and use an alternative format such as 1).

Solution

Warn users about this before submitting issues.

Alternative

Auto-escape these instances before creating the issue on github.

Additional context

Sock suggested I open this issue after raising the issue in Discord: https://discord.com/channels/810916927919620096/810936719003090974/995296890478395402

@HardlyDifficult HardlyDifficult added the enhancement New feature or request label Jul 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant