Skip to content

Commit f28e123

Browse files
committed
tweaked the PR check-list to make it more readable
1 parent 52dcf11 commit f28e123

File tree

1 file changed

+27
-17
lines changed

1 file changed

+27
-17
lines changed

contributing/code/patches.rst

Lines changed: 27 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -265,35 +265,45 @@ pull request message, like in:
265265
.. tip::
266266

267267
Please use the title with "[WIP]" if the submission is not yet completed
268-
or the tests are incomplete or not yet passing.
268+
or the tests are incomplete or not yet passing. Also add a todo-list in
269+
the pull-request description describing what still need to be done:
270+
271+
.. code-block:: text
272+
273+
- [ ] tests need to be updated
274+
- [ ] documentation PR yet to be submitted
269275
270276
The pull request description must include the following check list to ensure
271277
that contributions may be reviewed without needless feedback loops and that
272278
your contributions can be included into Symfony2 as quickly as possible:
273279

274280
.. code-block:: text
275281
276-
Bug fix: [yes|no]
277-
Feature addition: [yes|no]
278-
Backwards compatibility break: [yes|no]
279-
Deprecations: [what, when|no]
280-
Symfony2 tests pass: [yes|no]
281-
Fixes the following tickets: [comma separated list of tickets fixed by the PR]
282-
Todo: [list of todos pending]
283-
License of the code: MIT
284-
Documentation PR: [The reference to the documentation PR if any]
282+
| Q | A
283+
| ------------- | ---
284+
| Bug fix? | [yes|no]
285+
| New feature? | [yes|no]
286+
| BC breaks? | [yes|no]
287+
| Deprecations? | [yes|no]
288+
| Tests pass? | [yes|no]
289+
| Fixed tickets | [comma separated list of tickets fixed by the PR]
290+
| License | MIT
291+
| Doc PR | [The reference to the documentation PR if any]
285292
286293
An example submission could now look as follows:
287294

288295
.. code-block:: text
289296
290-
Bug fix: no
291-
Feature addition: yes
292-
Backwards compatibility break: no
293-
Fixes the following tickets: #12, #43
294-
Todo: -
295-
License of the code: MIT
296-
Documentation PR: symfony/symfony-docs#123
297+
| Q | A
298+
| ------------- | ---
299+
| Bug fix? | no
300+
| New feature? | no
301+
| BC breaks? | no
302+
| Deprecations? | no
303+
| Tests pass? | yes
304+
| Fixed tickets | #12, #43
305+
| License | MIT
306+
| Doc PR | symfony/symfony-docs#123
297307
298308
In the pull request description, give as much details as possible about your
299309
changes (don't hesitate to give code examples to illustrate your points). If

0 commit comments

Comments
 (0)