[PATCH v2 2/2] docs: Note new requirement to include a SPDX line
stephen at that.guru
Tue Sep 18 03:17:00 AEST 2018
Add some wording around the requirement to include this line instead of
the license header. Also note the requirement that all code be
GPLv2-licensed and add a CONTRIBUTING document, which GitHub likes.
Signed-off-by: Stephen Finucane <stephen at that.guru>
Cc: Daniel Axtens <dja at axtens.net>
CONTRIBUTING.rst | 6 ++++++
docs/development/contributing.rst | 20 +++++++++++++++++---
2 files changed, 23 insertions(+), 3 deletions(-)
create mode 100644 CONTRIBUTING.rst
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
@@ -0,0 +1,6 @@
+For guidelines on contributing, refer to the `contributors documentation`__.
diff --git a/docs/development/contributing.rst b/docs/development/contributing.rst
index 7e2a72cf..bada3938 100644
@@ -4,13 +4,25 @@ Contributing
-**Follow PEP8**. All code is currently PEP8 compliant and it should stay this
+**Follow PEP8**. All code is currently `PEP 8`_ compliant and it should stay
+All code must be GPLv2 licensed and must have a `SPDX License Identifier`_
+stating this. A copyright line should be included on new 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
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.
@@ -148,6 +160,8 @@ announcements.
Further information about the Patchwork mailing list is available can be found on
+.. _PEP 8: https://pep8.org/
+.. _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