discord.js/.github/CONTRIBUTING.md

Contributing

The issue tracker is only for bug reports and enhancement suggestions. If you have a question, please ask it in the Discord server 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 main branch
2. Run yarn --immutable (install)
3. Run yarn build to build local packages
4. Code your heart out!
5. Run yarn test to run ESLint and ensure any JSDoc changes are valid
6. Submit a pull request (Make sure you follow the conventional commit format)

Adding new packages

If you'd like to create another package under the @discordjs organization run the following command:

yarn create-package <package-name> [package-description]

This will create new package directory under packages/ with the required configuration files. You can begin to make changes within the src/ directory.