Updates to Issue templates 🛠

tamalCodes commented 1 year ago

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

Am i willing to work on it ?

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

github-actions[bot] commented 1 year ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

imabp commented 1 year ago

Thanks for creating an issue. Please add more on how it will benefit AsyncAPI in general ?

We are still organized, by using labels to issues.
We do have a bot @asyncapi-bot 😅 , which does lot of things, from tweeting, to communicating with you on github issues.
AFAIK, GitHub doesn't parse YAML front matter for Pull Request templates at present

octonawish-akcodes commented 1 year ago

I can work on this

tamalCodes commented 1 year ago

@imabp ,

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 :

What i am suggesting it to be :

octonawish-akcodes commented 1 year ago

I agree .yml will provide even broader contexts about the issue and PR which makes it easier to justify about the problem statement and solutions.

tamalCodes commented 1 year ago

I agree .yml will provide even broader contexts about the issue and PR which makes it easier to justify about the problem statement and solutions.

I don't think we have support for Pull request templates yet

derberg commented 1 year ago

tbh I sometimes see people misuse template, and leave for example the explanation text that is in the template. Sometimes it is hard to follow created issues.

@alequetzalli since you did something similar for docs, can you share how did it work, do you like when it is more structured like @IAmTamal proposes?

@thulieblack might be interesting for you as the change is kinda community related

quetzalliwrites commented 1 year ago

heyo! ✨ We already use yml for docs issues, as can be seen in the .yml create new docs and docs bug issue templates.

Thus, note how we already have several of the features mentioned...

I think we could certainly improve these current templates and update them with fields we don't have yet. These .yml templates are excellent, and I am happy we have them for docs. 😄✌🏽

octonawish-akcodes commented 1 year ago

I can start working on this

github-actions[bot] commented 1 year ago

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

derberg commented 1 year ago

I moved the issue as the sources of templates, and PR has to be opened here in .github repo -> https://github.com/asyncapi/.github/tree/master/.github/ISSUE_TEMPLATE

@IAmTamal since you reported the issue and proposed a solution you can open a PR, unless you are ok someone else is doing it.

I suggest we do it in bug and enhancement templates

github-actions[bot] commented 1 year ago

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

asyncapi / .github