Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-11 17:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add basic contributor's guide

Browse Source
This commit is contained in:
Schuyler Cebulskie
2016-09-07 02:30:57 -04:00
parent bc09da9a35
commit 580550e5e2
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md Normal file
View File

@@ -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)