Skip to content

Commit e0014e0

Browse files
authored
Update CONTRIBUTING.md
1 parent 86337ba commit e0014e0

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,20 @@
22

33
## How to get started
44

5-
Before anything else, please install the git hooks that run automatic scripts during each commit and merge to strip the notebooks of suerpfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it:
5+
Clone the `fastcore` repository.
6+
7+
Inside the resulting local repository, run the following command to do an
8+
[editable
9+
install](https://stackoverflow.com/questions/35064426/when-would-the-e-editable-option-be-useful-with-pip-install) of the `fastcore` library with tools we use to support development:
10+
11+
```
12+
pip install -e '.[dev]'
13+
```
14+
15+
Run the following command to install git hooks that run automatic scripts during each commit and merge. These scripts strip the notebooks of superfluous metadata (and avoid merge conflicts):
16+
617
```
7-
nbdev_install_git_hooks
18+
nbdev_install_hooks
819
```
920

1021
## Did you find a bug?

0 commit comments

Comments
 (0)