Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add CONTRIBUTING.md #34

Merged
merged 1 commit into from
Oct 14, 2021
Merged

docs: add CONTRIBUTING.md #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`.