aboutsummaryrefslogtreecommitdiff
path: root/node_modules/discord.js/CONTRIBUTING.md
diff options
context:
space:
mode:
authorAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
committerAlee14 <alee14498@gmail.com>2017-03-26 15:18:10 -0400
commit29433e2f7dbd0e4a73d3c78ffe1005b922fb5982 (patch)
treeaa0ad3fe59468cbe452ee597e914839b68c01436 /node_modules/discord.js/CONTRIBUTING.md
parent878fefb4c4e1f12b804ae5c0def433fa873f4c8b (diff)
downloadAleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.gz
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.tar.bz2
AleeBot-29433e2f7dbd0e4a73d3c78ffe1005b922fb5982.zip
Don't mind me i'm adding the discord.js files
Diffstat (limited to 'node_modules/discord.js/CONTRIBUTING.md')
-rw-r--r--node_modules/discord.js/CONTRIBUTING.md14
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)