Thanks for wanting to contribute! To make contributions as efficient and positive for everyone, please read these sections.
You should have node and npm installed on your system.
Also run:
npm i -g typescript
for faster typescript development.
If you have discord, please join the discord sever to talk to devs.
To speed up development, we recommend using VSCode as your IDE and git for your SCM.
| Script | Description |
|---|---|
start |
Start and run the bot. |
dev |
Use this command when developing. When updates are made (file saves), typescript will automatically recompile the program. |
prod |
Compile the bot. |
Check out README.md for more information.
When creating a PR, please follow these guidelines:
- The title should be a short description of what you added.
- The PR content should describe in depth of what was accomplished.
Commits should be short and descriptive. They should be past tense.
| Good Practice | Bad Practice |
|---|---|
| Added more items to the shop | Update shop.ts |
| Fixed a bug with buying items | Fix bug |
| Tweaked color theme | Change colors |
When naming your branches, please include information about who is using it. This is as simple as adding your name to the branch:
coder100-dev
shop-item-cursorweb
When applicable, please also include what you aim to accomplish.