License | Github | Discord | Dependencies |
---|---|---|---|
A megabot for everything CSCH needs, composed of smaller mostly standalone packages. This project uses Discord.js.
git clone https://github.com/cscareerhub/megabot.git
nvm install 14
nvm use 14
yarn install
.env.template
to set up env variables. Set ENV
to testing
if you're running unit tests.BOT_TOKEN=yourbottoken
...
yarn start
Optional: Join us on the CSCH Discord server where we will give you access to the bot dev channel where we discuss and test bots.
Assign yourself to the issue or request to be assigned.
Fork the repo.
Create a branch with the following naming scheme.
feature/<yourfeature>
bug/<yourbugfix>
docs/<yourdocchange>
test/<yourtestingchange>
misc/<yourmiscchange>
Format your code to the project's specifications using Prettier. You can either use an editor plugin to do it automatically or run yarn format
.
Once you've made change, create a pull request to the CSCH megabot repo's development
branch with the type of change, which should correspond to the first part of your branch name, in the PR title.
branch name: docs/change
PR title: [docs] Changed this and that
All PRs will require at least one review from CSCH staff. If it's been over a week, feel free to ping us once in the Discord.