[PATCH v2] doc: update CONTRIBUTING and add MAINTAINERS file

Rodrigo Vivi rodrigo.vivi at intel.com
Tue Oct 30 15:56:45 UTC 2018


On Tue, Oct 30, 2018 at 03:25:45PM +0200, Jani Nikula wrote:
> Refresh contributing, accept issues at fdo gitlab, and add separate
> maintainers file for clarity.
> 
> v2: Also add link to the gitlab project members page.
> 
> Cc: Sean Paul <sean at poorly.run>
> Cc: Rodrigo Vivi <rodrigo.vivi at intel.com>
> Cc: Daniel Vetter <daniel at ffwll.ch>
> Cc: Daniel Stone <daniel at fooishbar.org>
> Signed-off-by: Jani Nikula <jani.nikula at intel.com>

Reviewed-by: Rodrigo Vivi <rodrigo.vivi at intel.com>

> ---
>  CONTRIBUTING.rst | 20 +++++++++++++++-----
>  MAINTAINERS.rst  | 14 ++++++++++++++
>  index.rst        |  1 +
>  3 files changed, 30 insertions(+), 5 deletions(-)
>  create mode 100644 MAINTAINERS.rst
> 
> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
> index c7846e318b7e..2a83590e0442 100644
> --- a/CONTRIBUTING.rst
> +++ b/CONTRIBUTING.rst
> @@ -1,11 +1,21 @@
> -CONTRIBUTING
> -============
> +.. _contributing:
>  
> -Submit patches, bug reports, and questions for any of the maintainer tools and
> -documentation to the dim-tools at lists.freedesktop.org mailing list.
> +==========================
> + Contributing and Contact
> +==========================
> +
> +Please use the `dim-tools at lists.freedesktop.org`_ mailing list for
> +contributions, bug reports, and discussion about the tooling and
> +documentation. You may also file `issues`_ at the `project home page`_.
>  
>  Please make sure your patches pass the build and self tests by running::
>  
>    $ make check
>  
> -Push the patches once you have an ack from maintainers (Jani/Daniel).
> +Push the patches once you have an ack from :ref:`maintainers`.
> +
> +.. _dim-tools at lists.freedesktop.org: https://lists.freedesktop.org/mailman/listinfo/dim-tools
> +
> +.. _issues: https://gitlab.freedesktop.org/drm/maintainer-tools/issues
> +
> +.. _project home page: https://gitlab.freedesktop.org/drm/maintainer-tools/
> diff --git a/MAINTAINERS.rst b/MAINTAINERS.rst
> new file mode 100644
> index 000000000000..792f183e66d8
> --- /dev/null
> +++ b/MAINTAINERS.rst
> @@ -0,0 +1,14 @@
> +.. _maintainers:
> +
> +=============
> + Maintainers
> +=============
> +
> +The maintainer tools and documentation is maintained by:
> +
> +* Daniel Vetter <daniel.vetter at ffwll.ch>
> +* Jani Nikula <jani.nikula at intel.com>
> +
> +See also the full and current list of `project members`_.
> +
> +.. _project members: https://gitlab.freedesktop.org/drm/maintainer-tools/project_members
> diff --git a/index.rst b/index.rst
> index 46ba235514c8..228ca8790f59 100644
> --- a/index.rst
> +++ b/index.rst
> @@ -17,6 +17,7 @@ Contents:
>     dim
>     qf
>     CONTRIBUTING
> +   MAINTAINERS
>     TODO
>  
>  Indices and tables
> -- 
> 2.11.0
> 


More information about the dim-tools mailing list