Skip to content

Commit d9a7ec8

Browse files
committed
wip: added CONTRIBUTING.md
1 parent ac03fb4 commit d9a7ec8

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CONTRIBUTING.md

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to func-js
2+
3+
We highly appreciate any contribution to func-js ❤️
4+
5+
## A typical workflow
6+
7+
1) Make sure your fork is up to date with the main repository:
8+
9+
```
10+
cd ton-compiler
11+
git remote add upstream https://github.com/ton-community/ton-compiler.git
12+
git fetch upstream
13+
git pull --rebase upstream master
14+
```
15+
16+
NOTE: The directory `ton-compiler` represents your fork's local copy.
17+
18+
2) Branch out from `master` into `fix/some-bug-#123` or `feat/some-feat` for features:
19+
Postfixing #123 will associate your PR with the issue #123 and make everyone's life easier
20+
```
21+
git checkout -b fix/some-bug-#123
22+
```
23+
24+
3) Make your changes, add your files, commit, and push to your fork.
25+
26+
```
27+
git add SomeFile.js
28+
git commit "Fix some bug #123"
29+
git push origin fix/some-bug-#123
30+
```
31+
32+
4) Make sure tests pass:
33+
34+
```bash
35+
yarn test
36+
```
37+
38+
5) Go to [github.com/ton-community/ton-compiler](https://github.com/ton-community/ton-compiler) in your web browser and issue a new pull request.
39+
40+
*IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions.
41+
42+
6) Maintainers will review your code and possibly ask for changes before your code is pulled in to the main repository. We'll check that all tests pass, review the coding style, and check for general code correctness. If everything is OK, we'll merge your pull request and your code will be part of ton-compiler.
43+
44+
## All set!
45+
46+
If you have any questions, feel free to join ton-community dev chat at Telegram: https://t.me/ton_dev_community.
47+
48+
Thanks for your time and code!
49+

0 commit comments

Comments
 (0)