Skip to content

Commit 3a68d49

Browse files
hynekani0075saha
andcommitted
dev: document missing git tags failure mode
fixes #1490 Co-authored-by: Aniruddha Saha <9413090+ani0075saha@users.noreply.github.com>
1 parent a572c3a commit 3a68d49

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

.github/CONTRIBUTING.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,11 @@ It's people like *you* who make this project such a great tool for everyone.
6060

6161
## Local Development Environment
6262

63-
First, **fork** the repository on GitHub and **clone** it using one of the alternatives that you can copy-paste by pressing the big green button labeled `<> Code`.
63+
First, **fork** the repository on GitHub.
64+
Make sure to **uncheck** the `Copy the main branch only` radio button on the `Create a new fork` page.
65+
If you don't, our test suite will fail because we use Git tags for packaging.
66+
67+
Finally, **clone** your fork using one of the alternatives that you can copy-paste by pressing the big green button labeled `<> Code`.
6468

6569
You can (and should) run our test suite using [*tox*](https://tox.wiki/) with the [*tox-uv*](https://github.com/tox-dev/tox-uv) plugin.
6670
The easiest way is to [install *uv*] which is needed in any case and then run `uv tool install --with tox-uv tox` to have it globally available or `uvx --with tox-uv tox` to use a temporary environment.
@@ -92,6 +96,16 @@ $ pip install -e . --group dev
9296

9397
---
9498

99+
If the test suite fails with errors in `test_packaging.py`, you're lacking Git tags.
100+
You can retroactively fetch them using:
101+
102+
```console
103+
$ git remote add upstream git@github.com:python-attrs/attrs.git
104+
$ git fetch upstream --tags
105+
```
106+
107+
---
108+
95109
> [!WARNING]
96110
> - **Before** you start working on a new pull request, use the "*Sync fork*" button in GitHub's web UI to ensure your fork is up to date.
97111
>

0 commit comments

Comments
 (0)