Home - ackwell/ninjabot GitHub Wiki

This is the wiki for the ninjabot project. Here you will find various documentation for the bot, both for end users and developers.

Note: Yeah, this is still early WIP. All in good time!

Developers

The Main Codebase

Before submitting any code to the primary codebase, please have a read-through of the style guide. All code is expected to follow this guide (though the guide itself isn't that restrictive - don't worry too much). Remember to make sure that tests pass before submitting a PR, unless it is an intentionally failing test to point out an error. Also, write tests for new/changed functionality, to make things easier for everyone :)

Plugins

With plugins, you are urged to follow the style guide as mentioned above, for the sake of consistency. However it's really up to you.

If you are writing a core functionality for the bot, or something that you deem would be an excellent addition to the core distribution, then of course you will want to check over it with the style guide in mind before making a pull request.

TODO: Brief intro for plugin dev

TODO: Make an API ref.

stuff.