Add issues templates for both bugs and enhancements
khalyomede opened this issue · comments
Description
There is no templates for bugs and enhancements, which can reduce the chances someone will want to describe his issue or can make difficult to format and clarify an issue without proper templates.
Expected behavior
Enhancements issue template
For an enhancements, the following sections (using level 2 title, ##) should be shown:
- Description
- Proposal
- Workaround solutions
- Notes
The text hints, using italic, should be shown below each of these titles (without the double quotes):
- Description: "Give some context and motivation for the proposed solution."
- Proposal: "The detail proposition. Can include code."
- Worarkound solutions: "Mention every existing workaround you know that will solve the issue apart from the proposed solution."
- Notes: "Add everything that relates the proposal, like future induced issues, related issues, ..."
Bug issue template
For a bug, the following sections (using level 2 title, ##) should be shown:
- Description
- Steps to reproduce the issue
- Expected behavior
- Workaround solutions
- Notes
The text hints, using italic, should be show below each of these titles (without the double quotes):
- Description: "Any information that can give more understanding about how you came to this issue."
- Steps to reproduce the issue: "Detail precisely how we can reproduce the issue from a blank new project (if possible)."
- Expected behavior: "Describe what the output or the behavior should be instead of the issue you have."
- Workaround solutions: "Mention every existing workaround you know that will solve the issue."
- Notes: "Add everything that relates the proposal, like related issues, ..."
Alternatives solutions
To write by hand the issue layout.