Extremely Popular
Contributing
- Read the style guide.
- Ask for help on the official Discord server
- If you are going to work on an issue, mention so in the issue comments before you start working on the issue.
- If you are going to work on a new feature, create an issue and discuss with other contributors before you start working on the feature.
- Abide by and heed to Discord Developer Terms of Service
Submitting a Pull Request
- Give the PR a descriptive title.
Examples of good PR title:
- fix(controllers/interactions): cache member from INTERACTION_CREATE payload
- docs: improve wording
- feat(handlers/guild): add editGuild() function Examples of bad PR title:
Examples of bad PR title:
fix #7123
update docs
fix bugs
Ensure there is a related issue and it is referenced in the pull request text.
Ensure there are tests that cover the changes.
Ensure all of the checks (lint and test) are passing.
Style Guide
- Use underscores as a separator in filenames.
- Comply with these guidelines for inclusive code.
- An exported function must not have more than 4 individual parameters, the rest arguments should be encorporated inside an object as a single parameter.
- Export all interfaces, types, and enums that are used for or inside an exported entity.
- Every exported entity must be accompanied by a Typedoc (JSDoc without explicit types) comment block. Ideally, we prefer single line comment block.
- Top-level functions should not use arrow syntax.
- Minimize dependencies; do not make circular imports.
- Utilize functional API wherever possible and avoid usage of ES6 classes.
- Follow Convention Over Configuration wherever possible.
- Please follow the guidelines for inclusive code.