From 6b905ee6dc7301f95714006037f869a15d518d58 Mon Sep 17 00:00:00 2001 From: Nate Meyvis Date: Fri, 21 Oct 2022 11:17:01 -0400 Subject: [PATCH] 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. --- CONTRIBUTING.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 22c3ecefb6c..222e5bd2ee3 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -243,6 +243,11 @@ Here is a simple overview, with pytest-specific bits: Given we have "major.minor.micro" version numbers, bug fixes will usually be released in micro releases whereas features will be released in minor releases and incompatible changes in major releases. + + 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:: + + $ git remote add upstream https://github.com/pytest-dev/pytest + $ git fetch upstream --tags If you need some help with Git, follow this quick start guide: https://git.wiki.kernel.org/index.php/QuickStart