Skip to content
This repository has been archived by the owner on Jan 1, 2023. It is now read-only.

Latest commit

 

History

History
28 lines (17 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

28 lines (17 loc) · 1.14 KB

Contributing

If you are interested into contributing to this project, feel free to fork this repository and to submit a pull request with the changes you made. In future, a special code style will be enforced in all JavaScript files.

The main recommendation is to use ESLint for linting to make the code more consistent.

Checklist and Contributing guidelines

  1. Fork & git clone the repository
  2. Make sure you are on the master branch.
  3. Before doing any development, run npm install.
  4. Optionally, you can create a development branch. The name should contain the type of change you are doing (e.g. update-wiki-command). You don't have to do this.
  5. Code what you want. (Read What you need to consider when you code)
  6. Try out your changes and new features with npm run dev.
  7. Submit a pull request.

When you submit a pull request, please follow the template.

What you need to consider when you code:

In the root directory, you need to create a file called .env, otherwise the bot won't start.

A template for this file can be found in .example.env.