Contributing.adoc 2.22 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34
= Contributing to WeeChat scripts
:author: Sébastien Helleu
:email: flashcode@flashtux.org
:lang: en


== Add a script

To submit a new script in this repository, please use the form at:
https://weechat.org/scripts/add/

There are strict rules for new scripts, please read them carefully, otherwise
your script will be rejected.

Pending scripts are visible at: https://weechat.org/scripts/pending/

== Update a script

=== Contact the author

Before updating a script, you *must* contact the author of script directly,
and discuss about your changes (to check if it's OK), especially if you are
adding new features or if you are changing the behavior of the script.

For example, if the author uses a GitHub repository for the script, you can
send a pull request to the author (instead of sending directly to this
repository). +
Then the author will send a pull request on this repository.

=== Send new release

There are two ways to send a new release for a script:

* Send a pull request, the commit message must have the name of script,
35 36 37
  version, and changes, like that: +
  `script.py 0.3: fix...` +
  Please submit only one script per pull request.
38 39 40 41 42 43
* Use the form at: <https://weechat.org/scripts/update/>.

When sending a new version :

* Don't forget to update the version number in the script (used in `register`
  function) and the ChangeLog (if there is one).
44 45 46
* Do *not* update the author name in script (used in `register` function);
  it must always contain the original script author, even if you are doing
  large updates in the script.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61
* If the script is tagged `py3k-ok` (script running fine with Python 3.x),
  please ensure that your update is still compatible with both
  Python 2.x *AND* 3.x.

== Report an issue

Before reporting an issue, it's better to contact the author of script
directly.

If you have no answer, or if the author has no time to fix the problem, then
you can report the issue in the tracker (or send an update of script if you are
able to fix yourself).

When reporting an issue, please give the following info:

62 63
* Your *WeeChat version*: the output of `/v` in WeeChat, for example:
  _WeeChat 1.7-dev (git: v1.6-6-g997f47f)_.
64 65
* If possible, please include a reproducible example: explain the steps which
  led you to the problem.