from Kokonico
The most crucial thing for collaborative projects.
Recently, I decided that I wanted to contribute to some GitHub projects, and I eventually stumbled onto a Discord bot that seemed fun. The main reason I wanted to contribute to it was because an issue on the repository wanted to change the project's storage system from MongoDB to SQLite. Anyway, I talked to the person who made the bot and got assigned the task. The next day, I began setting up the discord bot, only to encounter an error complaining about the discord bot token.
I knew this would happen, so I decided to create my Discord bot and get it ready for testing. I began searching for the setup guide only to realize one thing.
There was no setup guide.
To find the environment variables to run the bot, I had to scour through the source code, I eventually found the discord bot token variable name, so I booted it up again.
Now it's complaining about discord intents.
Nothing was telling me what to do to properly set it up.
As I said, there was no setup guide.
At this point, I gave up. I enabled every possible setting & permission in my discord bot and reran the code.
More errors, but it ran.
By now I've spent more time getting the bot set up than actually working on anything. I am still working on this project, and once I iron out the last errors, I can start working on this project, all because there was no setup guide.
TLDR: Please add setup guides for your projects.