discordjs/discord.js
2
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2024-08-21 14:04:46 +12:00
Code Issues Projects Releases Packages Wiki Activity
discord.js/.github/CONTRIBUTING.md
Christopher Bradshaw efd7849ed0
docs: use npm ci instead of npm install (#4928) 
Use `npm ci` instead of `npm install` after cloning the repository.
2020-11-01 12:30:25 +01:00

1.1 KiB
Raw Permalink Blame History

Contributing

The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the Discord server instead of opening an issue – you will get redirected there anyway.

If you wish to contribute to the discord.js codebase or documentation, feel free to fork the repository and submit a pull request. We use ESLint to enforce a consistent coding style, so having that set up in your editor of choice is a great boon to your development process.

Setup

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

  1. Fork & clone the repository, and make sure you're on the master branch
  2. Run npm ci
  3. If you're working on voice, also run npm install @discordjs/opus or npm install opusscript
  4. Code your heart out!
  5. Run npm test to run ESLint and ensure any JSDoc changes are valid
  6. Submit a pull request (Make sure you follow the conventional commit format)