summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSebastien Helleu <flashcode@flashtux.org>2014-03-05 14:04:23 +0100
committerSebastien Helleu <flashcode@flashtux.org>2014-03-05 14:04:23 +0100
commit659cf10f3baa454f99aaab85f6dfc77cb5299ba3 (patch)
tree5c1ba92915ed8f94f3d37f8615783d9cad2c1a0c
parent63b2b30d8039d1ec41e55c88c307f02228e93339 (diff)
downloadweechat-659cf10f3baa454f99aaab85f6dfc77cb5299ba3.zip
core: add sub-sections and note about scripts in Contributing.asciidoc
-rw-r--r--Contributing.asciidoc55
1 files changed, 37 insertions, 18 deletions
diff --git a/Contributing.asciidoc b/Contributing.asciidoc
index d29bba8f4..4cdcc3282 100644
--- a/Contributing.asciidoc
+++ b/Contributing.asciidoc
@@ -4,28 +4,47 @@
== Report bugs
-Please follow *all* these instructions when reporting a bug:
+First, some basic things:
-* Use only English.
-* Always give the following info:
-** The *version* of WeeChat: output of `/v` in WeeChat, for example:
+* Use only English to communicate with developers.
+* If you can, please check if the problem has been fixed in development version
+ (if you are using a stable release or old version).
+
+=== Required info
+
+Please give some info:
+
+* The *version* of WeeChat: output of `/v` in WeeChat, for example:
`WeeChat 0.4.4-dev (git: v0.4.3-215-g2d77782)`. +
If WeeChat does not start at all, give the version displayed by
- `weechat --help`.
-** The operating system, including distribution name and its version for Linux
- (examples: Linux Debian Wheezy, FreeBSD 10.0, Windows/Cygwin 64-bit, ...).
-* Check if the problem has been fixed in development version (if you are using a
- stable release or old version).
+ `weechat --help` (or the version installed with your package manager).
+* The operating system, including distribution name (for Linux) and its version
+ (examples: Linux Debian Wheezy, FreeBSD 10.0, Windows/Cygwin 64-bit, ...).
* If possible, please include a reproducible example: explain the steps which
- led you to the problem.
-* If you are reporting a crash:
-** Please attach the backtrace from gdb (look at
- http://weechat.org/files/doc/devel/weechat_user.en.html#report_crashes[user's guide]
- for more info).
-** Most of times, the WeeChat crash log file (`weechat_crash_YYYYMMDD_xxx.log`)
- is *not useful* to fix the bug, so please report this file *ONLY* if a
- developer asks you to send it (and be careful, this file can contain personal
- data like passwords).
+ led you to the problem. +
+ It's even better if you can reproduce the problem with a new config (and no
+ scripts loaded): try `weechat --dir /tmp/weechat` and check if you have the
+ problem here.
+
+=== Use of scripts
+
+If you are using scripts, they can cause problems/crashes. To check if the
+problem is related to one script, try to unload them one by one (using
+command `/script unload <name>`).
+
+If you think the problem comes from a specific script, please report the issue
+in the https://github.com/weechat/scripts[scripts git repository].
+
+=== Report a crash
+
+If you are reporting a crash, please attach the backtrace from gdb (look at
+http://weechat.org/files/doc/devel/weechat_user.en.html#report_crashes[user's guide]
+for more info).
+
+Most of times, the WeeChat crash log file (`weechat_crash_YYYYMMDD_xxx.log`) is
+*not useful* to fix the bug, so please report this file *ONLY* if a developer
+asks you to send it (and be careful, this file can contain personal data like
+passwords).
== Feature requests