How to Work With GitHub

How to Find a GitHub Repository

The source for every manual on docs.typo3.org (for example this manual Writing Documentation or TYPO3 Explained) is contained in a GitHub repository.

In the repository, you can find the source files, but also the issues and pull requests.

The repositories of the official manuals are all included in the organization TYPO3-Documentation.

There, you can browse through the repositories or search for a specific repository:

../_images/github-repo-search.png

Alternatively, on any rendered page on docs.typo3.org (for example, this page), you can open “Related Links” on the bottom of the menu and click on “Repository”.

../_images/related-links-repository.png

Get Notifications From GitHub

You can get notifications for activity in a repository (e.g. new pull requests or issues) by watching the repository:

  1. Find the repository you would like to watch, see How to Find a GitHub Repository For example, go to the repository for TYPO3 Explained
  2. Click on the Watch button on the top of the page
../_images/watch-repo.gif

Find Issues

Pick an issue for a topic you are familiar with and try to fix it. Some of the issues address a problem, some are enhancements where new text needs to be written.

You can look at the open issues of a manual you are familiar with, pick one and fix the problem.

For example:

Find Issues for a Specific Manual

From docs.typo3.org:

To find the issues for a specific manual click on Related Links (on the bottom left of any page of the manual) and then Issues.

../_images/related-links-issues.png
From the repository on GitHub:

If you have already located the repository on GitHub, you can find the Issues by clicking on the Issues tab:

../_images/github-issues.png
From the list of repositories in TYPO3-Documentation:

Look for the exclamantion mark (!) issues icon:

../_images/github-list-issues.png

Solve an Issue

When you solve an existing issue from GitHub, it is good practice to refer to it in the commit message.

For example, write:

Resolves: #12

This will automatically close the issue and a link to the issue is displayed in the commit message and pull request on GitHub.

See also

Commit Messages

Find Pull Requests

Important

GitHub will show a 404 page if you are not logged in following these links! So, remember to log in first!

Anyone is welcome to review open pull requests!

In TYPO3-Documentation:

In t3docs (Docker image):

About reviewing pull requests, you can look in the GitHub help pages:

Tip

If you are reviewing a pull request and want to leave comments, make sure to mark the line in the PR.