Skip to content

Commit

Permalink
docs: Note new requirement to include a SPDX line
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
stephenfin committed Sep 19, 2018
1 parent e874c76 commit 15624c4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
6 changes: 6 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Contributing
============

For guidelines on contributing, refer to the `contributors documentation`__.

__ https://patchwork.readthedocs.io/en/latest/development/contributing/
21 changes: 18 additions & 3 deletions docs/development/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,25 @@ Contributing
Coding Standards
----------------

**Follow PEP8**. All code is currently PEP8 compliant and it should stay this
way.
**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 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 <[email protected]>
# Copyright (C) 2001 Joe Bloggs <[email protected]>
#
# 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:
Expand Down Expand Up @@ -148,6 +160,9 @@ announcements.
Further information about the Patchwork mailing list is available can be found on
`lists.ozlabs.org`_.

.. _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
Expand Down

0 comments on commit 15624c4

Please sign in to comment.