Re: [PATCH hwc v1] drm_hwcomposer: Add CONTRIBUTING file

[Robert Foss <robert.foss@collabora.com>]

Hey Emil,

On Wed, 2017-09-27 at 15:42 +0100, Emil Velikov wrote:
> Hi Rob,
> 
> Glad to see this. There's a couple of suggestions that I hope you'll
> find worth while.
> 
> On 22 September 2017 at 01:37, Robert Foss <robert.foss@collabora.com
> > wrote:
> > Some basic guidelines for contributions could come in handy.
> > 
> > These are copied from IGT and modified to be suitable.
> > 
> > Signed-off-by: Robert Foss <robert.foss@collabora.com>
> > ---
> >  CONTRIBUTING | 31 +++++++++++++++++++++++++++++++
> >  1 file changed, 31 insertions(+)
> >  create mode 100644 CONTRIBUTING
> > 
> > diff --git a/CONTRIBUTING b/CONTRIBUTING
> > new file mode 100644
> > index 0000000..f1b4775
> > --- /dev/null
> > +++ b/CONTRIBUTING
> > @@ -0,0 +1,31 @@
> > +Patches to drm_hwcomposer are very much welcome, we really want
> > this to be the
> > +universal HW composer implementation for Android and similar
> > platforms
> > +So please bring on porting patches, bugfixes, improvements for
> > documentation
> > +and new features.
> > +
> > +A short list of contribution guidelines:
> > +
> > +- Please submit patches formatted with git send-email/git format-
> > patch or
> > +  equivalent to
> > +
> > +    dri-devel <dri-devel@lists.freedesktop.org>
> > +
> > +  Please use --subject-prefix="PATCH hwc" so that drm_hwcomposer
> > patches are easily
> > +  identified in the massive amount mails on dri-devel. To ensure
> > this is always
> > +  done, run:
> > +
> > +    git config format.subjectprefix "PATCH hwc"
> > +
> 
> One can add this into the autogen.sh or whatever bootstrap file the
> project uses.
> For example see https://cgit.freedesktop.org/mesa/drm/tree/autogen.sh

Adding an autogen.sh sounds like a good idea to me.

> 
> 
> > +- When submitting new code please follow the naming conventions
> > documented
> > +  in the generated documentation. Also please make full use of all
> > the helpers and
> > +  convenience macros provided by drm_hwcomposer. The below command
> > can help you
> > +  with formatting of your patches:
> > +  git diff | clang-format-diff-3.5 -p 1 -style=file
> > +
> 
> One could wire that in the pre-merge hook on the server side.
> It should be quite lightweight, although I'm not sure about the
> integration with FDO's Debian(?) setup ;-)

Yeah, me neither. Maybe asking Daniel Stone about how this should be
done is the next step.

_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/dri-devel