Csound Csound-dev Csound-tekno Search About

[Csnd] Issue Templates

Date2022-02-28 16:55
FromSteven Yi
Subject[Csnd] Issue Templates
Hi All,

Wanted to ask what we might use for github issue templates to help
collect better bug reports/feature requests.  For example, the
Netbeans project uses them here:

https://github.com/apache/netbeans/issues

If one clicks "New Issue" it lists a series of templates to use.
Clicking on one then shows an almost questionnaire for users to fill
in that directs users to supply things like motivations and use cases
for feature requests and system information for bug reports.  This
seems like it would help users articulate what's being asked/reported
and facilitate easier/better conversations on issues.

Thoughts on this? Ideas on templates to use?

Thanks,
Steven

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here

Date2022-02-28 18:03
FromRory Walsh
SubjectRe: [Csnd] Issue Templates
I think this is a good idea. I've seen them used in other projects. 

On Mon, 28 Feb 2022 at 16:56, Steven Yi <stevenyi@gmail.com> wrote:
Hi All,

Wanted to ask what we might use for github issue templates to help
collect better bug reports/feature requests.  For example, the
Netbeans project uses them here:

https://github.com/apache/netbeans/issues

If one clicks "New Issue" it lists a series of templates to use.
Clicking on one then shows an almost questionnaire for users to fill
in that directs users to supply things like motivations and use cases
for feature requests and system information for bug reports.  This
seems like it would help users articulate what's being asked/reported
and facilitate easier/better conversations on issues.

Thoughts on this? Ideas on templates to use?

Thanks,
Steven

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here
Csound mailing list Csound@listserv.heanet.ie https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND Send bugs reports to https://github.com/csound/csound/issues Discussions of bugs and features can be posted here

Date2022-02-28 21:06
FromStephen Kyne
SubjectRe: [Csnd] Issue Templates
I'd say a minimum of:

issue synopsis
expected outcome
actual outcome

Would be a good start. In fairness most of the bug reports are fairly well documented.

Stephen


From: A discussion list for users of Csound <CSOUND@LISTSERV.HEANET.IE> on behalf of Steven Yi <stevenyi@GMAIL.COM>
Sent: Monday 28 February 2022 16:55
To: CSOUND@LISTSERV.HEANET.IE <CSOUND@LISTSERV.HEANET.IE>
Subject: [Csnd] Issue Templates
 
Hi All,

Wanted to ask what we might use for github issue templates to help
collect better bug reports/feature requests.  For example, the
Netbeans project uses them here:

https://github.com/apache/netbeans/issues

If one clicks "New Issue" it lists a series of templates to use.
Clicking on one then shows an almost questionnaire for users to fill
in that directs users to supply things like motivations and use cases
for feature requests and system information for bug reports.  This
seems like it would help users articulate what's being asked/reported
and facilitate easier/better conversations on issues.

Thoughts on this? Ideas on templates to use?

Thanks,
Steven

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here

Date2022-02-28 21:25
FromRory Walsh
SubjectRe: [Csnd] Issue Templates
Platform and version are essential. 


On Mon, 28 Feb 2022 at 21:16, Stephen Kyne <stevek@outlook.ie> wrote:
I'd say a minimum of:

issue synopsis
expected outcome
actual outcome

Would be a good start. In fairness most of the bug reports are fairly well documented.

Stephen


From: A discussion list for users of Csound <CSOUND@LISTSERV.HEANET.IE> on behalf of Steven Yi <stevenyi@GMAIL.COM>
Sent: Monday 28 February 2022 16:55
To: CSOUND@LISTSERV.HEANET.IE <CSOUND@LISTSERV.HEANET.IE>
Subject: [Csnd] Issue Templates
 
Hi All,

Wanted to ask what we might use for github issue templates to help
collect better bug reports/feature requests.  For example, the
Netbeans project uses them here:

https://github.com/apache/netbeans/issues

If one clicks "New Issue" it lists a series of templates to use.
Clicking on one then shows an almost questionnaire for users to fill
in that directs users to supply things like motivations and use cases
for feature requests and system information for bug reports.  This
seems like it would help users articulate what's being asked/reported
and facilitate easier/better conversations on issues.

Thoughts on this? Ideas on templates to use?

Thanks,
Steven

Csound mailing list
Csound@listserv.heanet.ie
https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND
Send bugs reports to
        https://github.com/csound/csound/issues
Discussions of bugs and features can be posted here
Csound mailing list Csound@listserv.heanet.ie https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND Send bugs reports to https://github.com/csound/csound/issues Discussions of bugs and features can be posted here
Csound mailing list Csound@listserv.heanet.ie https://listserv.heanet.ie/cgi-bin/wa?A0=CSOUND Send bugs reports to https://github.com/csound/csound/issues Discussions of bugs and features can be posted here