-
-
Notifications
You must be signed in to change notification settings - Fork 5.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Contributing] Several tweaks #4793
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,19 +79,19 @@ even remove any content, but make sure that you comply with the | |
|
||
**Step 7.** Everything is now ready to initiate a **pull request**. Go to your | ||
forked repository at ``https//github.com/<YOUR GITHUB USERNAME>/symfony-docs`` | ||
and click on the ``Pull Requests`` link located in the sidebar. | ||
and click on the **Pull Requests** link located in the sidebar. | ||
|
||
Then, click on the big ``New pull request`` button. As GitHub cannot guess the | ||
Then, click on the big **New pull request** button. As GitHub cannot guess the | ||
exact changes that you want to propose, select the appropriate branches where | ||
changes should be applied:º | ||
changes should be applied: | ||
|
||
.. image:: /images/contributing/docs-pull-request-change-base.png | ||
:align: center | ||
|
||
In this example, the **base repository** 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 **compare repository** should be your forked copy | ||
of ``symfony-docs`` and the **compare branch** should be ``improve_install_chapter``, | ||
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``, | ||
which is the name of the branch you created and where you made your changes. | ||
|
||
.. _pull-request-format: | ||
|
@@ -188,7 +188,7 @@ section: | |
# submit the changes to your forked repository | ||
$ git add xxx.rst # (optional) only if this is a new content | ||
$ git commit xxx.rst | ||
$ git push | ||
$ git push origin my_changes | ||
|
||
# go to GitHub and create the Pull Request | ||
# | ||
|
@@ -230,7 +230,7 @@ steps to contribute to the Symfony documentation, which you can use as a | |
# add and commit your changes | ||
$ git add xxx.rst # (optional) only if this is a new content | ||
$ git commit xxx.rst | ||
$ git push | ||
$ git push origin my_changes | ||
|
||
# go to GitHub and create the Pull Request | ||
# | ||
|
@@ -248,6 +248,21 @@ steps to contribute to the Symfony documentation, which you can use as a | |
|
||
You guessed right: after all this hard work, it's **time to celebrate again!** | ||
|
||
Minor Changes (e.g. Typos) | ||
-------------------------- | ||
|
||
You may find just a typo and want to fix it. Due to GitHub's functional | ||
frontend, it is quite simple to create Pull Requests right in your | ||
browser while reading the docs on symfony.com. To do this, just click | ||
the **edit this page** button on the upper right corner. Beforehand, | ||
please switch to the right branch as mentioned before. Now you are able | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. "Beforehand, please [...]" |
||
to edit the content and describe your changes within the GitHub | ||
frontend. When your work is done, click **Propose file change** to | ||
create a commit and, in case it is your first contribution, also your | ||
fork. A new branch is created automatically in order to provide a base | ||
for your Pull Request. Then fill out the form to create the Pull Request | ||
as described above. | ||
|
||
Frequently Asked Questions | ||
-------------------------- | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
these changes are done to match the image