wrightedu / CSE-Discord-Bot

Discord bot for the WSU CSE Discord server
GNU General Public License v3.0
2 stars 4 forks source link

Add example env file for contributors #329

Closed deviserops closed 4 months ago

deviserops commented 4 months ago

Details

I see that there are environment variable uses in the project, but I don't see any example file that will show what and how many variables are being used in the project.

A blank env.example file with only variable names will be good for other developers who are contributing to the project.

Ref: Same as Laravel's `.env.example` file

Example

Since variable DISCORD_TOKEN is used in bot.py

DISCORD_TOKEN=<empty token>
BPennie03 commented 4 months ago

We don't have an example file, but If you refer to CONTRIBUTING.md in the root of the project directory, you will see we already have a basic .env file setup with the discord token, which is the only environment variable we use in this project.