Skip to content

Commit 79d00ab

Browse files
authored
Merge pull request #6549 from blueyed/fix-release-minor
doc: minor fixes for the release process
2 parents 38538c6 + cdd6f86 commit 79d00ab

File tree

6 files changed

+12
-12
lines changed

6 files changed

+12
-12
lines changed

CONTRIBUTING.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ Short version
166166

167167
#. Fork the repository.
168168
#. Enable and install `pre-commit <https://pre-commit.com>`_ to ensure style-guides and code checks are followed.
169-
#. Target ``master`` for bugfixes and doc changes.
169+
#. Target ``master`` for bug fixes and doc changes.
170170
#. Target ``features`` for new features or functionality changes.
171171
#. Follow **PEP-8** for naming and `black <https://github.com/psf/black>`_ for formatting.
172172
#. Tests are run using ``tox``::
@@ -212,7 +212,7 @@ Here is a simple overview, with pytest-specific bits:
212212

213213
$ git checkout -b your-feature-branch-name features
214214

215-
Given we have "major.minor.micro" version numbers, bugfixes will usually
215+
Given we have "major.minor.micro" version numbers, bug fixes will usually
216216
be released in micro releases whereas features will be released in
217217
minor releases and incompatible changes in major releases.
218218

@@ -294,7 +294,7 @@ Here is a simple overview, with pytest-specific bits:
294294
compare: your-branch-name
295295

296296
base-fork: pytest-dev/pytest
297-
base: master # if it's a bugfix
297+
base: master # if it's a bug fix
298298
base: features # if it's a feature
299299

300300

HOWTORELEASE.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
Release Procedure
22
-----------------
33

4-
Our current policy for releasing is to aim for a bugfix every few weeks and a minor release every 2-3 months. The idea
4+
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
55
is to get fixes and new features out instead of trying to cram a ton of features into a release and by consequence
66
taking a lot of time to make a new one.
77

88
.. important::
99

1010
pytest releases must be prepared on **Linux** because the docs and examples expect
11-
to be executed in that platform.
11+
to be executed on that platform.
1212

1313
#. Create a branch ``release-X.Y.Z`` with the version for the release.
1414

changelog/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
1515

1616
* ``feature``: new user facing features, like new command-line options and new behavior.
1717
* ``improvement``: improvement of existing functionality, usually without requiring user intervention (for example, new fields being written in ``--junitxml``, improved colors in terminal, etc).
18-
* ``bugfix``: fixes a reported bug.
18+
* ``bugfix``: fixes a bug.
1919
* ``doc``: documentation improvement, like rewording an entire session or adding missing docs.
2020
* ``deprecation``: feature deprecation.
2121
* ``removal``: feature removal.

doc/en/changelog.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2357,7 +2357,7 @@ Deprecations and Removals
23572357
- `#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
23582358
the ``3.8`` release that this parameter is incompatible with ``pytest-xdist``.
23592359

2360-
Our policy is to not deprecate features during bugfix releases, but in this case we believe it makes sense as we are
2360+
Our policy is to not deprecate features during bug-fix releases, but in this case we believe it makes sense as we are
23612361
only documenting it as deprecated, without issuing warnings which might potentially break test suites. This will get
23622362
the word out that hook implementers should not use this parameter at all.
23632363

@@ -5380,7 +5380,7 @@ time or change existing behaviors in order to make them less surprising/more use
53805380
Thanks Daniel Grunwald for the report and Bruno Oliveira for the PR.
53815381

53825382
- (experimental) adapt more SEMVER style versioning and change meaning of
5383-
master branch in git repo: "master" branch now keeps the bugfixes, changes
5383+
master branch in git repo: "master" branch now keeps the bug fixes, changes
53845384
aimed for micro releases. "features" branch will only be released
53855385
with minor or major pytest releases.
53865386

doc/en/development_guide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Branches
1919

2020
We have two long term branches:
2121

22-
* ``master``: contains the code for the next bugfix release.
22+
* ``master``: contains the code for the next bug-fix release.
2323
* ``features``: contains the code with new features for the next minor release.
2424

2525
The official repository usually does not contain topic branches, developers and contributors should create topic

scripts/release.minor.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The pytest team is proud to announce the {version} release!
66
pytest is a mature Python testing tool with more than a 2000 tests
77
against itself, passing on many different interpreters and platforms.
88

9-
This release contains a number of bugs fixes and improvements, so users are encouraged
9+
This release contains a number of bug fixes and improvements, so users are encouraged
1010
to take a look at the CHANGELOG:
1111

1212
https://docs.pytest.org/en/latest/changelog.html
@@ -15,7 +15,7 @@ For complete documentation, please visit:
1515

1616
https://docs.pytest.org/en/latest/
1717

18-
As usual, you can upgrade from pypi via:
18+
As usual, you can upgrade from PyPI via:
1919

2020
pip install -U pytest
2121

@@ -24,4 +24,4 @@ Thanks to all who contributed to this release, among them:
2424
{contributors}
2525

2626
Happy testing,
27-
The Pytest Development Team
27+
The pytest Development Team

0 commit comments

Comments
 (0)