Skip to content

Commit 2672201

Browse files
authored
Merge pull request #1543 from yasirroni/contributing_install
include install and test on `contributing.md`
2 parents eebc3d7 + 773fd60 commit 2672201

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

CONTRIBUTING.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,21 @@
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 superfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it:
5+
Install nbdev in editable mode with development dependencies:
6+
```sh
7+
pip install -e '.[dev]'
68
```
9+
10+
Before anything else, please install the git hooks that run automatic scripts during each commit and merge to strip the notebooks of superfluous metadata (and avoid merge conflicts). After cloning the repository, run the following command inside it:
11+
```sh
712
nbdev_install_hooks
813
```
914

15+
Run the test suite to ensure everything is working:
16+
```sh
17+
nbdev_test
18+
```
19+
1020
## Did you find a bug?
1121

1222
* Ensure the bug was not already reported by searching on GitHub under Issues.

0 commit comments

Comments
 (0)