Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 87a8ffa

Browse filesBrowse files
authored
Merge pull request #25739 from story645/backport-wording
grammar/wording tweak for backports
2 parents ddb3163 + 5201e11 commit 87a8ffa
Copy full SHA for 87a8ffa

File tree

1 file changed

+12
-12
lines changed
Filter options

1 file changed

+12
-12
lines changed

‎doc/devel/coding_guide.rst

Copy file name to clipboardExpand all lines: doc/devel/coding_guide.rst
+12-12Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -281,16 +281,16 @@ Set the milestone according to these guidelines:
281281
* *Bugfixes, tests for released code, and docstring changes* may be milestoned
282282
for the next patch release ``v3.N.M``.
283283

284-
* *Documentation changes* (all .rst files and examples) may be milestoned
284+
* *Documentation changes* (only .rst files and examples) may be milestoned
285285
``v3.N-doc``.
286286

287287
If multiple rules apply, choose the first matching from the above list. See
288288
:ref:`backport-strategy` for detailed guidance on what should or should not be
289289
backported.
290290

291-
The milestone marks the release a PR should go into. It is an intent but can
292-
be changed because of re-evaluation of the PR scope and maturity or release
293-
planning.
291+
The milestone marks the release a PR should go into. It states intent, but can
292+
be changed because of release planning or re-evaluation of the PR scope and
293+
maturity.
294294

295295
All Pull Requests should target the main branch. The milestone tag triggers
296296
an :ref:`automatic backport <automated-backports>` for milestones which have
@@ -454,23 +454,23 @@ releases is to fix bugs without adding any new regressions or behavior changes.
454454
We will always attempt to backport:
455455

456456
- critical bug fixes (segfault, failure to import, things that the
457-
user can not work around)
458-
- fixes for regressions introduced in last two minor releases
457+
user cannot work around)
458+
- fixes for regressions introduced in the last two minor releases
459459

460-
and may attempt to backport regressions introduced in older releases.
460+
and may attempt to backport fixes for regressions introduced in older releases.
461461

462462
In the case where the backport is not clean, for example if the bug fix is
463463
built on top of other code changes we do not want to backport, balance the
464464
effort and risk of re-implementing the bug fix vs the severity of the bug.
465465
When in doubt, err on the side of not backporting.
466466

467-
When backporting a Pull Request fails or is declined re-milestone the original
467+
When backporting a Pull Request fails or is declined, re-milestone the original
468468
PR to the next minor release and leave a comment explaining why.
469469

470-
The only changes to be backported to the documentation branch (*v3.N.M-doc*)
471-
are changes to :file:`doc`, :file:`examples`, or :file:`tutorials`. Any
472-
changes to :file:`lib` or :file:`src`, including docstring-only changes, must
473-
not be backported to this branch.
470+
The only changes backported to the documentation branch (*v3.N.M-doc*)
471+
are changes to :file:`doc` or :file:`galleries`. Any changes to :file:`lib`
472+
or :file:`src`, including docstring-only changes, must not be backported to
473+
this branch.
474474

475475

476476
.. _automated-backports:

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.