This article continues from the main page and assumes that you will be using GitHub Desktop. You may use other Git clients on your own terms. Even if you do work locally, you will still need to access GitHub to create pull requests to make your changes happen.
Sign in to GitHub.com
.Click on Clone a repository
.
This will show a list of your repos; select the osu-wiki
repo.
Select the clone location. It doesn't matter where you clone the repo to, just remember where you cloned it to.
Click Clone
. This may take a while depending on your network environment.
Continue to Branching.
While branching is technically optional, it is highly recommended for a couple of reasons. To name a few:
master
branch, you can safely sync it without merge conflicts.Click on the Current branch
dropdown located at the top of the menu.
Enter the name of the branch. It is suggested to use the summary of your changes as the branch name. For example, editing the Forums
article may result in the branch being called update-forums
.
Continue to Editing.
.md
files being the locales.Caution: If you are going to create article files using Windows Explorer, make sure the File name extensions
option is enabled. See Common file name extensions in Windows for instructions.
Go back to GitHub Desktop. It should look something similar to this:
Your mileage may vary.
By default, GitHub Desktop will automatically select all of your changes.
It is best to separate each "big" action as a single commit.
For example, as pictured above, pippi had added an image file, modified the en.md
file to add a title and a link to the image, and marked the translations as outdated. From this, we can have two commits, one for the changes that affected the en.md
file, and one for marking the translations as outdated.
Select the files that are going to be committed.
Enter the commit summary. This has a 72 character limit and must be in English.
Enter the description. This is optional, doesn't have a character limit, and could be in any language.
First commit
Click on the blue Commit to
button and, if applicable, restart from step 4 to do the other commits you want to do.
Second commit
Once you have finished making your commits, click on the Publish branch
button at the top.
Continue to Review for the last piece of information regarding your pull request and changes.