docs: Update contributing document to include tag pulling instructions

Issue-706: #706 PR-708: #708
mkdocstrings · Nov 4, 2024 · e732aaa · e732aaa
1 parent bcdfc70
commit e732aaa
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -7,10 +7,19 @@ Every little bit helps, and credit will always be given.
 
 Nothing easier!
 
-Fork and clone the repository, then:
+Fork and clone the repository. The project uses dynamic versioning, so to get the correct package version when building, make sure to pull Git tags:
 
 ```bash
 cd mkdocstrings
+
+# Assuming you authenticate with SSH.
+git remote add upstream [email protected]:mkdocstrings/mkdocstrings
+git pull upstream --tags
+```
+
+Then:
+
+```bash
 make setup
 ```