Skip to content

Commit

Permalink
docs: add CONTRIBUTING.md (#34)
Browse files Browse the repository at this point in the history
  • Loading branch information
koba04 authored Oct 14, 2021
1 parent 546f463 commit 17de80e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
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`.

1 comment on commit 17de80e

@vercel
Copy link

@vercel vercel bot commented on 17de80e Oct 14, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.