02
2011-06-24
alex
ngIRCd - Next Generation IRC Server
03
2011-06-24
alex
http://ngircd.barton.de/
05
2015-07-19
alex
(c)2001-2015 Alexander Barton and Contributors.
06
2011-06-24
alex
ngIRCd is free software and published under the
07
2011-06-24
alex
terms of the GNU General Public License.
09
2011-06-24
alex
-- Contributing.txt --
12
2011-06-24
alex
If you want to contribute to ngIRCd, please read the following paragraphs to
13
2011-06-24
alex
get an idea of how to do it the best :-)
15
2011-06-24
alex
- Use GIT
17
2011-06-24
alex
The source code of ngIRCd is maintained using GIT, see doc/GIT.txt. So if
18
2015-09-06
alex
remotely possible, use GIT for your work, too. It makes your and our lives
19
2011-06-24
alex
much easier ;-)
21
2011-06-24
alex
- Don't forget to include documentation
23
2011-06-24
alex
When adding features and new configuration options, don't forget to not
24
2011-06-24
alex
only code the features but to describe them in doc/sample-ngircd.conf,
25
2011-06-24
alex
man/ngircd.8.tmp and/or man/ngircd.conf.5.tmpl as well!
27
2011-06-24
alex
- Be present on IRC
29
2011-06-24
alex
If you intend to code some new features or do some code cleanups or better
30
2011-06-24
alex
documentation, please be present on <irc://irc.barton.de/#ngircd> and
31
2011-06-24
alex
discuss your plans early! So other developers have an idea on what others
32
2011-06-24
alex
are working on, can offer help, and can synchronize their own work.
34
2011-06-24
alex
- Check and validate your work!
36
2011-06-24
alex
Use "make check" to validate your work, and use "make distcheck" to
37
2011-06-24
alex
validate the resulting archives, especially when adding/removing files!
39
2011-06-24
alex
- Send patches in "unified diff" format
41
2011-06-24
alex
Please send patches in "unified" format, that is, use "diff -u".
42
2011-06-24
alex
Or even better: use GIT ("git diff"), see above.
44
2011-06-24
alex
- Send patches to the mailing list
46
2011-06-24
alex
If you have some code to present, send the patch(es) and/or pointers to
47
2011-06-24
alex
your GIT repository to the official ngIRCd mailing list for review, not
48
2011-06-24
alex
only to #ngircd: so it becomes archived and more people have a chance to
49
2011-06-24
alex
review your patch.
51
2011-06-24
alex
Sure it is a good idea to post some notes to #ngircd, too! :-)
53
2011-06-24
alex
And this is open source, your work must not be 100% finished and perfect,
54
2011-06-24
alex
work in progress is interesting, too: "release early, release often"!
56
2015-07-19
alex
- Use GitHub to create "Pull Requests"
58
2015-07-19
alex
ngIRCd is hosted on GitHub (<https://github.com/ngircd>), so please use the
59
2015-07-19
alex
tools available there and open issues (comment!) and create pull requests!
60
2015-07-19
alex
See <https://help.github.com/articles/using-pull-requests/> for details.