Contributing

License

ZenIRCBot is covered by an MIT license, any code contributed will be required to be covered by this license as well.

Issues

The GitHub issue tracker is the prefered method of reporting an issue. Please do not apply any tags or milestones, I will do that myself when I triage the issue.

Code

If you write code and would like it integrated with the code base please follow the following steps:

  1. Fork the repo
  2. Create a branch in your repo
  3. Do you bug fix/feature add/hackery
  4. Send a pull request from that branch
  5. Do not delete your fork until the pull request has been accepted or declined in such a way that you do not want to continue development on it.

Tests

There are some integration tests in the tests folder. You will need to have circus, and ngIRCd installed in order to use them. You run them like so:

$ cd tests/
$ ./test.sh

This will bootstrap an environment that includes an IRC daemon and redis running on non standard ports. Then it fires up the bot then runs the tests. So far this works on my systems, please open an issue if you find that it doesn’t work for you.

Do not feel obligated to add tests for services, only if you are expanding the protocol that the bot itself is away of.