Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 2.6 KB

contributing.md

File metadata and controls

47 lines (26 loc) · 2.6 KB

Contribution guide

The "lmao-bot" repository provides code that runs lmao-bot on Discord, duh.

If you're interested in contributing to this project, great! This file should help you get started.

Types of contribution

There are many ways you can help improve this repository! For example:

  • Create a brand-new feature: maybe you want some sort of "ban everyone" command?
  • Fix a bug: we have a list of issues, or maybe you found your own.

Setup

To contribute and test, you need a text editor, git, a GitHub account, python 3.6.5, and you'll need to install the requirements listed in https://github.com/DrEngi/lmao-bot/blob/master/requirements.txt. If you want to work with music or voice, please ensure that ffmpeg is installed on your machine.

As far as text/code editors go, there are more editors than you can shake a stick at, so it's down to personal preference. Atom is a great, open source editor we can definitely recommend (and one of us uses it).

For more information on setting up Git on your machine, read this article.

With the above dependencies satisfied, create your new account on Github.

You'll need to install Python 3.6.5 or later for your operating system.

Fork and clone

Next up, you need to fork and clone the repo to be able to contribute to it. You can learn about forking on Github. Once you have your own fork, clone it to your local machine.

Finally, change into the new directory created by the clone and run the following command to install dependencies

pip install -r requirements.txt

Please ensure that all dependencies in this folder were installed correctly. We recommend you use virtualenv or Anaconda (if on windows) to manage python envrionments. This will ensure that you have all the required development modules installed to build your contributions. You are now ready to contribute.

To test the bot, you'll need to create a token.txt and place it within a tokens folder. To get a token, create an account on the discord developer portal and create a bot user.

Once you're satisfied, submit your pull request. Please be sure you create a pull request to the DEVELOP branch, not Master. Direct PRs to Master will be denied.

Thank you!

Thank you for your contribution ~ o/\o