Contributing.txt 2.3 KB

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