8000 Merge branch '4.0' · symfony/symfony-docs@bb82909 · GitHub
[go: up one dir, main page]
Skip to content

Commit bb82909

Browse files
weaverryanweaverryan
committed
Merge branch '4.0'
* 4.0: (29 commits) Updating 2 more articles for 4.0 tweaking language fix(syntax): added a space before has fix(tip): Add the tip block for realpth_cache_size [FIX](Realpath) using "!php/const:" with a colon isn't allowed anymore Minor fixes Add 3rd slash for sqlite database url Templating docs: add the asset package requirement Fix diff syntax formatting typo fix rewording fixing build errors tweaks Proofing the controller chapters more work on getting started docs WIP controller chapter WIP controller changes Updating routing for Flex Show controller tag for PHP configuration ...
2 parents 196aad5 + bd9a614 commit bb82909

File tree

17 files changed

+315
-598
lines changed

17 files changed

+315
-598
lines changed

‎contributing/code/core_team.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,10 @@ Active Core Members
8181
components and the SecurityBundle_;
8282

8383
* **Maxime Steinhausser** (`ogizanagi`_) can merge into Config_, Console_,
84-
Form_, Serializer_, DependencyInjection_, and HttpKernel_ components.
84+
Form_, Serializer_, DependencyInjection_, and HttpKernel_ components;
85+
86+
* **Tobias Nyholm** (`Nyholm`) manages the official and contrib recipes
87+
repositories.
8588

8689
* **Deciders** (``@symfony/deciders`` on GitHub):
8790

@@ -223,4 +226,4 @@ discretion of the **Project Leader**.
223226
.. _`lyrixx`: https://github.com/lyrixx/
224227
.. _`chalasr`: https://github.com/chalasr/
225228
.. _`ogizanagi`: https://github.com/ogizanagi/
226-
.. _`csarrazi`: https://github.com/csarrazi/
229+
.. _`Nyholm`: https://github.com/Nyholm

‎contributing/code/reproducer.rst

Lines changed: 28 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,22 @@ Reproducing Complex Bugs
3333
------------------------
3434

3535
If the bug is related to the Symfony Framework or if it's too complex to create
36-
a PHP script, it's better to reproduce the bug by forking the Symfony Standard
37-
edition. To do so:
38-
39-
#. Go to https://github.com/symfony/symfony-standard and click on the **Fork**
40-
button to make a fork of that repository or go to your already forked copy.
41-
#. Clone the forked repository into your computer:
42-
``git clone git://github.com/YOUR-GITHUB-USERNAME/symfony-standard.git``
43-
#. Browse the project and create a new branch (e.g. ``issue_23567``,
44-
``reproduce_23657``, etc.)
45-
#. Now you must add the minimum amount of code to reproduce the bug. This is the
36+
a PHP script, it's better to reproduce the bug by creating a new project. To do so:
37+
38+
1. Create a new project:
39+
40+
.. code-block:: terminal
41+
42+
$ composer require symfony/skeleton bug_app
43+
44+
2. Now you must add the minimum amount of code to reproduce the bug. This is the
4645
trickiest part and it's explained a bit more later.
47-
#. Add, commit and push all your changes.
48-
#. Add a comment in your original issue report to share the URL of your forked
49-
project (e.g. ``https://github.com/YOUR-GITHUB-USERNAME/symfony-standard/tree/issue_23567``)
46+
3. Add and commit your changes.
47+
4. Create a `new repository`_ on GitHub (give it any name).
48+
5. Follow the instructions on GitHub to add the ``origin`` remote to your local project
49+
and push it.
50+
6. Add a comment in your original issue report to share the URL of your forked
51+
project (e.g. ``https://github.com/YOUR-GITHUB-USERNAME/symfony_issue_23567``)
5052
and, if necessary, explain the steps to reproduce (e.g. "browse this URL",
5153
"fill in this data in the form and submit it", etc.)
5254

@@ -55,23 +57,24 @@ Adding the Minimum Amount of Code Possible
5557

5658
The key to create a bug reproducer is to solely focus on the feature that you
5759
suspect is failing. For example, imagine that you suspect that the bug is related
58-
to a route definition. Then, after forking the Symfony Standard Edition:
60+
to a route definition. Then, after creating your project:
5961

6062
#. Don't edit any of the default Symfony configuration options.
6163
#. Don't copy your original application code and don't use the same structure
62-
of bundles, controllers, actions, etc. as in your original application.
63-
#. Open the default controller class of the AppBundle and add your routing
64-
definition using annotations.
64+
of controllers, actions, etc. as in your original application.
65+
#. Create a simple controller and add your routing definition that shows the bug.
6566
#. Don't create or modify any other file.
66-
#. Execute the ``server:run`` command and browse the previously defined route
67-
to see if the bug appears or not.
67+
#. Execute ``composer require server`` and use the ``server:run`` command to browse
68+
to the new route and see if the bug appears or not.
6869
#. If you can see the bug, you're done and you can already share the code with us.
6970
#. If you can't see the bug, you must keep making small changes. For example, if
7071
your original route was defined using XML, forget about the previous route
71-
annotation and define the route using XML instead. Or maybe your application
72-
uses bundle inheritance and that's where the real bug is. Then, forget about
73-
AppBundle and quickly generate a new AppParentBundle, make AppBundle inherit
74-
from it and test if the route is working.
72+
and define the route using XML instead. Or maybe your application
73+
registers some event listeners and that's where the real bug is. In that case,
74+
add an event listener that's similar to your real app to see if you can find
75+
the bug.
76+
77+
In short, the idea is to keep adding small and incremental changes to a new project
78+
until you can reproduce the bug.
7579

76-
In short, the idea is to keep adding small and incremental changes to the default
77-
Symfony Standard edition until you can reproduce the bug.
80+
.. _`new repository`: https://github.com/new

0 commit comments

Comments
 (0)
0