diff options
Diffstat (limited to 'node_modules/discord.js/CONTRIBUTING.md')
| -rw-r--r-- | node_modules/discord.js/CONTRIBUTING.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/node_modules/discord.js/CONTRIBUTING.md b/node_modules/discord.js/CONTRIBUTING.md new file mode 100644 index 0000000..8b56f1c --- /dev/null +++ b/node_modules/discord.js/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# 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) |