mirror of
https://github.com/discordjs/discord.js.git
synced 2026-03-09 16:13:31 +01:00
15 lines
720 B
Markdown
15 lines
720 B
Markdown
# Contributing
|
|
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 coding 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 **indev** branch
|
|
2. Run `npm install`
|
|
3. If you're working on voice, also run `npm install node-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](https://github.com/hydrabolt/discord.js/compare)
|