Skip to content

Current Issues with the repository/project. #7

@xSerpentineX

Description

@xSerpentineX

1. Lackluster README.md and/or repository.

A good README.md file should contain proper, fully fleshed out instructions on how to install and use the application, a guide on the applications features, a brief history of the project (optional). Furthermore, it would be wise to create a releases page for less technologically savvy people to use the bot (the README.md should contain a link to this page as well).

2. Use a virtual environment.

Using a virtual environment is a good way to save your users the pain of installing dependencies, such as discord.py. Setting up a virtual environment is as easy as the following (assuming your on windows with Python 3):

  1. In the command prompt, navigate to the working directory of your project/repository/whatever you want to call it.

  2. Type the following command: python -m venv <name>

  3. Run the activate.bat file from the command prompt with the command: <name>\Scripts\activate.bat

  4. Install your dependencies within the virtual environment with PIP. To leave the environment, simply enter deactivate.

  5. Create a .bat file that runs your python program through the virtual environment. For example:

@echo off
Call <name>\Scripts\activate.bat
bot.py
exit 0

3. Not a lot of features.

The bot is rather lackluster at the moment, with only one command. Perhaps try spicing things up a bit?

4. No input sanitization at all.

The bot hardly contains any try and except blocks for validating the users input to prevent unnecessary crashes.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions