Skip to content

Commit 33b0932

Browse files
committed
Updated contributing guide
1 parent ea58d11 commit 33b0932

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

CONTRIBUTING.md

+31-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,38 @@
1+
## Pull Requests
2+
3+
Please don't send pull requests for new features, open an issue to discuss.
4+
5+
## Running tests
6+
7+
This repo uses Jest.
8+
9+
```sh
10+
yarn test
11+
# or
12+
yarn test --watch
13+
```
14+
115
## Developing the examples
216

17+
First you have to link the lib.
18+
319
```sh
20+
# from the root
21+
yarn build
422
yarn link
5-
cd example
23+
```
24+
25+
Then in one tab compile on file changes
26+
27+
```
28+
yarn watch
29+
```
30+
31+
And in another tab run the example
32+
33+
```sh
34+
# in a new tab
35+
cd examples/<whatever>
636
yarn link "@reach/router"
737
yarn start
838
```

0 commit comments

Comments
 (0)