You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,6 +19,8 @@ Thank you for your help!
19
19
20
20
New scripts are added with pull requests against master branch of this repository, using the pull request template called `Add script`.
21
21
22
+
### Guidelines
23
+
22
24
**Important:** please fill the pull request template and follow **all** these rules, otherwise your new script will be rejected:
23
25
24
26
- pull request:
@@ -34,7 +36,7 @@ New scripts are added with pull requests against master branch of this repositor
34
36
- 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)
35
37
- script content:
36
38
- 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))
38
40
- consider using [Semantic versioning](https://semver.org/) (recommended, not mandatory); only digits and dots are allowed in version
39
41
- use only English for code and comments
40
42
- 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
44
46
45
47
Your script is automatically checked in CI, see [Automatic checks on scripts](#automatic-checks-on-scripts).
46
48
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/).
0 commit comments