Skip to content

Commit 4d37e7a

Browse files
committed
Create CONTRIBUTING.md
1 parent 1a1300d commit 4d37e7a

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Contributing to 1inch
2+
=======
3+
4+
Thanks for taking the time to contribute! All types of contributions are encouraged and valued. Please make sure to read the sections below before making your contribution. It will make it a lot easier for maintainers and speeds up the merge of your contribution.
5+
6+
## Creating Pull Requests (PRs)
7+
8+
As a contributor, you are expected to fork this repository, work on your own fork and then submit pull requests. The pull requests will be reviewed and eventually merged into the main repo.
9+
10+
## A typical workflow
11+
12+
1) Before contributing any changes it is a good practice to open an issue and provide the reasoning for the changes
13+
1) Make sure your fork is up to date with the main repository
14+
2) Update all dependencies to the latest version
15+
```
16+
yarn
17+
```
18+
3) Branch out from `master` into `fix/some-bug-#123`
19+
(Postfixing #123 will associate your PR with the issue #123)
20+
4) Make your changes, add your files, commit and push to your fork.
21+
Before pushing the branch ensure that:
22+
* JS and Solidity linting tests pass
23+
```
24+
yarn lint
25+
```
26+
* New and/or fixed features are covered with relevant tests and all existing tests pass
27+
```
28+
yarn test
29+
```
30+
5) Go to the GitHub repo in your web browser and issue a new pull request.
31+
6) Maintainers will review your code and possibly ask for changes before your code is pulled into 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.
32+
33+
## All done!
34+
35+
If you have any questions feel free to post them in the issues section.
36+
Thanks for your time and code!

0 commit comments

Comments
 (0)