Movatterモバイル変換


[0]ホーム

URL:


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

Sign up
Appearance settings

Commit963c3d2

Browse files
committed
feature#6412 added a maintenance document (fabpot)
This PR was merged into the 2.3 branch.Discussion----------added a maintenance documentAs the Symfony core team grows, more people merge PRs in old branches and I think we need to make it very clear what we can accept in versions under maintenance. This new reference document tries to list all possible cases.Commits-------201de67 added a maintenance document
2 parentsac58673 +201de67 commit963c3d2

File tree

5 files changed

+93
-4
lines changed

5 files changed

+93
-4
lines changed

‎contributing/code/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ Contributing Code
66

77
bugs
88
patches
9+
maintenance
910
core_team
1011
security
1112
tests

‎contributing/code/maintenance.rst

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
Maintenance
2+
===========
3+
4+
During the lifetime of a minor version, new releases (patch versions) are
5+
published on a monthly basis. This document describes the boundaries of
6+
acceptable changes.
7+
8+
**Bug fixes** are accepted under the following conditions:
9+
10+
* The change does not break valid unit tests;
11+
* New unit tests cover the bug fix;
12+
* The current buggy behavior is not widely used as a "feature".
13+
14+
..note::
15+
16+
When documentation (or phpdoc) is not in sync with the code, code behavior
17+
should always be considered as being the correct one.
18+
19+
Besides bug fixes, other minor changes can be accepted in a patch version:
20+
21+
* **Performance improvement**: Performance improvement should only be accepted
22+
if the changes are local (located in one class) and only for algorithmic
23+
issues (any such patches must come with numbers that show a significant
24+
improvement on real-world code);
25+
26+
* **Newer versions of PHP/HHVM**: Fixes that add support for newer versions of
27+
PHP or HHVM are acceptable if they don't break the unit test suite;
28+
29+
* **Newer versions of popular OSes**: Fixes that add support for newer versions
30+
of popular OSes (Linux, MacOS and Windows) are acceptable if they don't break
31+
the unit test suite;
32+
33+
* **Translations**: Translation updates and additions are accepted;
34+
35+
* **External data**: Updates for external data included in Symfony can be
36+
updated (like ICU for instance);
37+
38+
* **Version updates for Composer dependencies**: Changing the minimal version
39+
of a dependency is possible, bumping to a major one or increasing PHP
40+
minimal version is not;
41+
42+
* **Coding standard and refactoring**: Coding standard fixes or code
43+
refactoring are not recommended but can be accepted for consistency with the
44+
existing code base, if they are not too invasive, and if merging them on
45+
master would not lead to complex branch merging;
46+
47+
* **Tests**: Tests that increase the code coverage can be added.
48+
49+
Anything not explicitly listed above should be done on the next minor or major
50+
version instead (aka the *master* branch). For instance, the following changes
51+
are never accepted in a patch version:
52+
53+
* **New features**;
54+
55+
* **Backward compatibility breaks**: Note that backward compatibility breaks
56+
can be done when fixing a security issue if it would not be possible to fix
57+
it otherwise;
58+
59+
* **Support for external platforms**: Adding support for new platforms (like
60+
Google App Engine) cannot be done in patch versions;
61+
62+
* **Exception messages**: Exception messages must not be changed as some
63+
automated systems might rely on them (even if this is not recommended);
64+
65+
* **Adding new Composer dependencies**;
66+
67+
* **Support for newer major versions of Composer dependencies**: Taking into
68+
account support for newer versions of an existing dependency is not
69+
acceptable.
70+
71+
* **Web design**: Changing the web design of built-in pages like exceptions,
72+
the toolbar or the profiler is not allowed.
73+
74+
..note::
75+
76+
This policy is designed to enable a continuous upgrade path that allows one
77+
to move forward with newest Symfony versions in the safest way. One should
78+
be able to move PHP versions, OS or Symfony versions almost independently.
79+
That's the reason why supporting the latest PHP versions or OS features is
80+
considered as bug fixes.

‎contributing/code/patches.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,10 +107,12 @@ Choose the right Branch
107107
Before working on a patch, you must determine on which branch you need to
108108
work:
109109

110-
* ``2.3``, if you are fixing a bug for an existing feature (you may have
111-
to choose a higher branch if the feature you are fixing was introduced
112-
in a later version);
113-
* ``master``, if you are adding a new feature.
110+
* ``2.3``, if you are fixing a bug for an existing feature or want to make a
111+
change that falls into the:doc:`list of acceptable changes in patch versions
112+
</contributing/code/maintenance>` (you may have to choose a higher branch if
113+
the feature you are fixing was introduced in a later version);
114+
115+
* ``master``, if you are adding a new feature.
114116

115117
..note::
116118

‎contributing/community/releases.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,11 @@ type of the release. This maintenance is divided into:
4848
be fixed. The end of this period is referenced as being the *end of life* of
4949
a release.
5050

51+
..note::
52+
53+
The:doc:`maintenance document</contributing/code/maintenance>` describes
54+
the boundaries of acceptable changes during maintenance.
55+
5156
Symfony Versions
5257
----------------
5358

‎contributing/map.rst.inc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
* :doc:`Bugs</contributing/code/bugs>`
44
* :doc:`Patches</contributing/code/patches>`
55
* :doc:`Reviewing Issues and Patches</contributing/community/reviews>`
6+
* :doc:`Maintenance</contributing/code/maintenance>`
67
* :doc:`The Core Team</contributing/code/core_team>`
78
* :doc:`Security</contributing/code/security>`
89
* :doc:`Tests</contributing/code/tests>`

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp