[PATCH v3 2/2] docs: Note new requirement to include a SPDX line
vkabatov at redhat.com
Wed Sep 19 02:11:42 AEST 2018
----- Original Message -----
> From: "Stephen Finucane" <stephen at that.guru>
> To: patchwork at lists.ozlabs.org
> Cc: "Stephen Finucane" <stephen at that.guru>, "Daniel Axtens" <dja at axtens.net>, "Veronika Kabatova"
> <vkabatov at redhat.com>
> Sent: Tuesday, September 18, 2018 5:46:16 PM
> Subject: [PATCH v3 2/2] docs: Note new requirement to include a SPDX line
> Add some wording around the requirement to include this line instead of
> the license header. Also note the requirement that all code be licensed
> using the 'GPL-2.0-or-later' license and add a CONTRIBUTING document,
> which GitHub likes.
> Signed-off-by: Stephen Finucane <stephen at that.guru>
> Cc: Daniel Axtens <dja at axtens.net>
> Cc: Veronika Kabatova <vkabatov at redhat.com>
> - Update to reflect use of 'GPL-2.0-or-later', rather than 'GPL-2.0'
Thanks for looking into it so quick after the comment!
To both updated patches (one of which fails to show up on the list):
Reviewed-by: Veronika Kabatova <vkabatov at redhat.com>
> CONTRIBUTING.rst | 6 ++++++
> docs/development/contributing.rst | 21 ++++++++++++++++++---
> 2 files changed, 24 insertions(+), 3 deletions(-)
> create mode 100644 CONTRIBUTING.rst
> diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
> new file mode 100644
> index 00000000..131e2dcb
> --- /dev/null
> +++ b/CONTRIBUTING.rst
> @@ -0,0 +1,6 @@
> +For guidelines on contributing, refer to the `contributors documentation`__.
> +__ https://patchwork.readthedocs.io/en/latest/development/contributing/
> diff --git a/docs/development/contributing.rst
> index 7e2a72cf..5089bba8 100644
> --- a/docs/development/contributing.rst
> +++ b/docs/development/contributing.rst
> @@ -4,13 +4,25 @@ Contributing
> Coding Standards
> -**Follow PEP8**. All code is currently PEP8 compliant and it should stay
> +**Follow PEP8**. All code is currently `PEP 8`_ compliant and it should stay
> +this way.
> +All code must be licensed using `GPL v2.0 or later`_ and must have a `SPDX
> +License Identifier`_ stating this. A copyright line should be included on
> +files and may be added for significant changes to existing files.
> +.. code-block:: python
> + # Patchwork - automated patch tracking system
> + # Copyright (C) 2000 Jane Doe <jane.doe at example.com>
> + # Copyright (C) 2001 Joe Bloggs <joebloggs at example.com>
> + #
> + # SPDX-License-Identifier: GPL-2.0-or-later
> Changes that fix semantic issues will be generally be happily received, but
> please keep such changes separate from functional changes.
> -`pep8` targets are provided via tox. Refer to the :ref:`testing` section
> +``pep8`` targets are provided via tox. Refer to the :ref:`testing` section
> below for more information on usage of this tool.
> .. _testing:
> @@ -148,6 +160,9 @@ announcements.
> Further information about the Patchwork mailing list is available can be
> found on
> +.. _PEP 8: https://pep8.org/
> +.. _GPL v2.0 or later: https://spdx.org/licenses/GPL-2.0-or-later.html
> +.. _SPDX License Identifier: https://spdx.org/using-spdx-license-identifier
> .. _tox: https://tox.readthedocs.io/en/latest/
> .. _reno: https://docs.openstack.org/developer/reno/
> .. _QEMU guidelines: http://wiki.qemu.org/Contribute/SubmitAPatch
More information about the Patchwork