You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,26 +5,26 @@ We really appreciate and value contributions to OpenZeppelin. Please take 5' to
5
5
6
6
## Contribution guidelines
7
7
8
-
Smart contracts manage value and are highly vulnerable to errors and attacks. We have very strict guidelines, please make sure to review them: ["Contribution guidelines wiki entry"](https://github.com/OpenZeppelin/zeppelin-solidity/wiki/Contribution-guidelines).
8
+
Smart contracts manage value and are highly vulnerable to errors and attacks. We have very strict guidelines, please make sure to review them: ["Contribution guidelines wiki entry"](https://github.com/OpenZeppelin/openzeppelin-solidity/wiki/Contribution-guidelines).
9
9
10
10
## Creating Pull Requests (PRs)
11
11
12
12
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. See ["Fork-a-Repo"](https://help.github.com/articles/fork-a-repo/) for how this works.
13
13
14
14
*IMPORTANT*
15
-
* Please see ["Git flow wiki entry"](https://github.com/OpenZeppelin/zeppelin-solidity/wiki/Git-flow) for understanding how to use branches in this repository.
15
+
* Please see ["Git flow wiki entry"](https://github.com/OpenZeppelin/openzeppelin-solidity/wiki/Git-flow) for understanding how to use branches in this repository.
16
16
17
17
## A typical workflow
18
18
19
19
1) Make sure your fork is up to date with the main repository:
20
20
21
21
```
22
-
cd zeppelin-solidity
22
+
cd openzeppelin-solidity
23
23
git fetch upstream
24
24
git checkout development
25
25
git pull --rebase upstream development
26
26
```
27
-
NOTE: The directory `zeppelin-solidity` represents your fork's local copy.
27
+
NOTE: The directory `openzeppelin-solidity` represents your fork's local copy.
28
28
29
29
2) Branch out from `development` into `fix/some-bug-#123`:
30
30
(Postfixing #123 will associate your PR with the issue #123 and make everyone's life easier =D)
@@ -40,7 +40,7 @@ git commit "Fix some bug #123"
40
40
git push origin fix/some-bug-#123
41
41
```
42
42
43
-
4) Go to [github.com/OpenZeppelin/zeppelin-solidity](https://github.com/OpenZeppelin/zeppelin-solidity) in your web browser and issue a new pull request.
43
+
4) Go to [github.com/OpenZeppelin/openzeppelin-solidity](https://github.com/OpenZeppelin/zeppelin-solidity) in your web browser and issue a new pull request.
44
44
45
45
*IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions
46
46
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.
@@ -51,8 +51,8 @@ refer to some very important conditions that your PR must meet in order to be ac
51
51
52
52
## All set!
53
53
54
-
If you have any questions feel free to post them to github.com/OpenZeppelin/zeppelin-solidity/issues.
54
+
If you have any questions feel free to post them to github.com/OpenZeppelin/openzeppelin-solidity/issues.
55
55
56
-
Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/OpenZeppelin/zeppelin-solidity/labels/good%20first%20issue).
56
+
Finally, if you're looking to collaborate and want to find easy tasks to start, look at the issues we marked as ["Good first issue"](https://github.com/OpenZeppelin/openzeppelin-solidity/labels/good%20first%20issue).
OpenZeppelin is a library for writing secure [Smart Contracts](https://en.wikipedia.org/wiki/Smart_contract) on Ethereum.
7
7
@@ -24,15 +24,15 @@ truffle init
24
24
To install the OpenZeppelin library, run the following in your Solidity project root directory:
25
25
```sh
26
26
npm init -y
27
-
npm install -E zeppelin-solidity
27
+
npm install -E openzeppelin-solidity
28
28
```
29
29
30
30
**Note that OpenZeppelin does not currently follow semantic versioning.** You may encounter breaking changes upon a minor version bump. We recommend pinning the version of OpenZeppelin you use, as done by the `-E` (`--save-exact`) option.
31
31
32
-
After that, you'll get all the library's contracts in the `node_modules/zeppelin-solidity/contracts` folder. You can use the contracts in the library like so:
32
+
After that, you'll get all the library's contracts in the `node_modules/openzeppelin-solidity/contracts` folder. You can use the contracts in the library like so:
0 commit comments