Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create issue template #30

Open
Painatalman opened this issue Apr 19, 2020 · 0 comments
Open

Create issue template #30

Painatalman opened this issue Apr 19, 2020 · 0 comments

Comments

@Painatalman
Copy link
Contributor

Why

Issue templates can structure common issue types (like error reports and feature requests), thus making them easier to both read and write.

How

We should consider what type of templates to create, and what sections to include in each of them.
For error reports (like issue #29), I usually follow this structure:

  • title with (summed up) error message
  • error summary and message (untitled)
  • steps to reproduce
  • installed software (and packages)
  • possible cause or possible solution (if any)
  • suggestions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant