Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

34 lines (25 loc) · 1.79 KB

Contributing

We're so glad that you're thinking about contributing to this repo. Make sure you follow the following simple set of rules here while trying to contribute.

Issues

Feel free to submit issues and enhancement requests.

Steps to follow

In general, we follow the "fork-and-pull" Git workflow.

  1. Fork the repo on GitHub
  2. Clone the project to your own machine
  3. Commit changes to your own branch
  4. Push your work back up to your fork
  5. Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

Rules

  • IMPORTANT! Test your code locally! Follow the steps 'Running KoeBot locally' found at README.
  • Don't forget to delete your api keys from your code before uploading it, leave the api keys references as they were before you started working on the code.
  • Every Pull Request must have a title.
  • Every Pull Request must have a description.
  • Every Pull Request must refer to an existing issue. If you want to implement some functionality which doesn't have any issue open discussing it, open a new one and discuss with the maintainers before submiting your pull request.
  • Check previous open Pull Request before making a new one, as yours may be a duplicate.
  • Write the title and description of what you have done in the imperative mode, that is as if you were commanding someone.
  • Don't end the summary line with a period - it's a title and titles don't end with a period.
  • Have fun.