[Scons-users] Feedback on issue creation template

Discussion:

Bill Deegan

2018-03-17 17:54:12 UTC

Greetings,

I've just added an issue creation template to Github.

See it here:
https://github.com/SCons/scons/blob/master/.github/issue_template.md

If you have a moment to take a look and let me know if I've missed any
information which should be provided when filing a new issue.

Thanks,
Bill
SCons Project Co-Manager

Daniel Moody

2018-03-17 18:00:22 UTC

Permalink

What about adding a requirement to paste the link to the scons users
archived thread in the submitted issue for reference and due process?

Post by Bill Deegan
Greetings,
I've just added an issue creation template to Github.
https://github.com/SCons/scons/blob/master/.github/issue_template.md
If you have a moment to take a look and let me know if I've missed any
information which should be provided when filing a new issue.
Thanks,
Bill
SCons Project Co-Manager
_______________________________________________
Scons-users mailing list
https://pairlist4.pair.net/mailman/listinfo/scons-users

Eric Fahlgren

2018-03-17 18:17:19 UTC

Permalink

Our procedure at work also calls for paragraphs on "what you see" and "what
you expected to see". The former is often some unexpected behavior or a
stack dump, the latter is a short description of how you think your
reproducer should work. Of course, we don't vet things as well, users can
just put in any old thing they don't understand, so your first item about
"bring it to the list" probably minimizes some of what I've mentioned.

Post by Daniel Moody
What about adding a requirement to paste the link to the scons users
archived thread in the submitted issue for reference and due process?

_______________________________________________
Scons-dev mailing list
https://pairlist2.pair.net/mailman/listinfo/scons-dev

Gary Oberbrunner

2018-03-20 20:40:55 UTC

Permalink

Which python distro (cpython, ActiveState, msys/cygwin etc. -- especially
on Windows)?

-- Gary

Post by Eric Fahlgren
Our procedure at work also calls for paragraphs on "what you see" and
"what you expected to see". The former is often some unexpected behavior
or a stack dump, the latter is a short description of how you think your
reproducer should work. Of course, we don't vet things as well, users can
just put in any old thing they don't understand, so your first item about
"bring it to the list" probably minimizes some of what I've mentioned.

Post by Daniel Moody
What about adding a requirement to paste the link to the scons users
archived thread in the submitted issue for reference and due process?

_______________________________________________
Scons-dev mailing list
https://pairlist2.pair.net/mailman/listinfo/scons-dev

--
Gary

Bill Deegan

2018-03-20 20:46:50 UTC

Permalink

Gary,

Updated per your comments.

-Bill

Post by Gary Oberbrunner
Which python distro (cpython, ActiveState, msys/cygwin etc. -- especially
on Windows)?
-- Gary

Post by Daniel Moody
What about adding a requirement to paste the link to the scons users
archived thread in the submitted issue for reference and due process?

_______________________________________________
Scons-dev mailing list
https://pairlist2.pair.net/mailman/listinfo/scons-dev

--
Gary
_______________________________________________
Scons-users mailing list
https://pairlist4.pair.net/mailman/listinfo/scons-users

Mats Wichmann

2018-03-20 21:08:05 UTC

Permalink

oh, fooey, my client remembered a different sender address, one that
isn't on the list.

(admin: just toss the other message)

Post by Bill Deegan
Gary,
Updated per your comments.
-Bill

Post by Bill Deegan
Greetings,
I've just added an issue creation template to Github.

<opinion-based-content>

I'll just add so it's been said: asking for more details may or may not
make a better bugreport. What is does do is increase the barrier to
getting the issue filed in the first place (illustration: a project I'm
on has a Jira tracker instance that has a number of mandatory questions
that are really useful if the bug were being reported against a
malfunction of distributed binaries, such as OS/Version combination,
hardware platform, reproducibility %, etc., but at this stage there is
no binary distribution so the vast majority of bugs are actually filed
against the sources; thus the "fill in all mandatory fields" requirement
just becomes an irritant). Bug triage can always ask for clarification,
if I'm a project maintainer I just want to get stuff captured. note how
many projects are now starting to auto-file bugs - with user consent up
front, of course :) - when something goes wrong, even if it means many
many duplicate instances being filed.

</opinion-based-content>

Bill Deegan

2018-03-20 21:27:58 UTC

Permalink

Mats,

The template is a list of recommended information.
Not mandatory.

All the requested information is to make it easier to reproduce and then
fix the issues..

Otherwise I end up asking for all that information when they file a bug
anyway.
At least this way they know what info we'd like to have.

-Bill

Post by Mats Wichmann

Post by Bill Deegan
Gary,
Updated per your comments.
-Bill

Post by Bill Deegan
Greetings,
I've just added an issue creation template to Github.

<opinion-based-content>
I'll just add so it's been said: asking for more details may or may not
make a better bugreport. What is does do is increase the barrier to
getting the issue filed in the first place (illustration: a project I'm
on has a Jira tracker instance that has a number of mandatory questions
that are really useful if the bug were being reported against a
malfunction of distributed binaries, such as OS/Version combination,
hardware platform, reproducibility %, etc., but at this stage there is
no binary distribution so the vast majority of bugs are actually filed
against the sources; thus the "fill in all mandatory fields" requirement
just becomes an irritant). Bug triage can always ask for clarification,
if I'm a project maintainer I just want to get stuff captured. note how
many projects are now starting to auto-file bugs - with user consent up
front, of course :) - when something goes wrong, even if it means many
many duplicate instances being filed.
</opinion-based-content>
_______________________________________________
Scons-users mailing list
https://pairlist4.pair.net/mailman/listinfo/scons-users