Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.84 KB

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 1.84 KB
Raw

Setting up neo

Standard

  1. First install minimum Python 3.10
  2. Clone the project
  3. Run: python -m pip install --editable .[dev] for the development environment. Use . instead of .[dev] for production.
  4. Setup your bot token in settings/.env with key TOKEN=
  5. Run python main.py

Docker

  1. This guide is under the presumption you have Docker installed.
  2. Setup .env file inside settings/ folder with key value TOKEN=XXX
  3. It is heavily suggested to use compose v2 which can be installed from official Docker documentation
  4. Run the following command: docker build -t "neo:latest" . to build the image neo:latest
  5. Using v2 compose to run the bot: docker compose up in the same location as docker-compose.yml

Contributing

If you're having trouble with setting up the project, you can find us on the official Discord

You might be wondering why I'm using 3.10 as a requirement when I'm not using anything reliant on 3.10. I plan to implement features from 3.10 specifically in the future, so I'm proofing it for now.

Submitting a pull request

If you've decided to fix a bug, even something as small as a single-letter typo, we welcome anything that improves code/documentation for all future users and developers. After all it is a template bot!

If you decide to work on a feature in the issues section it's best to let us (and everyone else) know what you're working on to avoid any duplication of effort. You can do this by replying to the original Issue for the request. We can assign and lock it until it's ready if necessary.

When contributing a new example or making a change to a library please keep your code style consistent with ours and latest PEP guidelines.