Create issue templates

[pBouillon]

Issue Summary

As of now, when creating an issue, there is only a single markdown file that needs to be completed depending on what is being reported (bug, feature, etc.)

This can lead to incoherent sections for what is being written.

Issue templates could greatly help in improving the quality of the issues that are being written by having specific types of content per issues instead of a generic one

Category

- [ ] Bug report
- [ ] Regression
- [ ] Feature suggestion
- [ ] Documentation issue
- [x] Other

Expected Behavior

When creating an issue, I should be able to choose what I would like to write.

A good example is the eslint issue page:

Actual Behavior

There is a single and generic markdown template to fill:

Steps to Reproduce

N/A

Environment

• Browser/Device: N/A
• Node version: N/A
• Version: N/A

Additional Information

The templates should be for each section of the Category part:

• Bug report
• Regression
• Feature suggestion
• Documentation issue
• Other

Additionally, an option inviting to use the discussions (as in the eslint repository) could be a nice addition.

[djgovani]

Hi @pBouillon I have created one bug-report template here (refs: creating-issue-forms and eslint issue page ).

I want to understand what things we can add to each category. Can we have a chat/call about it or maybe you can post it here.

[pBouillon]

Hey @djgovani and thanks a lot for your help!

I would like the creator of an issue not to be bother with a boilerplate that might be completely unrelated to his submission

For example, if I want to suggest a feature, I would like not to have to fill a "step to reproduce" section

In that spirit, I think we should categorize why someone would like to create an issue and what could be the appropriate sections for that

The goal is to have enough categories to be relevant but not too much to avoid overwhelming potential contributors

I thought of several categories but this is absolutely subject to discussion:

• Bug Report: I expected something from the usage of ngx-flagr but the outcome is different/wrong
• Regression: the feature I successfully used before is now broken (should it be merged with the bug report ?)
• Feature Suggestion: I have an idea of improvement or a request of a feature I would like to see in ngx-flagr
• Documentation issue: The documentation is stating that this should work like this but this is wrong / this part of the library is undocumented / I noticed a typo
• Other: Any suggestion that might not fit into the previous ones

I looked at your template and it sure look promising and way better than this huge Markdown file I'm using

However, I fear that making the stackblitz link required might discourage people to submit it. It could be beneficial if one day this project gain enough traction, but it might be a bit premature now

What is your take on this? I would love to hear your way of seeing this

[djgovani]

Thanks @pBouillon for the information about categories.

I have removed the required validation for a link and also update the content for the bug_report template. Also added Feature and Documentation templates you can see them here.

For Regression I believe if the feature successfully used before is now broken then we should merge it with the bug report.

I think we have to go with the templates and we can update them as we grow.

Let me know your thoughts

[pBouillon]

Hi @djgovani, and thanks a lot for the time you are putting into this

It looks great! However, some ways of requesting an information might be perceived as a bit aggressive, I would suggest "soften" them a bit

Could you submit a PR on this so that we can discuss on them directly from the code?

As an example, in the Bug Report template, I would argue that "What went wrong?" could be better than "What did you do?" in the sense that it is using the passive form and does not sound like blaming the user

However that's only minor points, the issue templates are there and looks great!

[djgovani]

Thanks @pBouillon

Sure, will create a PR.