Skip to content

Commit 15624c4

Browse files
committed
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 <[email protected]> Reviewed-by: Veronika Kabatova <[email protected]>
1 parent e874c76 commit 15624c4

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

CONTRIBUTING.rst

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Contributing
2+
============
3+
4+
For guidelines on contributing, refer to the `contributors documentation`__.
5+
6+
__ https://patchwork.readthedocs.io/en/latest/development/contributing/

docs/development/contributing.rst

+18-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,25 @@ Contributing
44
Coding Standards
55
----------------
66

7-
**Follow PEP8**. All code is currently PEP8 compliant and it should stay this
8-
way.
7+
**Follow PEP8**. All code is currently `PEP 8`_ compliant and it should stay
8+
this way.
9+
10+
All code must be licensed using `GPL v2.0 or later`_ and must have a `SPDX
11+
License Identifier`_ stating this. A copyright line should be included on new
12+
files and may be added for significant changes to existing files.
13+
14+
.. code-block:: python
15+
16+
# Patchwork - automated patch tracking system
17+
# Copyright (C) 2000 Jane Doe <[email protected]>
18+
# Copyright (C) 2001 Joe Bloggs <[email protected]>
19+
#
20+
# SPDX-License-Identifier: GPL-2.0-or-later
921
1022
Changes that fix semantic issues will be generally be happily received, but
1123
please keep such changes separate from functional changes.
1224

13-
`pep8` targets are provided via tox. Refer to the :ref:`testing` section
25+
``pep8`` targets are provided via tox. Refer to the :ref:`testing` section
1426
below for more information on usage of this tool.
1527

1628
.. _testing:
@@ -148,6 +160,9 @@ announcements.
148160
Further information about the Patchwork mailing list is available can be found on
149161
`lists.ozlabs.org`_.
150162

163+
.. _PEP 8: https://pep8.org/
164+
.. _GPL v2.0 or later: https://spdx.org/licenses/GPL-2.0-or-later.html
165+
.. _SPDX License Identifier: https://spdx.org/using-spdx-license-identifier
151166
.. _tox: https://tox.readthedocs.io/en/latest/
152167
.. _reno: https://docs.openstack.org/developer/reno/
153168
.. _QEMU guidelines: http://wiki.qemu.org/Contribute/SubmitAPatch

0 commit comments

Comments
 (0)