Skip to content

Commit 6efb0b2

Browse files
gglanzanixhochy
andauthored
DOC: Add note about shallow clones in contributing guide (pandas-dev#34690)
Co-authored-by: Uwe L. Korn <[email protected]>
1 parent bbb89ca commit 6efb0b2

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

doc/source/development/contributing.rst

+4
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,10 @@ want to clone your fork to your machine::
136136
This creates the directory `pandas-yourname` and connects your repository to
137137
the upstream (main project) *pandas* repository.
138138

139+
Note that performing a shallow clone (with ``--depth==N``, for some ``N`` greater
140+
or equal to 1) might break some tests and features as ``pd.show_versions()``
141+
as the version number cannot be computed anymore.
142+
139143
.. _contributing.dev_env:
140144

141145
Creating a development environment

0 commit comments

Comments
 (0)