Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 8be88af

Browse filesBrowse files
xelarisxelaris
committed
[Contributing] Several tweaks
1 parent 9fee9ee commit 8be88af
Copy full SHA for 8be88af

File tree

Expand file treeCollapse file tree

4 files changed

+35
-15
lines changed
Filter options
Expand file treeCollapse file tree

4 files changed

+35
-15
lines changed

‎contributing/documentation/format.rst

Copy file name to clipboardExpand all lines: contributing/documentation/format.rst
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ reStructuredText
1111
reStructuredText is a plaintext markup syntax similar to Markdown, but much
1212
stricter with its syntax. If you are new to reStructuredText, take some time to
1313
familiarize with this format by reading the existing `Symfony documentation`_
14+
in raw format.
1415

1516
If you want to learn more about this format, check out the `reStructuredText Primer`_
1617
tutorial and the `reStructuredText Reference`_.
@@ -182,7 +183,7 @@ Symfony, you should precede your description of the change with a
182183
You can also ask a question and hide the response. This is particularly [...]
183184
184185
If you're documenting a behavior change, it may be helpful to *briefly* describe
185-
how the behavior has changed.
186+
how the behavior has changed:
186187

187188
.. code-block:: rst
188189

‎contributing/documentation/overview.rst

Copy file name to clipboardExpand all lines: contributing/documentation/overview.rst
+24-9Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,19 +79,19 @@ even remove any content, but make sure that you comply with the
7979
8080
**Step 7.** Everything is now ready to initiate a **pull request**. Go to your
8181
forked repository at ``https//github.com/<YOUR GITHUB USERNAME>/symfony-docs``
82-
and click on the ``Pull Requests`` link located in the sidebar.
82+
and click on the **Pull Requests** link located in the sidebar.
8383

84-
Then, click on the big ``New pull request`` button. As GitHub cannot guess the
84+
Then, click on the big **New pull request** button. As GitHub cannot guess the
8585
exact changes that you want to propose, select the appropriate branches where
86-
changes should be applied:º
86+
changes should be applied:
8787

8888
.. image:: /images/contributing/docs-pull-request-change-base.png
8989
:align: center
9090

91-
In this example, the **base repository** should be ``symfony/symfony-docs`` and
92-
the **base branch** should be the ``2.3``, which is the branch that you selected
93-
to base your changes on. The **compare repository** should be your forked copy
94-
of ``symfony-docs`` and the **compare branch** should be ``improve_install_chapter``,
91+
In this example, the **base fork** should be ``symfony/symfony-docs`` and
92+
the **base** branch should be the ``2.3``, which is the branch that you selected
93+
to base your changes on. The **head fork** should be your forked copy
94+
of ``symfony-docs`` and the **compare** branch should be ``improve_install_chapter``,
9595
which is the name of the branch you created and where you made your changes.
9696

9797
.. _pull-request-format:
@@ -188,7 +188,7 @@ section:
188188
# submit the changes to your forked repository
189189
$ git add xxx.rst # (optional) only if this is a new content
190190
$ git commit xxx.rst
191-
$ git push
191+
$ git push origin my_changes
192192
193193
# go to GitHub and create the Pull Request
194194
#
@@ -230,7 +230,7 @@ steps to contribute to the Symfony documentation, which you can use as a
230230
# add and commit your changes
231231
$ git add xxx.rst # (optional) only if this is a new content
232232
$ git commit xxx.rst
233-
$ git push
233+
$ git push origin my_changes
234234
235235
# go to GitHub and create the Pull Request
236236
#
@@ -248,6 +248,21 @@ steps to contribute to the Symfony documentation, which you can use as a
248248
249249
You guessed right: after all this hard work, it's **time to celebrate again!**
250250

251+
Minor Changes (e.g. Typos)
252+
--------------------------
253+
254+
You may find just a typo and want to fix it. Due to GitHub's functional
255+
frontend, it is quite simple to create Pull Requests right in your
256+
browser while reading the docs on symfony.com. To do this, just click
257+
the **edit this page** button on the upper right corner. Beforehand,
258+
please switch to the right branch as mentioned before. Now you are able
259+
to edit the content and describe your changes within the GitHub
260+
frontend. When your work is done, click **Propose file change** to
261+
create a commit and, in case it is your first contribution, also your
262+
fork. A new branch is created automatically in order to provide a base
263+
for your Pull Request. Then fill out the form to create the Pull Request
264+
as described above.
265+
251266
Frequently Asked Questions
252267
--------------------------
253268

‎contributing/documentation/standards.rst

Copy file name to clipboardExpand all lines: contributing/documentation/standards.rst
+8-4Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,10 @@ Code Examples
5858
* When you fold a part of a line, e.g. a variable value, put ``...`` (without comment)
5959
at the place of the fold;
6060
* Description of the folded code: (optional)
61-
If you fold several lines: the description of the fold can be placed after the ``...``
62-
If you fold only part of a line: the description can be placed before the line;
61+
62+
* If you fold several lines: the description of the fold can be placed after the ``...``;
63+
* If you fold only part of a line: the description can be placed before the line;
64+
6365
* If useful to the reader, a PHP code example should start with the namespace
6466
declaration;
6567
* When referencing classes, be sure to show the ``use`` statements at the
@@ -77,8 +79,9 @@ Configuration examples should show all supported formats using
7779
:ref:`configuration blocks <docs-configuration-blocks>`. The supported formats
7880
(and their orders) are:
7981

80-
* **Configuration** (including services and routing): YAML, XML, PHP
81-
* **Validation**: YAML, Annotations, XML, PHP
82+
* **Configuration** (including services): YAML, XML, PHP
83+
* **Routing**: Annotations, YAML, XML, PHP
84+
* **Validation**: Annotations, YAML, XML, PHP
8285
* **Doctrine Mapping**: Annotations, YAML, XML, PHP
8386
* **Translation**: XML, YAML, PHP
8487

@@ -151,6 +154,7 @@ English Language Standards
151154
* **Gender-neutral language**: when referencing a hypothetical person, such as
152155
*"a user with a session cookie"*, use gender-neutral pronouns (they/their/them).
153156
For example, instead of:
157+
154158
* he or she, use they
155159
* him or her, use them
156160
* his or her, use their

‎contributing/documentation/translations.rst

Copy file name to clipboardExpand all lines: contributing/documentation/translations.rst
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ in the translation process.
66

77
.. note::
88

9-
Symfony Project officially discourages starting new translations for the
9+
Symfony Project officially discourages from starting new translations for the
1010
documentation. As a matter of fact, there is `an ongoing discussion`_ in
1111
the community about the benefits and drawbacks of community driven translations.
1212

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.