Contributing
If you wish to contribute to the nestcord 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 reduces friction contributing to this project.
Setup
You will need Node.js version 16+, and npm.
To get ready to work on the codebase, please do the following:
- Fork & clone the repository. Make sure you're up-to-date with the master branch!
- Install the dependencies using
npm ci
- Code your heart out!
- Run
npm lint
to run ESLint and ensure changes respect our styleguide - Submit a pull request
A high level overview of tools used:
- TypeScript as the development language
- Eslint for code-style
- Prettier for code formatting