Skip to content

Commit ea65196

Browse files
committed
added more hints about the goals of the check-list
1 parent 1666468 commit ea65196

File tree

1 file changed

+40
-11
lines changed

1 file changed

+40
-11
lines changed

contributing/code/patches.rst

Lines changed: 40 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -264,17 +264,6 @@ pull request message, like in:
264264
[Yaml] fixed something
265265
[Form] [Validator] [FrameworkBundle] added something
266266
267-
.. tip::
268-
269-
Please use the title with "[WIP]" if the submission is not yet completed
270-
or the tests are incomplete or not yet passing. Also add a todo-list in
271-
the pull-request description describing what still need to be done:
272-
273-
.. code-block:: text
274-
275-
- [ ] tests need to be updated
276-
- [ ] documentation PR yet to be submitted
277-
278267
The pull request description must include the following check list to ensure
279268
that contributions may be reviewed without needless feedback loops and that
280269
your contributions can be included into Symfony2 as quickly as possible:
@@ -317,6 +306,46 @@ the shorter version of the check-list:
317306
| Fixed tickets | [comma separated list of tickets fixed by the PR]
318307
| License | MIT
319308
309+
Some answers to the questions trigger some more requirements:
310+
311+
* If you answer yes to "Bug fix?", check if the bug is already listed in the
312+
Symfony issues and reference it/them in "Fixed tickets";
313+
314+
* If you answer yes to "New feature?", you must submit a pull request to the
315+
documentation and reference it under the "Doc PR" section;
316+
317+
* If you answer yes to "BC breaks?", the patch must contain updates to the
318+
relevant CHANGELOG and UPGRADE files;
319+
320+
* If you answer yes to "Deprecations?", the patch must contain updates to the
321+
relevant CHANGELOG and UPGRADE files;
322+
323+
* If you answer no to "Tests pass", you must add an item to a todo-list with
324+
the actions that must be done to fix the tests;
325+
326+
* If the "license" is not MIT, just don't submit the pull request as it won't
327+
be accepted anyway.
328+
329+
If some of the previous requirements are not met, create a todo-list and add
330+
relevant items:
331+
332+
.. code-block:: text
333+
334+
- [ ] fix the tests as they have not been updated yet
335+
- [ ] submit changes to the documentation
336+
- [ ] document the BC breaks
337+
338+
If the code is not finished yet because you don't have time to finish it or
339+
because you want early feedback on your work, add an item to todo-list:
340+
341+
.. code-block:: text
342+
343+
- [ ] finish the code
344+
- [ ] gather feedback my changes
345+
346+
As long as you have items in the todo-list, please prefix the pull request
347+
title with "[WIP]".
348+
320349
In the pull request description, give as much details as possible about your
321350
changes (don't hesitate to give code examples to illustrate your points). If
322351
your pull request is about adding a new feature or modifying an existing one,

0 commit comments

Comments
 (0)