@@ -46,8 +46,12 @@ Next, create a dedicated branch for your changes (for organization):
46
46
47
47
You can now make your changes directly to this branch and commit them. When
48
48
you're done, push this branch to *your * GitHub fork and initiate a pull request.
49
- The pull request will be between your ``improving_foo_and_bar `` branch and
50
- the ``symfony-docs `` ``master `` branch.
49
+
50
+ Creating a Pull Request
51
+ ~~~~~~~~~~~~~~~~~~~~~~~
52
+
53
+ Following the example, create a pull request will be between your ``improving_foo_and_bar ``
54
+ branch and the ``symfony-docs `` ``master `` branch.
51
55
52
56
.. image :: /images/docs-pull-request.png
53
57
:align: center
@@ -60,8 +64,8 @@ the base branch to be 2.0 on the preview page:
60
64
61
65
.. note ::
62
66
63
- All changes made to the 2.0 branch will be merged into 2.1 which in turn will be
64
- merged into the master branch for the next release on a weekly basis.
67
+ All changes made to a branch (e.g. 2.0) will be merged up to each "newer"
68
+ branch (e.g. 2.1, master, etc) for the next release on a weekly basis.
65
69
66
70
GitHub covers the topic of `pull requests `_ in detail.
67
71
@@ -70,6 +74,34 @@ GitHub covers the topic of `pull requests`_ in detail.
70
74
The Symfony2 documentation is licensed under a Creative Commons
71
75
Attribution-Share Alike 3.0 Unported :doc: `License <license >`.
72
76
77
+ Pull Request Format
78
+ ~~~~~~~~~~~~~~~~~~~
79
+
80
+ To ease the core team's work, the pull request description must include the
81
+ following checklist to ensure that contributions may be reviewed without
82
+ needless feedback loops and that your contributions can be included into
83
+ the documentation as quickly as possible:
84
+
85
+ .. code-block :: text
86
+
87
+ | Q | A
88
+ | ------------- | ---
89
+ | Doc fix? | [yes|no]
90
+ | New docs? | [yes|no]
91
+ | Applies to | [Symfony version numbers this applies to]
92
+ | Fixed tickets | [comma separated list of tickets fixed by the PR]
93
+
94
+ An example submission could now look as follows:
95
+
96
+ .. code-block :: text
97
+
98
+ | Q | A
99
+ | ------------- | ---
100
+ | Doc fix? | yes
101
+ | New docs? | no
102
+ | Applies to | all (or 2.1+)
103
+ | Fixed tickets | #1075
104
+
73
105
.. tip ::
74
106
75
107
Please be patient. It can take from 15 minutes to several days for your changes
0 commit comments