Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (19 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

26 lines (19 loc) · 1.2 KB

Contributing

The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask me directly on Discord (Lioness100#4566) instead of opening an issue

If you wish to contribute to the project's codebase or documentation, feel free to fork the repository and submit a pull request. For larger changes, please open an issue first so we can discuss.

Requirements

  • We use ESLint and Prettier to enforce a consistent coding style. Any PR that does not follow the linting rules will not be merged until the issue is resolved.

Setup

To get ready to work on the codebase, please do the following:

  1. Fork & clone the repository.
  2. Install NodeJS and yarn.
  3. Run yarn in your terminal to download dependencies.
  4. If needed, copy and fill .env.example, then rename your copy to .env. You can follow this guide to retrieve a bot token.
  5. Code your heart out!
  6. Submit a pull request