From 17de80eeb4e2942f8c14057a7a8a2149271f5c55 Mon Sep 17 00:00:00 2001 From: Toru Kobayashi Date: Thu, 14 Oct 2021 23:40:46 +0900 Subject: [PATCH] docs: add CONTRIBUTING.md (#34) --- CONTRIBUTING.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c476409 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,25 @@ +# SWR DevTools Contributing Guidelines + +Thank you for your contributions! + +## Local Development + +### Develop `swr-devtools-panel` + +``` +$ yarn install +$ yarn start +``` + +And then, open http://localhost:3000/. + +### Develop SWR DevTools as Web Extension + +#### Chrome + +After the instruction of "Develop `swr-devtools-panel`", open chrome://extensions/ on Chrome and select the `dist/` directory from the `Load unpacked` button. +See more details on https://developer.chrome.com/docs/extensions/mv3/getstarted/. + +#### Firefox + +After the instruction of "Develop `swr-devtools-panel`", run `yarn workspace swr-devtools-extensions start:firefox`.