[Contributing] Several tweaks #4793

xelaris · 2015-01-08T01:16:35Z

Q	A
Doc fix?	yes
New docs?	yes
Applies to	2.3+
Fixed tickets

xelaris · 2015-01-08T01:17:34Z

contributing/documentation/overview.rst

+In this example, the **base fork** should be ``symfony/symfony-docs`` and
+the **base** branch should be the ``2.3``, which is the branch that you selected
+to base your changes on. The **head fork** should be your forked copy
+of ``symfony-docs`` and the **compare** branch should be ``improve_install_chapter``,


these changes are done to match the image

javiereguiluz · 2015-01-08T08:13:04Z

👍 thanks @xelaris!

xelaris · 2015-01-08T08:49:15Z

Thanks for the review @javiereguiluz. The commit has been updated. I think using To do this, is even better, isn't it?

xabbuh · 2015-01-08T10:39:57Z

contributing/documentation/standards.rst

+  * ``{# ... #}`` (twig);
+  * ``<!-- ... -->`` (xml/html);
+  * ``; ...`` (ini);
+  * ``...`` (text);


I would not use semicolons here.

same here :)

wouterj · 2015-01-08T10:43:34Z

contributing/documentation/overview.rst

@@ -136,7 +136,7 @@ changes and push them:

    # ... do your changes

-    $ git push
+    $ git push origin improve_install_chapter


you can ommit both, as the current branch is selected by default and the origin repo also. People have different namings, so this can cause many problems. (e.g. I call this repo origin and my fork wouterj)

You are right, since it's related to the first contribution and following the previous steps, git push is enough.
My thought while adding this was: if push.default is set to matching all the local branches are pushed to their matching ones on the remote. Anyway I will revert this change, since it's an edge case.

xelaris · 2015-01-08T12:00:07Z

Thanks for your comments @xabbuh and @wouterj. I have change the commit.

stof · 2015-01-08T18:09:03Z

contributing/documentation/standards.rst

