karthikvarma8036 / os-discord_bot

OC Discord Bot

A self-hosted bot based on discord.py with many niche features.

Dependencies

• Python v3.7 or higher
• Pip
• Discord.py
• Flask

Claim an issue

Comment on the issue. Issues will be given out on first come first serve basis. In case of no activity on the issue even after 2 days, the issue will be reassigned. If you have difficulty approaching the issue, feel free to ask on our discord channel.

Also, you will be provided a secret Discord Bot token when you claim the issue.

Setup on local machine

• Fork the repository to your github account.
• Clone it to your local setup by using git clone <repo link>
• Open the project in any code editor

Windows

• Open command prompt and navigate to the directory of the project
• To run the bot use the command python main.py

Linux/macOS

• Follow the same steps as in the above Windows section but use python3 in place of python.

Guidelines

Please help us follow the best practice to make it easy for the reviewer as well as the contributor. We want to focus on the code quality more than on managing pull request ethics.

• Do not misuse the Discord bot; if any case of spamming with the bot or sharing the token is found, then strict action will be taken.
• Single commit per pull request and name the commit as something meaningful, example: Adding <-your-name-> in students/mentors section
• Reference the issue numbers in the commit message if it resolves an open issue. Follow the PR template strictly.
• You will be able to see and review the responses of the bot in the Opencode discord server.
• Make changes to the pull request if the reviewing maintainer recommends them.
• Pull Requests older than 2 days with no response from the contributor shall be marked closed.
• Do not make PR which is not related to any issues. You can create an issue and solve it once we approve them.
• Avoid duplicate PRs, if need be comment on the older PR with the PR number of the follow-up (new PR) and close the obsolete PR yourself.
• Be polite: Be polite to other community members.

Communicate

Whether you are working on an issue or facing a doubt please feel free to ask us on our discord channel. We will be happy to help you out.

Resources

• Python https://docs.python.org/3/
• Discord.py https://discordpy.readthedocs.io/en/stable/
• Flask https://flask.palletsprojects.com/en/2.2.x/