From 580550e5e260a5f756c4cad412c0aef7078908a8 Mon Sep 17 00:00:00 2001 From: Schuyler Cebulskie Date: Wed, 7 Sep 2016 02:30:57 -0400 Subject: [PATCH] Add basic contributor's guide --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..1a16bf87 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# 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 +2. Run `npm install`, or `npm install --no-optional` if you're not working on voice +3. Code your heart out! +4. Run `npm test` to run ESLint +5. Run `npm run docs` to build any documentation changes +6. [Submit a pull request](https://github.com/hydrabolt/discord.js/compare)