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

[FEAT] Updates to Issue templates 🛠 #15

Open
tamalCodes opened this issue Mar 31, 2023 · 0 comments
Open

[FEAT] Updates to Issue templates 🛠 #15

tamalCodes opened this issue Mar 31, 2023 · 0 comments

Comments

@tamalCodes
Copy link

Reason/Context

I am suggesting to update the Issue templates , currently we are using .md files instead of the brand new issue forms with .yml files.

Why to update it ?

  • The .yml based issue templates makes it more easier to organize, ask your questions, add screenshots and choose other options as necessary
  • Plus, we can add "custom" labels to the issue template which makes it more organized than having a bot/user do it.

Relevant screenshots

image

image

Am i willing to work on it ?

Yes, i will be glad to help an Opensource project grow more !

Detailed description

I am talking about the issue templates which can be wrote using .yml , inside the .github > ISSUE_TEMPLATES .
Yes the bot is cool TBH, but the .yml based issue template is cooler.

Currently we are throwing in a markdown based Issue template. The problem is the user may/maynot fill in some fields. Then the maintainers again would have to ask them to fill those. Additionally, It's also not much of a beginner friendly thing, because all someone would see is questions and might be confused on how to structure their issue.

So adding proper, structured issue templates would be helpful for both the contributors as well as the maintainers to manage their repository.

Features of adding these issue templates

  • Required fields
  • Less dependant on bots
  • Proper options for mentioning their browsers , operating systems and more.
  • Interactive Check boxes to confirm if they have read the guidelines and more.
  • Better Developer experience.

Relevant screenshots

What currently it is :

image

What i am suggesting it to be :

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants
@tamalCodes and others