Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 917 Bytes

CONTRIBUTING.md

File metadata and controls

37 lines (22 loc) · 917 Bytes
Raw

Contributing

We <3 corrections and improvements

Prerequisites

Local development

  1. Clone the repo with git clone [email protected]:sovereign-guides/sovbot.git

  2. Fill in the env variables with cd src && mv config.json.example config.json && nano config.json.

  3. Install packages with yarn install

  4. Run pm2 start ecosystem.config.js to start the bot service.

📝 When updating, you can use the bash update.sh script.

📝 View logs with pm2 logs ecosystem.config.js

Linting

Remember to always lint your edits/additions before making a commit to ensure everything's lined up and consistent with the rest of the bot. I use ESLint and have a package.json script for linting JS files.

yarn run lint