Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 1.15 KB

CONTRIBUTING.md

File metadata and controls

30 lines (19 loc) · 1.15 KB

Contributing

Thank you for contributing to the CODE_EXP admin bot.

Development environment setup

Clone the bot, then run pip install -r requirements.txt. You will need several environment variables defined. Here is the .env file template you can use

DISCORD_TOKEN=<your token here>
GUILD_ID=<guild id here>
MENTOR_ROLE_ID=<mentor role id here>
MEMBER_ROLE_ID<member role id>
SENTRY_DSN=<sentry dsn>

We use Sentry for error handling. However, the bot will start without a sentry DSN.

Making a pull request.

Please @ the maintainers of this repository if you would like your pull request to be reviewed. Please try your best to explain any changes you have made. We may request for additional changes to be made. Please do your best to work on them.

If you have made many commits, please rebase and squash all your commits into 1 when the maintainer asks you to do so.

Licensing and copyright

We are using the GPLv3 license. You will need to assign your copyright to us when making changes. This is for the sake of convenience. If you have any objections to such an arragement, please create an issue and we will try to accomodate your requests.