bug-fix fixes
This commit is contained in:
parent
55ebd9f803
commit
cdd6f86e43
|
@ -166,7 +166,7 @@ Short version
|
||||||
|
|
||||||
#. Fork the repository.
|
#. Fork the repository.
|
||||||
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
|
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
|
||||||
#. Target ``master`` for bugfixes and doc changes.
|
#. Target ``master`` for bug fixes and doc changes.
|
||||||
#. Target ``features`` for new features or functionality changes.
|
#. Target ``features`` for new features or functionality changes.
|
||||||
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
|
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
|
||||||
#. Tests are run using ``tox``::
|
#. Tests are run using ``tox``::
|
||||||
|
@ -212,7 +212,7 @@ Here is a simple overview, with pytest-specific bits:
|
||||||
|
|
||||||
$ git checkout -b your-feature-branch-name features
|
$ git checkout -b your-feature-branch-name features
|
||||||
|
|
||||||
Given we have "major.minor.micro" version numbers, bugfixes 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.
|
||||||
|
|
||||||
|
@ -294,7 +294,7 @@ Here is a simple overview, with pytest-specific bits:
|
||||||
compare: your-branch-name
|
compare: your-branch-name
|
||||||
|
|
||||||
base-fork: pytest-dev/pytest
|
base-fork: pytest-dev/pytest
|
||||||
base: master # if it's a bugfix
|
base: master # if it's a bug fix
|
||||||
base: features # if it's a feature
|
base: features # if it's a feature
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
Release Procedure
|
Release Procedure
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Our current policy for releasing is to aim for a bugfix every few weeks and a minor release every 2-3 months. The idea
|
Our current policy for releasing is to aim for a bug-fix release every few weeks and a minor release every 2-3 months. The idea
|
||||||
is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence
|
is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence
|
||||||
taking a lot of time to make a new one.
|
taking a lot of time to make a new one.
|
||||||
|
|
||||||
|
|
|
@ -15,7 +15,7 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
|
||||||
|
|
||||||
* ``feature``: new user facing features, like new command-line options and new behavior.
|
* ``feature``: new user facing features, like new command-line options and new behavior.
|
||||||
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
|
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
|
||||||
* ``bugfix``: fixes a reported bug.
|
* ``bugfix``: fixes a bug.
|
||||||
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
|
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
|
||||||
* ``deprecation``: feature deprecation.
|
* ``deprecation``: feature deprecation.
|
||||||
* ``removal``: feature removal.
|
* ``removal``: feature removal.
|
||||||
|
|
|
@ -2357,7 +2357,7 @@ Deprecations and Removals
|
||||||
- `#4036 <https://github.com/pytest-dev/pytest/issues/4036>`_: The ``item`` parameter of ``pytest_warning_captured`` hook is now documented as deprecated. We realized only after
|
- `#4036 <https://github.com/pytest-dev/pytest/issues/4036>`_: The ``item`` parameter of ``pytest_warning_captured`` hook is now documented as deprecated. We realized only after
|
||||||
the ``3.8`` release that this parameter is incompatible with ``pytest-xdist``.
|
the ``3.8`` release that this parameter is incompatible with ``pytest-xdist``.
|
||||||
|
|
||||||
Our policy is to not deprecate features during bugfix releases, but in this case we believe it makes sense as we are
|
Our policy is to not deprecate features during bug-fix releases, but in this case we believe it makes sense as we are
|
||||||
only documenting it as deprecated, without issuing warnings which might potentially break test suites. This will get
|
only documenting it as deprecated, without issuing warnings which might potentially break test suites. This will get
|
||||||
the word out that hook implementers should not use this parameter at all.
|
the word out that hook implementers should not use this parameter at all.
|
||||||
|
|
||||||
|
@ -5380,7 +5380,7 @@ time or change existing behaviors in order to make them less surprising/more use
|
||||||
Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR.
|
Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR.
|
||||||
|
|
||||||
- (experimental) adapt more SEMVER style versioning and change meaning of
|
- (experimental) adapt more SEMVER style versioning and change meaning of
|
||||||
master branch in git repo: "master" branch now keeps the bugfixes, changes
|
master branch in git repo: "master" branch now keeps the bug fixes, changes
|
||||||
aimed for micro releases. "features" branch will only be released
|
aimed for micro releases. "features" branch will only be released
|
||||||
with minor or major pytest releases.
|
with minor or major pytest releases.
|
||||||
|
|
||||||
|
|
|
@ -19,7 +19,7 @@ Branches
|
||||||
|
|
||||||
We have two long term branches:
|
We have two long term branches:
|
||||||
|
|
||||||
* ``master``: contains the code for the next bugfix release.
|
* ``master``: contains the code for the next bug-fix release.
|
||||||
* ``features``: contains the code with new features for the next minor release.
|
* ``features``: contains the code with new features for the next minor release.
|
||||||
|
|
||||||
The official repository usually does not contain topic branches, developers and contributors should create topic
|
The official repository usually does not contain topic branches, developers and contributors should create topic
|
||||||
|
|
|
@ -3,7 +3,7 @@ pytest-{version}
|
||||||
|
|
||||||
pytest {version} has just been released to PyPI.
|
pytest {version} has just been released to PyPI.
|
||||||
|
|
||||||
This is a bug fix release, being a drop-in replacement. To upgrade::
|
This is a bug-fix release, being a drop-in replacement. To upgrade::
|
||||||
|
|
||||||
pip install --upgrade pytest
|
pip install --upgrade pytest
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue