Re: [PATCH v4l-utils] CONTRIBUTE: Add simple contribution instructions

[Laurent Pinchart <laurent.pinchart@ideasonboard.com>]

On Thu, Jun 05, 2025 at 02:54:33PM +0200, Ricardo Ribalda wrote:
> On Thu, 5 Jun 2025 at 14:46, Laurent Pinchart wrote:
> > On Thu, Jun 05, 2025 at 12:09:57PM +0000, Ricardo Ribalda wrote:
> > > In the media summit we discussed the need of a special prefix for
> > > v4l-utils. This helps patchwork and media-ci.
> > >
> > > Create a new file with a brief introductions on how to contribute and
> > > make the `v4l-utils` official.
> > >
> > > Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> >
> > I think this is a good idea. I don't know how we'll get users to
> > actually use the prefix, but documenting it is a necessary first step.
> 
> I can add a comment in the media-ci email. Something like:
> 
> I could not apply your series. Maybe it is for v4l-utils, if so,
> please check  http://XXXX/CONTRIBUTE.md

Sounds good. Then we can complain that people don't read instructions
:-)

> > > ---
> > >  CONTRIBUTE.md | 19 +++++++++++++++++++
> > >  1 file changed, 19 insertions(+)
> > >
> > > diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
> > > new file mode 100644
> > > index 0000000000000000000000000000000000000000..19a2c5814b45462f3cfeea921e277f8da00ccbd1
> > > --- /dev/null
> > > +++ b/CONTRIBUTE.md
> > > @@ -0,0 +1,19 @@
> > > +## Repository
> > > +
> > > +v4l-utils official repository is hosted at https://git.linuxtv.org/v4l-utils.git
> > > +
> > > +## Contributions
> > > +
> > > +Patches are welcome! Please send your patches to `linux-media@vger.kernel.org`
> > > +using the prefix `[PATCH v4l-utils]`.
> >
> > Nitpicking, I was thinking of '[v4l-utils] [PATCH]' as that's what I
> > used previously. Looking at the list archives, both (and more) have been
> > used. I don't object to using '[PATCH v4l-utils]' if that's easier for
> 
> This seems to be prefered by b4.... and who does not love b4 :P?
> 
> > tools.
> >
> > I have this in my .git/config for v4l-utils:
> >
> > [format]
> >         subjectPrefix = "v4l-utils] [PATCH"
> >
> > With your proposal, this would be
> >
> > [format]
> >         subjectPrefix = "PATCH v4l-utils"
> >
> > In either case, let's document this in addition to the b4 configuration.
> 
> Something like this?:
> 
> diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md
> index 19a2c581..708939df 100644
> --- a/CONTRIBUTE.md
> +++ b/CONTRIBUTE.md
> @@ -5,7 +5,11 @@ v4l-utils official repository is hosted at
> https://git.linuxtv.org/v4l-utils.git
>  ## Contributions
> 
>  Patches are welcome! Please send your patches to `linux-media@vger.kernel.org`
> -using the prefix `[PATCH v4l-utils]`.
> +using the prefix `[PATCH v4l-utils]`. E.g:
> +
> +```
> +git config set format.subjectPrefix "PATCH v4l-utils"
> +```

OK. Please check that setting both format.subjectPrefix and
b4.send-prefixes will not add the prefix twice when using b4.

>  ## b4 config
> 
> > > +
> > > +## b4 config
> > > +
> > > +If you use b4[1] for your contributor workflow you can use these options:
> > > +
> > > +```
> > > +git config set b4.send-series-cc linux-media@vger.kernel.org
> > > +git config set b4.send-prefixes v4l-utils
> > > +```
> > > +
> > > +[1] https://b4.docs.kernel.org/en/latest/contributor/overview.html
> > >
> > > ---
> > > base-commit: 0d4e8e2d4e2d9d87863222e03fd3a6a4a3ff3d86
> > > change-id: 20250605-prefix-a1a47dbdaa75

-- 
Regards,

Laurent Pinchart