Skip to content

Commit

Permalink
Add note on tags to CONTRIBUTING.rst
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
NateMeyvis authored Oct 21, 2022
1 parent baada53 commit 6b905ee
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 6b905ee

Please sign in to comment.