Workflow #1: “Edit on GitHub”

  1. Create a GitHub account:

    Visit Join GitHub and create your account.

    Though not mandatory, the general convention in the TYPO3 community is to set your GitHub name (not username) as your full name.

  2. Find a page that needs improving:

    For example, you may have found a misspelling in the Getting Started or you want to add some new content to the Upgrading TYPO3.

  3. Edit the page on GitHub:

    At the top right of every page you will find an icon that says “Edit me on Github”. Selecting this link will take you to that pages repository on GitHub.

    ../_images/edit_me_on_github.png
  4. Fork the repository:

    Click on the green button to fork the repository. This will clone the repository into your GitHub account, ready for you to make your changes in your browser.

    ../_images/github-edit-fork.png
  5. Make your changes:

    You will be presented with a window where you can make your changes. The “Indent mode: Spaces” and “Indent size: 3” values should already be set - do not alter these.

    ../_images/github-edit-window.png
  6. Working with reST files:

    Every page you edit is written in reST format, when it comes to making minor amendments no prior knowledge of editing .rst files is required. However, when you are ready to make more advanced changes, you can learn more about working with reST here.

  7. Preview your changes:

    Select “Preview changes” to see what your changes will look like once they are published.

    You can go back and make further changes at any time, select the Edit file tab to continue editing.

    ../_images/github-edit-preview.png
  8. Finalize your changes:

    When you are ready, scroll down to the bottom of the page. Add a short (but meaningful) description that outlines the changes you have made and click “Propose file change”

    ../_images/github-propose-file-changes.png
  9. Create pull request:

    GitHub will show you an overview of your changes. If you are happy with them, select “Create pull request”.

    ../_images/github-comparing-changes.png

    Finally, create your pull request:

    ../_images/github-create-pull-request2.png
  10. You’re done!

    Your change will now be reviewed. A reviewer might suggest additional changes. Monitor your notifications (email) from GitHub. If at any point, you are not sure what to do, don’t hesitate to ask for help. When your pull request is accepted, it will be merged. You will receive a notification email as soon as this happens.

Congratulations! You are now a contributor. Welcome and thank you!

After a short period your changes will be automatically rendered, reload the page and your changes will be visible to everyone.

Next month, your name will be listed in the “Developer Appreciation Day” (DAD) page on the TYPO3 Blog.

See June 2018: Developer Appreciation Day for an example.

../_images/dad-with-image.png

Scroll down to “Improving documentation”:

../_images/dad-improve-docs.png

Next Steps