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