stockdroid / botgeneralframework

The BotGeneralFramework repo

Bot General Framework

This is a general purpose bot framework that aims at generalizing and simplyfying bot frameworks.

Go to the documentation to know more on how to set up the framework for yourself.

Cross compatibility

One of bot general framework's objective is to generalize bot components such that one codebase can be written for many platforms.

No functionality may be implemented if it cannot comply with cross-compatibility.

Simplicity

One fundamental principle around the project is simplicity. The codebase for a bot built with this library should be easy to read and understand, even without any knowledge of this very tool.

On the other hand, the implementation code in C# must be well-documented and easy to read. Inheritance is allowed where strictly needed.

prefer composition over inheritance

Contribution

Contributing to the project is welcome when it follows all the above principles.

The creation of a code of conduct is on the agenda. For now feel free to pull request any changes and be as thorough as possible in commit messages.

Please, commit changes gradually to facilitate code reviews.