Skip to content

Commit cc06334

Browse files
benjefferymergify[bot]
authored andcommitted
Remove submodule refs from dev docs
1 parent 1374729 commit cc06334

File tree

1 file changed

+3
-9
lines changed

1 file changed

+3
-9
lines changed

docs/development.md

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -136,19 +136,15 @@ Caveat emptor, etc..
136136
To get a local git development environment, please follow these steps:
137137

138138
- Make a fork of the tskit repo on [GitHub](http://github.com/tskit-dev/tskit)
139-
- Clone your fork into a local directory, making sure that the **submodules
140-
are correctly initialised**:
139+
- Clone your fork into a local directory:
141140
```bash
142-
$ git clone [email protected]:YOUR_GITHUB_USERNAME/tskit.git --recurse-submodules
143-
```
144-
For an already checked out repo, the submodules can be initialised using:
145-
```bash
146-
$ git submodule update --init --recursive
141+
$ git clone [email protected]:YOUR_GITHUB_USERNAME/tskit.git
147142
```
148143
- Install the {ref}`sec_development_workflow_pre_commit`:
149144
```bash
150145
$ pre-commit install
151146
```
147+
If you later have trouble with these checks, you can skip them with ``git commit --no-verify``.
152148

153149
See the {ref}`sec_development_workflow_git` section for detailed information
154150
on the recommended way to use git and GitHub.
@@ -617,8 +613,6 @@ install directly from GitHub requires you to specify `subdirectory=python`.)
617613
- If `make` is giving you strange errors, or if tests are failing for
618614
strange reasons, try running `make clean` in the project root
619615
and then rebuilding.
620-
- If cryptic problems still persist, it may be that your git submodules are
621-
out of date. Try running `git submodule update --init --recursive`.
622616
- Beware of multiple versions of the python library installed by different
623617
programs (e.g., pip versus installing locally from source)! In python,
624618
`tskit.__file__` will tell you the location of the package that is being

0 commit comments

Comments
 (0)