Skip to content

Commit b0c7081

Browse files
authored
Merge pull request #9828 from Lukas-Fletcher/patch-2
update editing pages online instructions in contributing_to_the_documentation.rst
2 parents 8a922af + fee3226 commit b0c7081

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

contributing/documentation/contributing_to_the_documentation.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,29 @@ and to log in to use it. Once logged in, you can propose change like so:
8181

8282
1. Click the **Edit on GitHub** button.
8383

84-
2. On the GitHub page you're taken to, click the pencil icon in the top-right
85-
corner near the **Raw**, **Blame**, and **Delete** buttons. It has the
86-
tooltip "Fork this project and edit the file".
84+
2. On the GitHub page you're taken to, make sure the current branch is "master".
85+
Click the pencil icon in the top-right corner
86+
near the **Raw**, **Blame**, and **Delete** buttons.
87+
It has the tooltip "Fork this project and edit the file".
8788

8889
3. Edit the text in the text editor.
8990

90-
4. At the bottom of the web page, summarize the changes you made and click the
91-
button **Propose file change**. Make sure to replace the placeholder "Update file.rst"
92-
by a short, but clear one-line description, as this is the commit title.
91+
4. Click "Commit changes...", summarize the changes you made
92+
and make sure to replace the placeholder "Update file.rst" by a short,
93+
but clear one-line description, as this is the commit title.
94+
Click the button **Propose changes**.
9395

9496
5. On the following screens, click the **Create pull request** button until you
9597
see a message like *Username wants to merge 1 commit into godotengine:master
9698
from Username:patch-1*.
9799

100+
.. note::
101+
102+
If there are more commits than your own in the pull request
103+
it is likely that your branch was created using the wrong origin,
104+
due to "master" not being the current branch in step 2.
105+
You will need to rebase your branch to "master" or create a new branch.
106+
98107
Another contributor will review your changes and merge them into the docs if
99108
they're good. They may also make changes or ask you to do so before merging.
100109

0 commit comments

Comments
 (0)