Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (21 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.22 KB

Contributing

Setting up the bot

  1. Fork the repository and clone it to your workstation.
  2. Create a .env file and copy the contents of .env.example into it.
  3. Configure env variables
    1. Create a new Discord bot in the developer portal and paste the token as DISCORD_HASH
    2. (optional) Go to your Github Settings and create a personal access token with the scope "gist", and paste the token as GITHUB_TOKEN
    3. (optional) Request access token for Amplitude metrics from vcarl#7694 and paste the token as AMPLITUDE_KEY
  4. Configure your Discord bot permissions
    1. Toggle off the "Public Bot" switch and save.
    2. Grant "Server members intent" permission
    3. Grant "Message content intent" permission
  5. Go to the OAuth2 Tab and choose the "bot" scope.
  6. npm install
  7. npm run start

Environment variables

Adding a new environment variable needs to be done in several places to work corectly and be predictable for new developers

  • Your own .env (and restart your dev server)
  • Add a suitable example to .env.example
  • The action in .github/workflows/node.js.yml
  • The Kubernetes config under `cluster/deployment.yml