core: add file Contributing.asciidoc
This commit is contained in:
parent
b2a48a9913
commit
ecf18c81f7
45
Contributing.asciidoc
Normal file
45
Contributing.asciidoc
Normal file
@ -0,0 +1,45 @@
|
||||
= Reporting WeeChat issues
|
||||
:author: Sébastien Helleu
|
||||
:email: flashcode@flashtux.org
|
||||
|
||||
== Report bugs
|
||||
|
||||
Please follow *all* these instructions when reporting a bug:
|
||||
|
||||
* Use only English.
|
||||
* Always give the following 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).
|
||||
* If possible, please include a reproducible example: explain the steps which
|
||||
led you to the problem.
|
||||
* If you are reporting a crash:
|
||||
** Please report crash and attach 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
|
||||
|
||||
WeeChat is under active development, so your idea may already have been
|
||||
implemented, or scheduled for a future version (check in
|
||||
http://weechat.org/dev/[roadmap]).
|
||||
|
||||
Before submitting a feature request, it's better to discuss about it in IRC
|
||||
(server: 'chat.freenode.net', channel '#weechat').
|
||||
|
||||
== Contributing
|
||||
|
||||
If you want to fix a bug or add a new feature, it's always a good idea to
|
||||
discuss about it in IRC.
|
||||
|
||||
And you can look at http://weechat.org/[developer's guide] for coding rules
|
||||
(styles, naming convention, and other useful info).
|
@ -29,6 +29,7 @@ SUBDIRS = po doc intl src
|
||||
|
||||
EXTRA_DIST = AUTHORS.asciidoc \
|
||||
ChangeLog.asciidoc \
|
||||
Contributing.asciidoc \
|
||||
README.asciidoc \
|
||||
ReleaseNotes.asciidoc \
|
||||
CMakeLists.txt \
|
||||
|
1
debian/weechat-core.docs
vendored
1
debian/weechat-core.docs
vendored
@ -1,3 +1,4 @@
|
||||
AUTHORS.asciidoc
|
||||
Contributing.asciidoc
|
||||
README.asciidoc
|
||||
ReleaseNotes.asciidoc
|
||||
|
@ -99,6 +99,7 @@ weechat_CONTENTS="
|
||||
usr/share/man/
|
||||
usr/share/doc/weechat/AUTHORS.asciidoc
|
||||
usr/share/doc/weechat/ChangeLog.asciidoc
|
||||
usr/share/doc/weechat/Contributing.asciidoc
|
||||
usr/share/doc/weechat/COPYING
|
||||
usr/share/doc/weechat/README.asciidoc
|
||||
usr/share/doc/weechat/ReleaseNotes.asciidoc
|
||||
|
@ -65,7 +65,7 @@ rm -rf $RPM_BUILD_ROOT
|
||||
|
||||
%files -f %{name}.lang
|
||||
%defattr(-,root,root,0755)
|
||||
%doc AUTHORS.asciidoc ChangeLog.asciidoc COPYING README.asciidoc ReleaseNotes.asciidoc
|
||||
%doc AUTHORS.asciidoc ChangeLog.asciidoc Contributing.asciidoc COPYING README.asciidoc ReleaseNotes.asciidoc
|
||||
%doc %{_docdir}/%{name}/*.html
|
||||
%{_mandir}/man1/%{name}.1*
|
||||
%{_mandir}/*/man1/%{name}.1*
|
||||
|
Loading…
x
Reference in New Issue
Block a user