Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 2.73 KB
Raw

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)

Testing changes locally

If you want to test changes you've made locally, you can do so by using yarn link. This will create a symlink to your local copy of the discord.js libraries.

  1. Create a new directory mkdir discordjs-test and move into it cd discordjs-test
  2. Initialize a new yarn 3 project yarn init -2
  3. Disable pnp yarn config set nodeLinker node-modules
  4. Now link the local discord.js project you cloned earlier yarn link -A {PATH_TO_DISCORDJS_REPO}
  5. Install packages you'd like to test locally yarn add discord.js@latest, yarn add @discordjs/rest@latest, etc. Note: Make sure you use latest tag or else yarn will try to install the remote package from npm
  6. Import the package in your source code and test them out!

Working with TypeScript packages

When testing local changes, you may notice you need to manually recompile TypeScript projects on every change in order to get the latest code changes to test locally.

To avoid this you can use the --watch parameter in the package build script to automatically recompile the project when changes are detected.

For example, to automatically recompile the @discordjs/rest project when changes are detected, run yarn turbo run build --filter=@discordjs/rest -- --watch in the root folder of where you cloned the discord.js repo.

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.