diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7ab3eccf0..85c888c86 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,11 +2,21 @@ ## How to get started -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: +Install nbdev in editable mode with development dependencies: +```sh +pip install -e '.[dev]' ``` + +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: +```sh nbdev_install_hooks ``` +Run the test suite to ensure everything is working: +```sh +nbdev_test +``` + ## Did you find a bug? * Ensure the bug was not already reported by searching on GitHub under Issues.