Improve project setup description (#240)

* feat: update README ad CONTRIBUTING guides * Update README.md Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com> * feat: update README * feat: update README Co-authored-by: Andrew Fleming <fleming.andrew@protonmail.com>
OpenZeppelin · Oct 21, 2022 · a8cfeae · a8cfeae
1 parent 01ddf87
commit a8cfeae
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 11 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -33,22 +33,22 @@ As a contributor, you are expected to fork this repository, work on your own for
     git checkout -b fix/some-bug-#123
     ```
 
-3. Make your changes, add your files, commit, and push to your fork.
-
-    ```sh
-    git add some_file.py
-    git commit "Fix some bug #123"
-    git push origin fix/some-bug-#123
-    ```
-
-4. Run tests, linter, etc. This can be done by running local continuous integration and make sure it passes.
+3. Make your changes and run tests, linter, etc. This can be done by running local continuous integration and make sure it passes.
 
     ```bash
     tox
     tox -e format
     tox -e lint
     ```
 
+4. Add your files, commit, and push to your fork.
+
+    ```sh
+    git add some_file.py
+    git commit "Fix some bug #123"
+    git push origin fix/some-bug-#123
+    ```
+
 5. Go to [github.com/OpenZeppelin/nile](https://github.com/OpenZeppelin/nile) in your web browser and issue a new pull request.
     Begin the body of the PR with "Fixes #123" or "Resolves #123" to link the PR to the issue that it is resolving.
     *IMPORTANT* Read the PR template very carefully and make sure to follow all the instructions. These instructions

diff --git a/README.md b/README.md
@@ -497,14 +497,16 @@ OpenZeppelin Nile exists thanks to its contributors. There are many ways you can
 
 ## Hacking on Nile
 
-Nile uses tox to manage development tasks, you can get a list of
-available task with `tox -av`.
+Nile uses tox to manage development tasks. Here are some hints to play with the source code:
 
 - Install a development version of the package with `python -m pip install .`
+- Install tox for development tasks with `python -m pip install tox`
+- Get a list of available tasks with `tox -av`
 - Build the package with `tox -e build`
 - Format all files with `tox -e format`
 - Check files formatting with `tox -e lint`
 
+
 ### Testing
 
 To run tests: