shrikrishna/optimus repository overview

⁠Optimus

Optimus is a P.R.I.M.E. (Pseudo Robotic Irc Messaging Entity). He is being developed to monitor the logs and provide assistance in PES OpenSource Community⁠'s IRC channel #pes-os⁠ (in freenode)

The attempt here is to write an IRC bot, but at the same time try to give it a personality, that of the character Optimus Prime⁠ in Transformers⁠ series

###Installation

1. Clone the repository and change to the project directory
2. Run npm install. Of course, you need to have Nodejs⁠ first.
3. Run npm start. The bot will have connected to the set channels and started logging. The configurations can be tweaked in config.js

###Running tests Execute npm test in the project directory.

###Contributing
The philosophy, tech stack, coding guidelines are available in wiki⁠

1. Adding a feature

• Create a fork of this project⁠
• Setup to sync from main repo⁠
• Make a development branch⁠
• Add your feature
• Test it
• Create a pull request⁠ against the project's dev⁠ branch. If the feature is in response to an issue, reference the original issue. Find instructions to do so here⁠

1. Raising an issue

• Determine what is breaking
• Raise an issue here⁠
• Describe in what situations the system breaks

1. Fixing bugs

• Go through outstanding issues⁠
• Choose an issue you would like to close
• Comment on the issue that you intend to work on it (to avoid conflicts)
• Follow steps in (1)

⁠Authors

• Shrikrishna Holla⁠
• Would you like your name here? Go ahead, fork it!⁠