Skip to content
Enno Rehling edited this page May 12, 2015 · 3 revisions

How to suggest text changes and fix typos.

  1. Go to https://github.com/eressea/server and click the Fork button in the upper right.
  2. If you do not yet have a github account, creeate one at this point, or log into your existing account.
  3. Search for the XML file that contains the text you want to change. github currently only allows you to search the original repository, so go back to the original URL above and type into the search bar. This will tell you the name of the file you want to edit.
  4. Find this file in your own fork. The editing button (small pen icon in the top right) will probably be disabled because you are not on a branch.
  5. In the top left, click the branch dropdown, and choose the develop branch. This will enable the editor icon, so click that next.
  6. Make your desired changes in the website editor (it's called Atom), then scroll to the bottom of the page and write a descriptive title and comment for what you are doing. This will help me decide whether your proposed changes are a good idea.
  7. If this is your only change, select the "Create a new branch..." option from the selections to create a pull request. Otherwise, you can chain changes to multiple files together into a single request by committing directly to the develop branch (the default option).
  8. Hit the Commit changes button.
  9. If you did not choose to create a pull request immediately, and have made all the changes you want to make for now, go back to the front page of your repository, and you will see a green button indicating that there are changes in your develop branch. It says "Compare & pull request". Use this button so create a pull request of one or more commits and suggest their changes for inclusion in the main repository.
  10. If everything went well, you can now check that you did not break anything by following the automated build and tests at https://travis-ci.org/eressea/server/pull_requests, and wait for me to apply your changes, eventually.
  11. Congratulations! You are now an open source contributor!
Clone this wiki locally