[INFRA] Rework the Issues templates

[tbouffard]

Note: our current templates have been created using the templates provided by default by GitHub https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#creating-issue-templates

Better guide people

Bug doesn't guide the writer enough

• In the past @csouchet suggested to ask people to attach BPMN diagram to reproduce the problem, add screenshots
• The sections are not clearly separated (use bold instead of header)
• The required information about the environment where the bug occurs should be enriched: node and npm version, other tools for other repo (java, R, ..)

Use forms

They provide richer features.

See https://github.com/typescript-eslint/typescript-eslint/blob/v6.7.2/.github/ISSUE_TEMPLATE/README.md

• Syntax for issue forms (the top level properties)
• Syntax for GitHub's form schema (the form body)
• Configuring the template chooser (config.yml)
• sorting templates

Find why they use https://github.com/typescript-eslint/typescript-eslint/blob/v6.7.2/.github/ISSUE_TEMPLATE.md in addition to the ISSUE_TEMPLATE directory

blank_issues_enabled: false

It doesn't work.
Currently, I can create a blank issue with https://github.com/process-analytics/bv-experimental-add-ons/issues/new (tested with both my account and another accound that has readonly permissions on the repo)work here: https://github.com/typescript-eslint/typescript-eslint/issues/new --> https://github.com/typescript-eslint/typescript-eslint/issues/new/choose

Enrich the list of issue types with external links

Add a set of links at the end of the list like https://github.com/typescript-eslint/typescript-eslint/blob/v6.7.2/.github/ISSUE_TEMPLATE/config.yml

• add a link to the "bpmn-visualization Getting started"?
• add link to discord (see also "opened question" below)

Automate the detection of issues created without following a template

Here is an example of the usage of a bot that closes such an issue: apache/echarts#12509

Opened questions

The "Question" issue type

Use discord only instead by adding external links at the bottom of the list of issue types?
Keep the "question" issue and add the link? In the past, we got quite good report as a question in this repository. I am not sure that we would have received the same quality on discord
Update the Question template to better guide user?

• mention discord again
• in case, they think they have a bug but are not sure? why not opening a bug in this case, and we will qualify it afterwards in another category

Decisions

On 2024-08-16, the scope of this issue is finally reduced:

• the "question" type is kept, we are not sure we want to direct people to discord
• no "Automate the detection of issues created without following a template"
• do not use form, keep the "markdown" way
• no investigation on the "blank_issues_enabled" is not working

Feel free to create new issues for the topic not covered as part of this issue.

First improvements were integrated in #2964. The following elements will be implemented prior considering this issue as completed:

• bug template: provide more guidance about what user should put in the "reproduction paragraph"
• Add new elements in the issue type chooser
  • add a link to the "bpmn-visualization Getting started" tutorial: https://medium.com/@process-analytics/getting-started-with-bpmn-visualization-a54fbafae2df
  • add a link to the "All you need to know about styling BPMN elements" article: https://medium.com/@process-analytics/bpmn-visualization-all-you-need-to-know-about-styling-bpmn-elements-24289154c16c
  • add a link to the repository including examples