Use issue templates and add diagram, theme and syntax proposal issue forms

[Andre601]

📑 Summary

This PR does a few things:

• Moves issue templates to GitHub's new Issue forms.
  • Previews can be seen on my fork.
• Add a config.yml to the issue templates
  • This adds links to Discussions (if enabled, as suggested here), Slack, the Documentation and Live Editor
  • Disables the option to create blank issues (Possible spam-protection for the future.)
• Splits the feature request template into three distinct templates, as suggested in Organize Mermaid #2456
  • Diagram Proposal for new Diagrams
  • Syntax Proposal for new Syntaxes
  • Theme Proposal for new Themes
• Removes the Question template in favour of recommending Discussions.

Related issue: #2456

A bit more context:
The PR remains a draft for now until clear responses have been given as to if discussions should be enabled or not.

I'm in favour of using Discussions over issues for Questions as they offer a way to mark a response as answer, which in the end can create a healthy knowledge base.
Coupled with the fact that you can also migrate issues to Discussions, have categories that don't have a "Mark as Answer" option, which can be useful for stuff like sharing Setups or Diagram designs, and have an option for a news category that allows collaborators to post stuff such as announcements without the fear of other people spamming the category, I feel like Discussion would be a superior choice here.

If for whatever reason you decide against this would I simply re-create the question form and mark the PR as ready.
Otherwise, would I uncomment the entry with the discussion link in the config.yml and mark the PR as ready.

I hope my points are clear and understandable. 😅

📏 Design Decisions

The idea is to use GitHub's issue forms for a more streamlined and consistent syntax for issues, which can help with support and feature requests.

📋 Tasks

Make sure you

• 📖 have read the contribution guidelines
• 💻 have added unit/e2e tests (if appropriate)
• 🔖 targeted develop branch

[ashishjain0512]

Hey, this will be quite helpful with proper templates. Thanks for picking this one up.

For your question regarding keeping the discussion open, we as such are on board with the idea for people to discuss. However, we are really a very small team working actively on Mermaid. It will be hard for us to answer questions in a timely fashion.

We can surely keep the discussion open, maybe as we get more contributors and the team grows, we will be able to handle it.

[Andre601]

For your question regarding keeping the discussion open, we as such are on board with the idea for people to discuss. However, we are really a very small team working actively on Mermaid. It will be hard for us to answer questions in a timely fashion.

We can surely keep the discussion open, maybe as we get more contributors and the team grows, we will be able to handle it.

I feel like you misunderstood my comment?

The only thing I did was suggesting to enable and use GitHub Discussions as a replacement for the questions template (And maybe also for stuff such as announcements and sharing setups and stuff).

So not sure what exactly you mean with your comment.

[ashishjain0512]

@Andre601 Yes, that sounds like a good idea. Sorry, I misunderstood your previous comment. Let's enable GitHub Discussions.

[Yash-Singh1]

@knsv Could you enable GitHub Discussions?

[sidharthv96]

@Andre601 Discussions are enabled now.
The new templates are fantastic, we can get them in if you can get the PR ready!

[sidharthv96]

Maybe add a command like they do with Svelte issues?
npx envinfo --system --binaries --browsers --npmPackages "{svelte,@sveltejs/*,vite}"

Also, do we need to make this required? Not sure what % of issues are related to Device/OS in our case.

[Andre601]

What would the command look like for Mermaid? And where would I put it here? Also, will make this not required.

[Andre601]

Not sure if I can resolve the current file conflicts, as GitHub doesn't provide me with any option to resolve it (Not even instructions on how it's done on the command line, which it usually shows for too complicated conflicts)

Edit: It seems like I actually cant. git status returns 0 conflicts in the command line, so there is - at least for git - no conflict present it would need to deal with...
I guess this is something you guys need to fix on your end.

[sidharthv96]

Edit: It seems like I actually cant. git status returns 0 conflicts in the command line, so there is - at least for git - no conflict present it would need to deal with... I guess this is something you guys need to fix on your end.

I used VS Code and merged the latest develop into your branch.

[Andre601]

I used VS Code and merged the latest develop into your branch.

Thank you. Still not sure why it didn't work on my end.

[aloisklink]

Awesome! Thanks for these changes.

I 100% agree on moving questions to discussions, issues should normally only be for issues or feature requests.

Future work might be adding a drop-down for diagram types too, so that we can automatically label an issue based on what diagram it affects.

My only required change is to fix the typo in:

• .github/ISSUE_TEMPLATE/syntaxt_proposal.yml should be
• .github/ISSUE_TEMPLATE/syntax_proposal.yml

Thank you. Still not sure why it didn't work on my end.

I've been using git for years, and I still sometimes find the easiest way to fix some issues is to delete my local repo and git clone again :)

[Andre601]

.github/ISSUE_TEMPLATE/syntaxt_proposal.yml → .github/ISSUE_TEMPLATE/syntax_proposal.yml

Spam bot