Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
76 lines (49 loc) · 3.25 KB

CONTRIBUTING.md

File metadata and controls

76 lines (49 loc) · 3.25 KB

Guidelines for Contributing and Raising Issues

Thanks for considering contributing to this Project!🥳

Raising Issues: ✋

  • If you want to ask anything about this project, please feel free to open an issue here.
  • Any bugs that are found in the documentation or in any part of bot, can be reported using the Bug Report Template.
  • Do not upload any compiled binaries with your PR. ❌
  • Please be polite and helpful to everyone. 🙂

Contributing: 📝

If you would like to provide a fix for a problem you can do so by opening a Pull Request here. Below are some points to consider:


  • Please open a Draft PR if you want to change a lot of things.
  • Provide a list of all the fixes that you have done in the PR description.
  • If your PR fixes an Issue, consider mentioning it with fixes #IssueNumber.
  • Provide all the details in the PR template as applicable.
  • If you want to add a new feature please open an issue first to discuss it or your changes may not get merged.

Code Formatting

Please make sure that your code follows the PEP8 guidelines.

Before committing your changes to the repository, run pre-commit run --all-files or pipenv run lint this will highlight and fix some errors.

For PyCharm users you can use the key combination Ctrl + Alt + L to format your code.

For VsCode users, create a .vscode folder in your project root and create a settings.json file inside it. Place the following in the settings.json file:

{
  "editor.formatOnSave": true,
  "python.formatting.provider": "autopep8"
}

You can also use autopep8 directly from the command line using autopep8 -i filename. After fixing all the errors, push your changes and then open a PR.

Setting up the Environment: 💻

Please ensure that you have Python version 3.9.

This guides you through the setting up the Environment for working with the project.


  1. Fork the repository.
  2. Clone it to your local machine to work with the Project.
  3. Install pipenv if you haven't using pip3 install pipenv.
  4. Create a Virtual Environment with pipenv using pipenv shell.
  5. Install the project dependencies using pipenv install --dev.
  6. Open the Project in the Editor of your choice.
  7. Congratulations, you are now ready to Contribute. 🎉

NOTE: For linux users, you will need to install psycopg2-binary instead of psycopg2 in the step 5.

Setting Up the Bot 🤖️

Follow the steps below to set up the Bot:

  1. Follow this guide here on how to create a server and the Bot.
  2. After getting all the required values, create a .env file in the project root using the .env.example as a template and place the values in it.
  3. Now, if you run the __main__.py file you should see the BOT online in your test server.

NOTE: It is optional for you to set up the PostgreSQL database.

If you need any other help regarding CONTRIBUTING to the Bot, please join our discord server here.