[libcamera-devel,v1,5/5] Documentation: contributing: Integrate the code of conduct

19205 diff mbox series

Now that libcamera has an official code of conduct, mention it in the
'contributing' document with a clear indication that all community
members are expected to follow the code of conduct.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/code-of-conduct.rst | 2 ++
 Documentation/contributing.rst    | 5 +++++
 Documentation/meson.build         | 1 +
 3 files changed, 8 insertions(+)

Quoting Laurent Pinchart via libcamera-devel (2023-11-10 14:23:11)
> Now that libcamera has an official code of conduct, mention it in the
> 'contributing' document with a clear indication that all community
> members are expected to follow the code of conduct.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/code-of-conduct.rst | 2 ++
>  Documentation/contributing.rst    | 5 +++++
>  Documentation/meson.build         | 1 +
>  3 files changed, 8 insertions(+)
> 
> diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst
> index cdf7dd2c88fb..38b7d7ad679f 100644
> --- a/Documentation/code-of-conduct.rst
> +++ b/Documentation/code-of-conduct.rst
> @@ -1,5 +1,7 @@
>  .. SPDX-License-Identifier: CC-BY-4.0
>  
> +.. _code-of-conduct:
> +
>  Contributor Covenant Code of Conduct
>  ====================================
>  
> diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> index 2f0b4921f7e6..32d7d0ef319a 100644
> --- a/Documentation/contributing.rst
> +++ b/Documentation/contributing.rst
> @@ -8,6 +8,10 @@ Whether you would like to help with coding, documentation, testing, proposing
>  new features, or just discussing the project with the community, you can join
>  our official public communication channels, or simply check out the code.
>  
> +The project adheres to a :ref:`code of conduct <code-of-conduct>` that
> +maintainers, contributors and in general community members are expected to

'and in general community members' ? This makes it sounds like the expectation is only
generally expected to apply (which sounds optional) rather than perhaps

'and general community members' ... which conveys 'all additional
community members' and is probably what I think you intended here.

Or removing 'in general' could be clearer too.

With that

Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>

> +follow in all online and offline communication.
> +
>  Mailing List
>  ------------
>  
> @@ -134,4 +138,5 @@ By making a contribution to this project, I certify that:
>  .. toctree::
>     :hidden:
>  
> +   Code of Conduct <code-of-conduct>
>     Coding Style <coding-style>
> diff --git a/Documentation/meson.build b/Documentation/meson.build
> index 7c1502592baa..3eb2897e6b2b 100644
> --- a/Documentation/meson.build
> +++ b/Documentation/meson.build
> @@ -64,6 +64,7 @@ endif
>  if sphinx.found()
>      docs_sources = [
>          'camera-sensor-model.rst',
> +        'code-of-conduct.rst',
>          'coding-style.rst',
>          'conf.py',
>          'contributing.rst',
> -- 
> Regards,
> 
> Laurent Pinchart
>

Hi Kieran,

On Fri, Nov 24, 2023 at 04:08:30PM +0000, Kieran Bingham wrote:
> Quoting Laurent Pinchart via libcamera-devel (2023-11-10 14:23:11)
> > Now that libcamera has an official code of conduct, mention it in the
> > 'contributing' document with a clear indication that all community
> > members are expected to follow the code of conduct.
> > 
> > Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> > ---
> >  Documentation/code-of-conduct.rst | 2 ++
> >  Documentation/contributing.rst    | 5 +++++
> >  Documentation/meson.build         | 1 +
> >  3 files changed, 8 insertions(+)
> > 
> > diff --git a/Documentation/code-of-conduct.rst b/Documentation/code-of-conduct.rst
> > index cdf7dd2c88fb..38b7d7ad679f 100644
> > --- a/Documentation/code-of-conduct.rst
> > +++ b/Documentation/code-of-conduct.rst
> > @@ -1,5 +1,7 @@
> >  .. SPDX-License-Identifier: CC-BY-4.0
> >  
> > +.. _code-of-conduct:
> > +
> >  Contributor Covenant Code of Conduct
> >  ====================================
> >  
> > diff --git a/Documentation/contributing.rst b/Documentation/contributing.rst
> > index 2f0b4921f7e6..32d7d0ef319a 100644
> > --- a/Documentation/contributing.rst
> > +++ b/Documentation/contributing.rst
> > @@ -8,6 +8,10 @@ Whether you would like to help with coding, documentation, testing, proposing
> >  new features, or just discussing the project with the community, you can join
> >  our official public communication channels, or simply check out the code.
> >  
> > +The project adheres to a :ref:`code of conduct <code-of-conduct>` that
> > +maintainers, contributors and in general community members are expected to
> 
> 'and in general community members' ? This makes it sounds like the expectation is only
> generally expected to apply (which sounds optional) rather than perhaps
> 
> 'and general community members' ... which conveys 'all additional
> community members' and is probably what I think you intended here.
> 
> Or removing 'in general' could be clearer too.

I'll drop "in general" and write "and community members".

> With that
> 
> Reviewed-by: Kieran Bingham <kieran.bingham@ideasonboard.com>
> 
> > +follow in all online and offline communication.
> > +
> >  Mailing List
> >  ------------
> >  
> > @@ -134,4 +138,5 @@ By making a contribution to this project, I certify that:
> >  .. toctree::
> >     :hidden:
> >  
> > +   Code of Conduct <code-of-conduct>
> >     Coding Style <coding-style>
> > diff --git a/Documentation/meson.build b/Documentation/meson.build
> > index 7c1502592baa..3eb2897e6b2b 100644
> > --- a/Documentation/meson.build
> > +++ b/Documentation/meson.build
> > @@ -64,6 +64,7 @@ endif
> >  if sphinx.found()
> >      docs_sources = [
> >          'camera-sensor-model.rst',
> > +        'code-of-conduct.rst',
> >          'coding-style.rst',
> >          'conf.py',
> >          'contributing.rst',