Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
Ilya, Am 11.08.19 um 20:01 schrieb Илья Шипицин: > Tim, what do you think of providing some info on _first_ issue? > > Look, what I've accidently found :) > > https://github.com/actions/starter-workflows/blob/master/automation/greetings.yml > I don't think that's really necessary, there's enough documentation for these users already. Even more documentation is not going to help here. 1. We have CONTRIBUTING. GitHub automatically shows a note to first timers as indicated in the first screenshot of the help: https://help.github.com/en/articles/setting-guidelines-for-repository-contributors 2. We have issue templates. We now even have a "Question" template that tells users to not abuse the issue tracker. But even one is being ignored: https://github.com/haproxy/haproxy/issues/213#issuecomment-519492046 Smart users don't really need any more documentation. Non-smart users will simply ignore that automated comment as well. PS: I believe the HAProxy organization does not have access to GitHub actions anyway. At least not yet. Best regards Tim Düsterhus
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
Tim, what do you think of providing some info on _first_ issue? Look, what I've accidently found :) https://github.com/actions/starter-workflows/blob/master/automation/greetings.yml On Fri, Aug 2, 2019, 10:16 PM Willy Tarreau wrote: > On Fri, Aug 02, 2019 at 03:10:11PM +0200, Lukas Tribus wrote: > > Acked and agreed with what Tim says. > > Thanks guys, now applied! > > Willy > >
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
On Fri, Aug 02, 2019 at 03:10:11PM +0200, Lukas Tribus wrote: > Acked and agreed with what Tim says. Thanks guys, now applied! Willy
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
Hello Tim, On Fri, 2 Aug 2019 at 14:52, Willy Tarreau wrote: > > On Fri, Aug 02, 2019 at 02:45:06PM +0200, Tim Düsterhus wrote: > (...) > > So that paragraph you suggested might discourage users that actually > > read and understand if something is *slapped in their face* from HAProxy > > and does not help with users that don't read at all. We don't want to > > discourage the former group with such a passive-aggressive paragraph. > > OK works for me. Let's see anyway, it's cheap to edit later if needed. Acked and agreed with what Tim says. Thanks! Lukas
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
On Fri, Aug 02, 2019 at 02:45:06PM +0200, Tim Düsterhus wrote: (...) > So that paragraph you suggested might discourage users that actually > read and understand if something is *slapped in their face* from HAProxy > and does not help with users that don't read at all. We don't want to > discourage the former group with such a passive-aggressive paragraph. OK works for me. Let's see anyway, it's cheap to edit later if needed. thanks, Willy
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
Willy, Am 02.08.19 um 14:34 schrieb Willy Tarreau: > I'd even add here : > >Asking questions in the development bug tracker slows down >development, delays issue resolution, and will make everyone >angry at you. I'd not add this: The issue is that it might be non-obvious that the CONTRIBUTING file contains instruction for the issue tracker compared to just contributing patches and some projects actually accept questions in GitHub's issue tracker. So the users come to the GitHub repository, want to open the issue with their question and see this: https://github.com/haproxy/haproxy/issues/new/choose Then they think: I don't have a bug to report and I don't want to suggest anything and thus they "open a regular issue". And then they see the empty input and happily ask their question. I would not assume malicious intent there. With the new issue template they'll see "Question" in the list and think: "A-ha! That's what I need", click on it and actually see the warning text and then hopefully stop creating the issue. So that paragraph you suggested might discourage users that actually read and understand if something is *slapped in their face* from HAProxy and does not help with users that don't read at all. We don't want to discourage the former group with such a passive-aggressive paragraph. Best regards Tim Düsterhus
Re: [PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
Hi Tim, On Fri, Aug 02, 2019 at 12:21:54PM +0200, Tim Duesterhus wrote: > --- /dev/null > +++ b/.github/ISSUE_TEMPLATE/Question.md > @@ -0,0 +1,19 @@ > +--- > +name: Question > +about: Do NOT ask questions in the issue tracker. This issue tracker is for > tracking bugs and feature requests directly relating to the development of > the software itself. > +labels: 'status: invalid' > +--- > + > +# :stop_sign: HOLD ON :stop_sign: > + > +Do **NOT** ask questions in the issue tracker. This issue tracker is for > tracking bugs and > +feature requests directly relating to the development of the software itself. I'd even add here : Asking questions in the development bug tracker slows down development, delays issue resolution, and will make everyone angry at you. > +Use the forum or the mailing list if you have a question rather than a bug > or feature request. (...) I think this can help with those who don't read instructions (which, despite, are quite clear). Waiting for Lukas' opinion (and/or rewording). thanks, Willy
[PATCH 1/1] DOC: Add 'Question.md' issue template, discouraging asking questions
This commit adds a new `Question.md` issue template that aims to prevent users asking questions within the issue tracker, because the other two templates do not fit "question", thus leading to people not seeing that the issue tracker is not for questions. This template inspired by TypeScript's Question template at: https://github.com/microsoft/TypeScript/blob/master/.github/ISSUE_TEMPLATE/Question.md --- .github/ISSUE_TEMPLATE/Question.md | 19 +++ 1 file changed, 19 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/Question.md diff --git a/.github/ISSUE_TEMPLATE/Question.md b/.github/ISSUE_TEMPLATE/Question.md new file mode 100644 index 0..99b93e6eb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/Question.md @@ -0,0 +1,19 @@ +--- +name: Question +about: Do NOT ask questions in the issue tracker. This issue tracker is for tracking bugs and feature requests directly relating to the development of the software itself. +labels: 'status: invalid' +--- + +# :stop_sign: HOLD ON :stop_sign: + +Do **NOT** ask questions in the issue tracker. This issue tracker is for tracking bugs and +feature requests directly relating to the development of the software itself. + +Use the forum or the mailing list if you have a question rather than a bug or feature request. + +The forum is at: https://discourse.haproxy.org/ + +- The mailing list (no need to subscribe) is: haproxy@formilux.org +- Subscribe to the list: haproxy+subscr...@formilux.org +- Unsubscribe from the list: haproxy+unsubscr...@formilux.org + -- 2.22.0
