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

Move CONTRIBUTING.md to the new .github folder

Browse Source 
There's no point in keeping it in the root directory given that it can also be in .github.
This commit is contained in:
meew0
2017-04-12 01:19:16 +02:00
committed by GitHub
parent 9b989c4fd7
commit 5dea21ba80
1 changed files with 0 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
.github/CONTRIBUTING.md vendored Normal file
View File

@@ -0,0 +1,17 @@
# Contributing
**The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the [Discord server](https://discord.gg/bRCvFy9) instead of opening an issue – you will get redirected there anyway.**
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 development 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 **master** 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)