+  * ``// ...`` (php)
+  * ``# ...`` (yaml/bash)
+  * ``{# ... #}`` (twig)
+  * ``<!-- ... -->`` (xml/html)


maybe add a note that the HTML commit is also used when writing PHP template (i.e. the html+php format)

Something like

To fold HTML in PHP templates (html+php format) use the HTML comment, no PHP tag with comment.

?

xelaris · 2015-01-18T14:41:38Z

@wouterj I reverted to a horizontal list

xabbuh · 2015-03-08T09:49:47Z

@xelaris Sorry for the delay. This looks good to me and I labeled it as finished.

weaverryan · 2015-03-10T00:02:40Z

These are great! Thanks Alexander!

This PR was merged into the 2.3 branch. Discussion ---------- [Contributing] Several tweaks | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | 2.3+ | Fixed tickets | Commits ------- 8be88af [Contributing] Several tweaks

* 2.3: (23 commits) Update configuration.rst Update configuration.rst Readability [#4875] Minor language tweaks [#4779] Minor tweaks to a huge PR Fixed some of the comments [#4793] Very minor tweak that sounds more natural [config][translator] use the new fallbacks option. Linked "logrotate" to its official website Minor rewording Added a note about log file sizes and the use of logrotate Use snake_case for template names Made http cache chapter best-practices-compatible and lots of other fixes Made propel chapter best-practices-compatible and lots of other fixes Made testing chapter best-practices-compatible and lots of other fixes Made validation chapter best-practices-compatible Remove usage of first person Updated as per feedback. Updated as per feedback Fix typos ... Conflicts: book/forms.rst book/testing.rst cookbook/logging/monolog.rst reference/configuration/framework.rst

* 2.6: (32 commits) Update configuration.rst Update configuration.rst Readability [#4875] Minor language tweaks [#4779] Minor tweaks to a huge PR [#4724] Minor language tweaks and cross-link to form theming document the validation payload option Fixed some of the comments [#4793] Very minor tweak that sounds more natural [#4732] Tweaking language, clarifying purpose of disabling form and that you can disable CSRF on 1 form [#4732] Tweaking language, clarifying purpose of disabling form and that you can disable CSRF on 1 form [config][translator] use the new fallbacks option. add missing reference options and descriptions Linked "logrotate" to its official website Minor rewording Added a note about log file sizes and the use of logrotate Use snake_case for template names Fixed minor grammar issues Made http cache chapter best-practices-compatible and lots of other fixes Made propel chapter best-practices-compatible and lots of other fixes ...

* 2.7: (38 commits) Update configuration.rst Update configuration.rst Readability [#4875] Minor language tweaks [#4779] Minor tweaks to a huge PR [#4724] Minor language tweaks and cross-link to form theming [Serializer] Fix CS document the validation payload option Fixed some of the comments [#4793] Very minor tweak that sounds more natural [#4732] Tweaking language, clarifying purpose of disabling form and that you can disable CSRF on 1 form [#4732] Tweaking language, clarifying purpose of disabling form and that you can disable CSRF on 1 form [config][translator] use the new fallbacks option. add missing reference options and descriptions Linked "logrotate" to its official website Minor rewording Added a note about log file sizes and the use of logrotate Use snake_case for template names Fixed minor grammar issues Made http cache chapter best-practices-compatible and lots of other fixes ...

xelaris reviewed Jan 8, 2015
View reviewed changes

xelaris force-pushed the contrib-tweaks branch from ed9d47a to d987dee Compare January 8, 2015 08:44

xabbuh reviewed Jan 8, 2015
View reviewed changes

xabbuh added the Status: Needs Work label Jan 8, 2015

wouterj reviewed Jan 8, 2015
View reviewed changes

xelaris force-pushed the contrib-tweaks branch from d987dee to 70c69d1 Compare January 8, 2015 11:55

stof reviewed Jan 8, 2015
View reviewed changes

[Contributing] Several tweaks

8be88af

xelaris force-pushed the contrib-tweaks branch from 70c69d1 to 8be88af Compare January 18, 2015 14:39

xabbuh added Status: Reviewed and removed Status: Needs Work labels Mar 8, 2015

weaverryan merged commit 8be88af into symfony:2.3 Mar 10, 2015

weaverryan added a commit that referenced this pull request Mar 10, 2015

[#4793] Very minor tweak that sounds more natural

e49a228

xelaris deleted the contrib-tweaks branch October 31, 2022 12:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Contributing] Several tweaks #4793

[Contributing] Several tweaks #4793

xelaris commented Jan 8, 2015

xelaris Jan 8, 2015

javiereguiluz commented Jan 8, 2015

xelaris commented Jan 8, 2015

xabbuh Jan 8, 2015

wouterj Jan 8, 2015

wouterj Jan 8, 2015

xelaris Jan 8, 2015

xelaris commented Jan 8, 2015

stof Jan 8, 2015

xelaris Jan 9, 2015

xelaris commented Jan 18, 2015

xabbuh commented Mar 8, 2015

weaverryan commented Mar 10, 2015

[Contributing] Several tweaks #4793

[Contributing] Several tweaks #4793

Conversation

xelaris commented Jan 8, 2015

xelaris Jan 8, 2015

Choose a reason for hiding this comment

javiereguiluz commented Jan 8, 2015

xelaris commented Jan 8, 2015

xabbuh Jan 8, 2015

Choose a reason for hiding this comment

wouterj Jan 8, 2015

Choose a reason for hiding this comment

wouterj Jan 8, 2015

Choose a reason for hiding this comment

xelaris Jan 8, 2015

Choose a reason for hiding this comment

xelaris commented Jan 8, 2015

stof Jan 8, 2015

Choose a reason for hiding this comment

xelaris Jan 9, 2015

Choose a reason for hiding this comment

xelaris commented Jan 18, 2015

xabbuh commented Mar 8, 2015

weaverryan commented Mar 10, 2015