Skip to content

Latest commit

 

History

History
38 lines (27 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 2.56 KB

Contributing to FB-BotMill

First off, thanks for taking the time to contribute!

The following is a set of guidelines for contributing to FB-Botmill.

General Issues, Concerns or Inquiries

Our source is open to anyone who's interested in making Bot's using the beautiful Java Programming Language and when we say it's open source, it is literally open. You can just download the actual code and use it as per our licensing terms. All we want in addition to our terms is that you give us your feedback. We passionately created this framework and we want to improve it the best way we can - but we can only do that if you help us. If you found any bugs, issues, ideas or even inquiries, raise a ticket here.

Things to note

  • Make sure that you write descriptive issues. If possible, provide stack trace or screenshots. The more information the better.
  • Tag it accordingly.

Code Contributor

Interested in contributing to our project? We will always be open to your pull requests! Be sure to check our code of conduct first before making any changes. Even it's all open source, we need to make sure that our code is well documented and complies with the standards.

If you want to contribute, drop us an email at [email protected] OR [email protected] or you can talk to us directly thru out Gitter Channel Gitter

Basic Steps if you want to contribute code.

  • Forked the master branch to your user repo.
  • Introduce/code your task.
  • Commit your changes with "Resolved #"
  • Submit a pull requests. Make sure that you only have 1 single commit for every pull request.

Pull request and commit messages

  • All commits should have a "Resolved #" on the message.
  • All pull request should only have one commit. Multiple commits won't be accepted.
  • Make sure to put a good message on your commit. This may or may be used as part of the release notes.

Important things to note

  • All commits will trigger a CI build using your branch. It should pass that before we begin reviewing your code.
  • All commits should have proper documentation.

Bot Examples

We would really appreciate it if you can share the bots that you made using our framework, just like the many people who ask us to show case theirs.