From patchwork Tue Sep 18 15:46:16 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Stephen Finucane X-Patchwork-Id: 971173 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.ozlabs.org (lists.ozlabs.org [203.11.71.2]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 42F6n23NmYz9sBs for ; Wed, 19 Sep 2018 01:47:02 +1000 (AEST) Authentication-Results: ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="Ni15xcQ+"; dkim-atps=neutral Received: from bilbo.ozlabs.org (lists.ozlabs.org [IPv6:2401:3900:2:1::3]) by lists.ozlabs.org (Postfix) with ESMTP id 42F6n21gjWzF3FZ for ; Wed, 19 Sep 2018 01:47:02 +1000 (AEST) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="Ni15xcQ+"; dkim-atps=neutral X-Original-To: patchwork@lists.ozlabs.org Delivered-To: patchwork@lists.ozlabs.org Authentication-Results: lists.ozlabs.org; spf=none (mailfrom) smtp.mailfrom=that.guru (client-ip=185.234.75.7; helo=relay-direct7.mxroute.com; envelope-from=stephen@that.guru; receiver=) Authentication-Results: lists.ozlabs.org; dmarc=none (p=none dis=none) header.from=that.guru Authentication-Results: lists.ozlabs.org; dkim=fail reason="key not found in DNS" (0-bit key; unprotected) header.d=that.guru header.i=@that.guru header.b="Ni15xcQ+"; dkim-atps=neutral Received: from relay-direct7.mxroute.com (relay-direct7.mxroute.com [185.234.75.7]) (using TLSv1.2 with cipher ADH-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by lists.ozlabs.org (Postfix) with ESMTPS id 42F6mx5P6rzF3FG for ; Wed, 19 Sep 2018 01:46:57 +1000 (AEST) Received: from filter002.mxroute.com (unknown [185.133.192.179]) by relay-direct7.mxroute.com (Postfix) with ESMTP id 786863F357; Tue, 18 Sep 2018 15:46:25 +0000 (UTC) Received: from one.mxroute.com (one.mxroute.com [195.201.59.211]) by filter002.mxroute.com (Postfix) with ESMTPS id 624063F0D8; Tue, 18 Sep 2018 15:46:25 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=that.guru; s=default; h=References:In-Reply-To:Message-Id:Date:Subject:Cc:To:From: Sender:Reply-To:MIME-Version:Content-Type:Content-Transfer-Encoding: Content-ID:Content-Description:Resent-Date:Resent-From:Resent-Sender: Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=FQzG2N8KuH8Cym2/PZBJZRLPfN8z0UwKcuOd6qd8SDs=; b=Ni15xcQ+FnxEt7clyCsBNzyiRz S8oJoAgzVfnzJhGVdGIJ/zleOweO05nzkRBWXeTppr7dz32ZVzdwbwO7pLBbgY/JnzTbFVqjX/rSy qZw4SCjX7jhc4S9GMKIKIIbhi+K3Zl1fUn5wtoU0/LPaxgrAMTCPEbNhFv4nDS3S8Sqlc5qOfQmWr eizGp6FapmzHy/WVYbfaFla7HRGmB9aWhRjsdFU2RtmOshC6AUQlv4ZYcgR/o1inToA2Vad/tRMfS hn5vNYPdZfQNTDDxGgPxxiDix9EmuQzba9eRhRwt3jKkhSDNPtSJ4KRtUe5KtKH1YMnHwF+v+i6uF mq8koQLQ==; From: Stephen Finucane To: patchwork@lists.ozlabs.org Subject: [PATCH v3 2/2] docs: Note new requirement to include a SPDX line Date: Tue, 18 Sep 2018 16:46:16 +0100 Message-Id: <20180918154616.3349-2-stephen@that.guru> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20180918154616.3349-1-stephen@that.guru> References: <20180918154616.3349-1-stephen@that.guru> X-AuthUser: stephen@that.guru X-BeenThere: patchwork@lists.ozlabs.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Patchwork development List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , MIME-Version: 1.0 Errors-To: patchwork-bounces+incoming=patchwork.ozlabs.org@lists.ozlabs.org Sender: "Patchwork" 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 Cc: Daniel Axtens Cc: Veronika Kabatova Reviewed-by: Veronika Kabatova --- v3: - Update to reflect use of 'GPL-2.0-or-later', rather than 'GPL-2.0' --- 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 @@ +Contributing +============ + +For guidelines on contributing, refer to the `contributors documentation`__. + +__ https://patchwork.readthedocs.io/en/latest/development/contributing/ diff --git a/docs/development/contributing.rst b/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 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 + # Copyright (C) 2001 Joe Bloggs + # + # 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 `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