Skip to content

Commit df017c8

Browse files
docs: contributing guide (#278)
1 parent b3f466d commit df017c8

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Contributing guide
2+
3+
## Prerequisites
4+
5+
* modern version of node
6+
* yarn classic, https://classic.yarnpkg.com/en/docs/install
7+
8+
## Setup
9+
10+
* Run `yarn` in repo root
11+
* Run `yarn` in `examples` folder
12+
13+
## Run locally
14+
15+
* Run `yarn dev` to be able to to run examples
16+
17+
## PR checklist
18+
19+
### Run unit tests
20+
21+
* Run `yarn test`
22+
23+
### Run linter
24+
25+
* Run `yarn lint`
26+
27+
### Test examples locally
28+
29+
Using real device is recommended, otherwise you can use https://github.com/meta-quest/immersive-web-emulator/.
30+
See [Run locally](#run-locally)

0 commit comments

Comments
 (0)