diff --git a/CHANGELOG.md b/CHANGELOG.md index d3b44983..5e1ef3ee 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## v1.2.0 + +### New + +- New action `AddOutgoingRaidBannerAction` and `AddIncomingRaidBannerAction` + - Removed `AddRedirectBannerAction` +- New action `RemoveChatItemAction` +- New action `AddProductBannerAction` + ## v1.1.0 ### New diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c1d64a4..dc42ee48 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,55 +1,83 @@ # Contribution Guide +- Use Masterchat with `DEBUG=masterchat` and [report](https://github.com/holodata/masterchat/issues/new) logs that are prefixed with `[action required]` +- Squash [TODOs](https://github.com/holodata/masterchat/search?l=TypeScript&q=TODO) + +[Join our Discord](https://holodata.org/discord) to participate in discussions. + ## Build ```bash git clone https://github.com/holodata/masterchat cd masterchat git switch dev -yarn install -yarn build +npm install +npm run build ``` ## Development Flow +In `masterchat` dir: + ```bash -yarn dev +npm run build +npm link # link local masterchat package +npm run dev # watch and transpile files ``` +Clone and build [Masterchat CLI](https://github.com/holodata/masterchat-cli): + ```bash -yarn build -yarn link +git clone https://github.com/holodata/masterchat-cli ../masterchat-cli +cd masterchat-cli +npm install +npm run build +npm link # make local `masterchat` and `mc` command available on the shell +``` -cd .. +In `masterchat-cli` dir, link local `masterchat` module and rebuild the cli: -git clone https://github.com/holodata/masterchat-cli -cd masterchat-cli -yarn install -yarn build -yarn link -yarn link masterchat +```bash +npm link masterchat # now `masterchat-cli` uses local `masterchat` module +npm run build DEBUG=masterchat mc live DEBUG=masterchat mc events ``` ## Testing +### Setup + +Export necessary env vars: + +```bash +export MC_TEST_VIDEO_ID=