Open-Assistant icon indicating copy to clipboard operation
Open-Assistant copied to clipboard

Github: templates

Open mm12 opened this issue 2 years ago • 4 comments

The Issue templates & Pull request templates will at the very least make labeling easier.

mm12 avatar Feb 17 '23 00:02 mm12

Of course it depends on the specific templates used but in many cases where I saw gh templates they seemed to be a tool of the dark side of the force (personal opinion) .. e.g. they ask people to go through a (in many cases unnecessary and irrelevant) process before submitting their idea, question or bug-report, i.e. they take away freedom and discourage contributions and have very little benefits.

andreaskoepf avatar Feb 17 '23 08:02 andreaskoepf

Of course it depends on the specific templates used but in many cases where I saw gh templates they seemed to be a tool of the dark side of the force (personal opinion) .. e.g. they ask people to go through a (in many cases unnecessary and irrelevant) process before submitting their idea, question or bug-report, i.e. they take away freedom and discourage contributions and have very little benefits.

I agree with some of this. The templates can be really bad sometimes, but they are very customizable. ie, here is what each could look like.

  • Bug report: (applies bug? label) - adds "link any relevant messages if applicable" at the bottom
  • Feat. request: (applies the FR label) - Ask what part of the project it applies to (with 'not sure' as an option)
  • Generic issue: Acts like a normal issue
  • Question - applies the question label, and has a section for relevant links.

mm12 avatar Feb 17 '23 16:02 mm12

I agree, they can be a barrier to contributing and are used as a way to deflect issues.

But in my experience as the project becomes more mainstream users do need to be told that a good bug report has "what did you do? what did you expect to happen? what actually happened?" parts

bitplane avatar Feb 20 '23 02:02 bitplane

I think that it can be a good idea if the template does not add a lot of required fields. As those ones that are mandatory (in case of a bug for example; which is the and the details if needed to reproduce it) will really help to make those Issues efficient & useful.

nil-andreu avatar Feb 21 '23 07:02 nil-andreu