Here we'll explain how to get started contributing to the project, and what to expect.
- Visual Studio Code - Preferred editor (optional)
- yarn - Preferred package manager (if you prefer npm, be sure to delete the yarn.lock file)
- nodemon - For development
- tsc - TypeScript compiler
- git - CLI for managing Git repositories
We use a list of preferred syntax conventions for code reability:
- Comments
- Double quotes
- Semi-colons
- Tab indentations
Consistency in syntax also improves code reability.
You can being by creating a fork here. This'll setup a copy of the project to your own account so you can start adding your own changes. One you've applied by your changes, you can head over to the pull requests page and create a new pull request. You'll be asked to fill in a template to give us a bit more information about your pull request so we can determine whether it is helpful. This project is actively maintained, so we'll respond as soon as we can.
If your pull request gets accepted, great, good job! If it doesn't, review the comments provided and either alter the pull request or remove it.
If you find any bugs/issues, security vulnerabilities or have suggestions, you can head over to the issues page, create a new issue and select the following options:
- Bug report - for bug reports/issues
- Security vulnerability - report a security vulnerability
- Suggestion - suggest an idea for this project
The Report a security vulnerability option will give you more information about reporting security vulnerabilities - please choose this option before choosing the Security vulnerability option.
Discussions are open for anyone here.
Please read the README file file for extra, detailed information. Also ensure you have read the contributors code of conduct.
Any contributions you make are under the GPL-3.0 license. For extra help, feel free to contact r1zyn#4129 on Discord.