Skip to content

Commit 11a72fb

Browse files
committed
Clarify fork instructions in contributing docs
`setup.py` expects to be able to find git tags in order to properly set the package version. If a fork does not have any tags, `pip install -e .` will fail due to the default `"unknown"` being an invalid version.
1 parent b537a50 commit 11a72fb

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

doc/sphinx/source/contributing.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,10 @@ environment with
3030
# necessary every time you work on bpython
3131
$ source bpython-dev/bin/activate
3232
33-
Fork bpython in the GitHub web interface, then clone the repo:
33+
Fork bpython in the GitHub web interface. Be sure to include the tags
34+
in your fork by un-selecting the option to copy only the main branch.
35+
36+
Then, clone the forked repo:
3437

3538
.. code-block:: bash
3639

0 commit comments

Comments
 (0)