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.
This commit is contained in:
parent
baada535a3
commit
6b905ee6dc
|
@ -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
|
Given we have "major.minor.micro" version numbers, bug fixes will usually
|
||||||
be released in micro releases whereas features will be released in
|
be released in micro releases whereas features will be released in
|
||||||
minor releases and incompatible changes in major releases.
|
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
|
If you need some help with Git, follow this quick start
|
||||||
guide: https://git.wiki.kernel.org/index.php/QuickStart
|
guide: https://git.wiki.kernel.org/index.php/QuickStart
|
||||||
|
|
Loading…
Reference in New Issue