Skip to content

Commit 6b905ee

Browse files
authored
Add note on tags to CONTRIBUTING.rst
Tags from the main repository are required for testing to work properly, but the current documentation does not reflect this, and at least one new contributor has been tripped up by this. Update the documentation with a short explanation and directions.
1 parent baada53 commit 6b905ee

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

CONTRIBUTING.rst

+5
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,11 @@ Here is a simple overview, with pytest-specific bits:
243243
Given we have "major.minor.micro" version numbers, bug fixes will usually
244244
be released in micro releases whereas features will be released in
245245
minor releases and incompatible changes in major releases.
246+
247+
You will need the tags to test locally, so be sure you have the tags from the main repository. If you suspect you don't, set the main repository as upstream and fetch the tags::
248+
249+
$ git remote add upstream https://github.com/pytest-dev/pytest
250+
$ git fetch upstream --tags
246251

247252
If you need some help with Git, follow this quick start
248253
guide: https://git.wiki.kernel.org/index.php/QuickStart

0 commit comments

Comments
 (0)