Skip to content

Commit 73ea941

Browse files
kartbencfriedt
authored andcommitted
doc: contribute: guidelines: update copyright notice guidelines
Similar to SPDX-License-Identifier, there is a standard way to add copyright notices to source code so update the guidelines so that recommendation is that copyright notices are added using SPDX-FileCopyrightText. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 8658ce5 commit 73ea941

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

doc/contribute/guidelines.rst

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -101,21 +101,38 @@ this contributing and review process for imported components.
101101

102102
.. _copyrights:
103103

104-
Copyrights Notices
105-
******************
104+
Copyright and License Notices
105+
=============================
106106

107-
The Zephyr Project follows the `Community Best Practice`_ for Copyright Notices from the Linux
108-
Foundation.
107+
Zephyr follows SPDX/REUSE-style file headers. Add a machine-readable copyright notice and a license
108+
identifier at the top of each file so tooling can detect them (for example
109+
:ref:`west spdx <west-spdx>`, which uses the `REUSE tool`_).
109110

110-
We recommend using the following copyright notice:
111+
The Zephyr Project follows the `Community Best Practice`_ for copyright notices from the Linux
112+
Foundation, therefore we recommend using the following copyright notice:
111113

112-
.. code-block:: C
114+
.. code-block:: none
115+
116+
SPDX-FileCopyrightText: Copyright The Zephyr Project Contributors
117+
118+
Include the license identifier alongside it:
119+
120+
.. code-block:: none
121+
122+
SPDX-License-Identifier: Apache-2.0
113123
114-
Copyright The Zephyr Project Contributors
124+
Practical guidance:
125+
126+
- Place both lines at the very top of the file using the file's native comment syntax.
127+
- If you authored substantial, original content, you *may* add an additional line for yourself or
128+
your organization.
115129

116130
.. _Community Best Practice:
117131
https://www.linuxfoundation.org/blog/copyright-notices-in-open-source-software-projects/
118132

133+
.. _REUSE tool:
134+
https://github.com/fsfe/reuse-tool
135+
119136
.. _DCO:
120137

121138
Developer Certification of Origin (DCO)

0 commit comments

Comments
 (0)