Skip to content

Commit 1bff213

Browse files
authored
Docs: Add CONTRIBUTING.md file (#21) (#22)
* docs: add contributing document Signed-off-by: sunrabbit123 <[email protected]> * docs: add pull request document Signed-off-by: sunrabbit123 <[email protected]> * fix: apply comment about vscode extensions Signed-off-by: sunrabbit123 <[email protected]> * add new line Signed-off-by: sunrabbit123 <[email protected]> --------- Signed-off-by: sunrabbit123 <[email protected]>
1 parent 0f168c0 commit 1bff213

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

CONTRIBUTING.md

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Contributing to assembly-ts
2+
3+
We use yarn berry with yarn@4
4+
5+
## Getting Started
6+
7+
1. install yarn
8+
2. install node > 20
9+
3. yarn set version berry
10+
4. yarn install
11+
5. install vscode extension `./vscode/extensions.json`
12+
if you are not a vscode users, you can follow next link `https://yarnpkg.com/getting-started/editor-sdks`
13+
14+
## Testing
15+
16+
run `yarn test`
17+
18+
but, you want targetting test
19+
you can type `yarn test src/{directory name}`
20+
21+
## Pull Reqeust
22+
23+
We do not care about the number, or style of commits in your history, because we squash merge every PR into main.
24+
Feel free to commit in whatever style you feel comfortable with.

0 commit comments

Comments
 (0)