Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.86 KB

README.md

File metadata and controls

75 lines (50 loc) · 2.86 KB
Raw

CSCH Megabot

License Github Discord Dependencies
License GitHub Workflow Status Discord Dependency Status

A megabot for everything CSCH needs, composed of smaller mostly standalone packages. This project uses Discord.js.

Getting Started

  1. Install prerequisites.
  1. Clone repo.
git clone https://github.com/cscareerhub/megabot.git
  1. Use nvm to switch to Node version 14.
nvm install 14
nvm use 14
  1. Use yarn to install dependencies.
yarn install
  1. Use .env.template to set up env variables. Set ENV to testing if you're running unit tests.
BOT_TOKEN=yourbottoken
...
  1. Run bot.
yarn start

Contributing

  1. 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.

  2. Assign yourself to the issue or request to be assigned.

  3. Fork the repo.

  4. Create a branch with the following naming scheme.

feature/<yourfeature>
bug/<yourbugfix>
docs/<yourdocchange>
test/<yourtestingchange>
misc/<yourmiscchange>

  1. 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.

  2. 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.