Make sure to have the following tools installed:
nvm
(optional)node v14.15.5
yarn
docker
- Heroku CLI
You will never have to run the code locally, other than to run tests.
To manually try out changes, you'll simply deploy to Heroku and actually use the bot in slack!
# Install dependencies
yarn install
# Login to Heroku CLI - only have to do this once
yarn docker:login
# Deploy the app after making changes
yarn docker:deploy
You don't have to commit anything before doing a deploy. Just make the change and deploy
Just be aware if multiple people are working on it at the same time, you'll be fighting for who's change is the latest change
This repo uses Conventional Commits, and they're enforced by a PR check. For examples, just look at the repo history.
Here are the types of commits we use (and examples):
feat: ...
- Used when the commit introduces a new featurefix: ...
- Fixing a bug in user facing codechore: ...
- Refactor, fixing lint or test errors, formatting, etcci: ...
- When you update the CIdocs: ...
- When you update theREADME.md
or other documentationBREAKING CHANGE: ...
- When there's a feature that leads to a completely different flow for users
- Slack App Config: https://api.slack.com/apps/A01TFKZKPT7/general
- Heroku App: https://dashboard.heroku.com/apps/hacker-rank-queue
- Spreadsheet Databases: https://drive.google.com/drive/folders/1bCO8LllRNpysu65WOjBsUAZUnrDqXDX0?usp=sharing