Return to Contributing.txt CVS log

Up to [local] / ircnowd / doc

Annotation of ircnowd/doc/Contributing.txt, Revision 1.1.1.1

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