|
@@ -37,12 +37,26 @@ git commit "Fix some bug #123"
|
|
git push origin fix/some-bug-#123
|
|
git push origin fix/some-bug-#123
|
|
```
|
|
```
|
|
|
|
|
|
-4) Go to [github.com/OpenZeppelin/openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) in your web browser and issue a new pull request.
|
|
|
|
|
|
+4) Run tests, linter etc. It can be done by running local continuous integration and make sure it pass
|
|
|
|
+
|
|
|
|
+```bash
|
|
|
|
+npm test
|
|
|
|
+npm linter
|
|
|
|
+```
|
|
|
|
+
|
|
|
|
+or you can simply run CircleCI locally
|
|
|
|
+```bash
|
|
|
|
+circleci local execute --job build
|
|
|
|
+circleci local execute --job test
|
|
|
|
+```
|
|
|
|
+*Note*: requires installing CircleCI and docker locally on your machine.
|
|
|
|
+
|
|
|
|
+5) Go to [github.com/OpenZeppelin/openzeppelin-contracts](https://github.com/OpenZeppelin/openzeppelin-contracts) in your web browser and issue a new pull request.
|
|
|
|
|
|
*IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions
|
|
*IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions
|
|
refer to some very important conditions that your PR must meet in order to be accepted, such as making sure that all tests pass, JS linting tests pass, solidity linting tests pass, etc.
|
|
refer to some very important conditions that your PR must meet in order to be accepted, such as making sure that all tests pass, JS linting tests pass, solidity linting tests pass, etc.
|
|
|
|
|
|
-5) 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 OpenZeppelin.
|
|
|
|
|
|
+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 OpenZeppelin.
|
|
|
|
|
|
*IMPORTANT* Please pay attention to the maintainer's feedback, since its a necessary step to keep up with the standards OpenZeppelin attains to.
|
|
*IMPORTANT* Please pay attention to the maintainer's feedback, since its a necessary step to keep up with the standards OpenZeppelin attains to.
|
|
|
|
|