Use templates for issue reports - Githubissues

cbm-fles / flesnet

CBM FLES Timeslice Building

7 stars 22 forks source link

Use templates for issue reports #161

Open ngreve opened 5 months ago

ngreve commented 5 months ago

For more comprehensible bug reports and feature requests I suggest using issue templates.

I suggest that bug reports should contain the following sections:

System information which includes the commit hash (required)
Problem description (required)
Steps to reproduce (required)
Expected behavior by the user (required)
Additional Information (optional)

Suggestion for feature request sections:

Commit hash of the currently used Flesnet version (required)
Feature Description (required)
What would be the benefit (required)
Is there currently a workaround available (optional)

I am not too familiar with these templates, but as far as I know filling out these fields can be enforced and in most cases it should be.