Skip to content

Commit 0d5a8ab

Browse files
committed
Add SPDX tags in contributing guide
1 parent 48cfab5 commit 0d5a8ab

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Thank you for your help!
1919

2020
New scripts are added with pull requests against master branch of this repository, using the pull request template called `Add script`.
2121

22+
### Guidelines
23+
2224
**Important:** please fill the pull request template and follow **all** these rules, otherwise your new script will be rejected:
2325

2426
- pull request:
@@ -34,7 +36,7 @@ New scripts are added with pull requests against master branch of this repositor
3436
- do **NOT** use the word "weechat" in the script name: for example prefer `notify.py` to `weechat_notify.py` (the script is only for WeeChat)
3537
- script content:
3638
- do **NOT** use a shebang on the first line (like `#!/usr/bin/perl`), this is not needed
37-
- write a comment at the beginning with your name (or pseudo), your e-mail and the chosen license (which must be free)
39+
- write a comment at the beginning with your name (or pseudo), your e-mail and the chosen license, which must be free (see [Copyright and license](#copyright-and-license))
3840
- consider using [Semantic versioning](https://semver.org/) (recommended, not mandatory); only digits and dots are allowed in version
3941
- use only English for code and comments
4042
- do **NOT** use an extra API between WeeChat and your script (like Ruby gem "WeeChat"), use the standard WeeChat API only
@@ -44,6 +46,18 @@ New scripts are added with pull requests against master branch of this repositor
4446

4547
Your script is automatically checked in CI, see [Automatic checks on scripts](#automatic-checks-on-scripts).
4648

49+
### Copyright and license
50+
51+
The copyright and license must be present in header, using [SPDX](https://spdx.dev/) tags, see the [list of licenses](https://spdx.org/licenses/).
52+
53+
Example of header in a Python script:
54+
55+
```python
56+
# SPDX-FileCopyrightText: 2025 Your Name <[email protected]>
57+
#
58+
# SPDX-License-Identifier: GPL-3.0-or-later
59+
```
60+
4761
## Updating a script
4862

4963
### Contacting the author

0 commit comments

Comments
 (0)