.. include:: ../Includes.txt .. highlight:: rst .. _work-with-github: .. _useful-links: ======================= How to Work With GitHub ======================= .. _github-find-a-repository: How to Find a GitHub Repository =============================== The source for every manual on docs.typo3.org (for example this manual :ref:`start` or :ref:`t3coreapi:start`) 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: .. image:: ../images/github-repo-search.png :class: with-shadow Alternatively, on any rendered page on docs.typo3.org (for example, this page), you can open :guilabel:`"Related Links"` on the bottom of the menu and click on :guilabel:`"Repository"`. .. image:: ../images/related-links-repository.png :class: with-shadow .. _github-get-notifications: Get Notifications From GitHub ============================= You can get notifications for activity in a repository (e.g. new pull requests or issues) by **watching** the repository: #. Find the repository you would like to watch, see :ref:`github-find-a-repository` For example, go to the repository for `TYPO3 Explained `__ #. Click on the **Watch** button on the top of the page .. image:: ../images/watch-repo.gif :class: with-shadow .. _links-github-issues: 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: * `Issues for this guide "Writing Documentation" `__ * `Issues for "Getting Started Tutorial" `__ Find Issues for a Specific Manual --------------------------------- From docs.typo3.org: To find the issues for a specific manual click on :guilabel:`Related Links` (on the bottom left of any page of the manual) and then :guilabel:`Issues`. .. image:: ../images/related-links-issues.png :class: with-shadow From the repository on GitHub: If you have already located the repository on GitHub, you can find the Issues by clicking on the :guilabel:`Issues` tab: .. image:: ../images/github-issues.png :class: with-shadow From the list of repositories in `TYPO3-Documentation `__: Look for the exclamation mark (!) issues icon: .. image:: ../images/github-list-issues.png :class: with-shadow .. _github-good-first-issue: .. _useful-links-for-contributors: Links to GitHub issues ---------------------- Here are some links to GitHub issues in `TYPO3-Documentation `__. .. important:: GitHub will show a 404 page if you are not logged in following these links! So, remember to log in first! For new contributors: * `Good first issues `__ (Link to GitHub) For contributors: * `All open, unassigned issues (without team, theme etc.) `__ (Link to GitHub) For team members and advanced contributors: * `All open issues `__ (Link to GitHub) * `All open, unassigned issues `__ (Link to GitHub) The Docker image for rendering is in the organization **t3docs** (instead of TYPO3-Documentation): * `All open issues in t3docs `__ (Link to GitHub) .. _github-solve-issue: 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: .. code-block:: none 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. .. seealso:: :ref:`general-conventions-commit-messages` .. _github-pull-requests: 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**: * `Open pull requests `__ (Link to GitHub) In **t3docs** (Docker image): * `Open pull requests `__ (Link to GitHub) About reviewing pull requests, you can look in the GitHub help pages: .. seealso:: * `About pull request reviews `__ (GitHub) * `Commenting on a pull request `__ (GitHub) .. tip:: If you are reviewing a pull request and want to leave comments, make sure to `mark the line `__ in the PR.