diff mbox series

[2/2] Gitlab: Add "Feature Request" issue template.

Message ID 20210519213202.3979359-3-jsnow@redhat.com (mailing list archive)
State New, archived
Headers show
Series Gitlab: Add issue templates | expand

Commit Message

John Snow May 19, 2021, 9:32 p.m. UTC
Copied from Peter Krempa's libvirt template, feature.md.

CC: Peter Krempa <pkrempa@redhat.com>
Signed-off-by: John Snow <jsnow@redhat.com>
---
 .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
 create mode 100644 .gitlab/issue_templates/feature_request.md

Comments

Thomas Huth May 20, 2021, 6:52 a.m. UTC | #1
On 19/05/2021 23.32, John Snow wrote:
> Copied from Peter Krempa's libvirt template, feature.md.
> 
> CC: Peter Krempa <pkrempa@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>   .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
>   1 file changed, 13 insertions(+)
>   create mode 100644 .gitlab/issue_templates/feature_request.md
> 
> diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md
> new file mode 100644
> index 00000000000..26901ff00c4
> --- /dev/null
> +++ b/.gitlab/issue_templates/feature_request.md
> @@ -0,0 +1,13 @@
> +## Goal
> +<!-- Describe the final result you want to achieve. Avoid design specifics. -->

Since some people apparently had wrong expectations when filing a feature 
request in the past, it might be good to add some words about what to 
expect. Maybe something like this (re-using some wording that Daniel already 
added to some tickets in the past IIRC):

  Please note that the QEMU, like most open source projects, relies on 
contributors who have motivation, skills and available time to work on 
implementing particular features. Contributors naturally tend to focus on 
features that result in the greatest benefit to their own use cases. Thus 
the QEMU project doesn't implement new big features (like target 
architectures or board models) on demand based on feature requests here; 
they're a lot of work to do. Instead we simply code-review and incorporate 
new big features as and when people decide to write them and submit the 
patches. So please only submit small requests here. Thanks!

?

  Thomas
John Snow May 21, 2021, 3:49 p.m. UTC | #2
On 5/20/21 2:52 AM, Thomas Huth wrote:
> On 19/05/2021 23.32, John Snow wrote:
>> Copied from Peter Krempa's libvirt template, feature.md.
>>
>> CC: Peter Krempa <pkrempa@redhat.com>
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
>>   1 file changed, 13 insertions(+)
>>   create mode 100644 .gitlab/issue_templates/feature_request.md
>>
>> diff --git a/.gitlab/issue_templates/feature_request.md 
>> b/.gitlab/issue_templates/feature_request.md
>> new file mode 100644
>> index 00000000000..26901ff00c4
>> --- /dev/null
>> +++ b/.gitlab/issue_templates/feature_request.md
>> @@ -0,0 +1,13 @@
>> +## Goal
>> +<!-- Describe the final result you want to achieve. Avoid design 
>> specifics. -->
> 
> Since some people apparently had wrong expectations when filing a 
> feature request in the past, it might be good to add some words about 
> what to expect. Maybe something like this (re-using some wording that 
> Daniel already added to some tickets in the past IIRC):
> 
>   Please note that the QEMU, like most open source projects, relies on 
> contributors who have motivation, skills and available time to work on 
> implementing particular features. Contributors naturally tend to focus 
> on features that result in the greatest benefit to their own use cases. 
> Thus the QEMU project doesn't implement new big features (like target 
> architectures or board models) on demand based on feature requests here; 
> they're a lot of work to do. Instead we simply code-review and 
> incorporate new big features as and when people decide to write them and 
> submit the patches. So please only submit small requests here. Thanks!
> 
> ?
> 

OK, I may edit it just a little bit to appear a touch softer. A concern 
I have is that users may not really know the difference between a 
'small' and a 'big' feature, necessarily.

Still, setting an expectation might help...

--js
Daniel P. Berrangé May 21, 2021, 4:18 p.m. UTC | #3
On Fri, May 21, 2021 at 11:49:39AM -0400, John Snow wrote:
> On 5/20/21 2:52 AM, Thomas Huth wrote:
> > On 19/05/2021 23.32, John Snow wrote:
> > > Copied from Peter Krempa's libvirt template, feature.md.
> > > 
> > > CC: Peter Krempa <pkrempa@redhat.com>
> > > Signed-off-by: John Snow <jsnow@redhat.com>
> > > ---
> > >   .gitlab/issue_templates/feature_request.md | 13 +++++++++++++
> > >   1 file changed, 13 insertions(+)
> > >   create mode 100644 .gitlab/issue_templates/feature_request.md
> > > 
> > > diff --git a/.gitlab/issue_templates/feature_request.md
> > > b/.gitlab/issue_templates/feature_request.md
> > > new file mode 100644
> > > index 00000000000..26901ff00c4
> > > --- /dev/null
> > > +++ b/.gitlab/issue_templates/feature_request.md
> > > @@ -0,0 +1,13 @@
> > > +## Goal
> > > +<!-- Describe the final result you want to achieve. Avoid design
> > > specifics. -->
> > 
> > Since some people apparently had wrong expectations when filing a
> > feature request in the past, it might be good to add some words about
> > what to expect. Maybe something like this (re-using some wording that
> > Daniel already added to some tickets in the past IIRC):
> > 
> >   Please note that the QEMU, like most open source projects, relies on
> > contributors who have motivation, skills and available time to work on
> > implementing particular features. Contributors naturally tend to focus
> > on features that result in the greatest benefit to their own use cases.
> > Thus the QEMU project doesn't implement new big features (like target
> > architectures or board models) on demand based on feature requests here;
> > they're a lot of work to do. Instead we simply code-review and
> > incorporate new big features as and when people decide to write them and
> > submit the patches. So please only submit small requests here. Thanks!
> > 
> > ?
> > 
> 
> OK, I may edit it just a little bit to appear a touch softer. A concern I
> have is that users may not really know the difference between a 'small' and
> a 'big' feature, necessarily.
> 
> Still, setting an expectation might help...

Yeah, I think we could be a little more positive in how we phrase it.
Perhaps ust focus on what filing a feature request does achieve.

The value is primarily about illustrating & recording a use case to
the project, and providing a place to discuss it and guage interest
from others.

There should be no expectation that anyone will work on it, but seeing
the feature request might pique someone's interest enough that they
want to work on it. I think probably the big vs small distinction
doesn't really matter much.

Regards,
Daniel
diff mbox series

Patch

diff --git a/.gitlab/issue_templates/feature_request.md b/.gitlab/issue_templates/feature_request.md
new file mode 100644
index 00000000000..26901ff00c4
--- /dev/null
+++ b/.gitlab/issue_templates/feature_request.md
@@ -0,0 +1,13 @@ 
+## Goal
+<!-- Describe the final result you want to achieve. Avoid design specifics. -->
+
+
+## Technical details
+<!-- Describe technical details, design specifics, suggestions, versions, etc. -->
+
+
+## Additional information
+
+
+<!-- The line below ensures that proper tags are added to the issue. Please do not remove it. -- >
+/label ~"kind::Feature Request"