• TYPO3 Contribution Guide - Core Development
    1.0

INTRODUCTION

  • About This Guide
    • How this guide is structured
    • What’s New in This Guide
    • Other ways to contribute
    • Contribute to this Guide
  • Help & Community
    • Slack
    • Events
      • TYPO3 GmbH Review Friday
      • Code Sprints
      • TYPO3 Developer Days
  • TYPO3 Contribution Explained
    • Regular Workflow
    • TYPO3 Contribution Workflow
  • Introduction to Forger

SETUP

  • Setting up Your Accounts
    • Signup for a TYPO3.org Account
    • Setting up Gerrit (ssh)
    • Slack
      • Register for Slack account
      • Join #typo3-cms-coredev channel
      • More information
  • Prerequisites and Useful Tools
    • Composer
    • Setting up Your Frontend Build Toolchain.
      • Yarn
        • Install on MacOS
        • Installer for Windows and MacOS
        • Linux
        • Install all Required Packages
    • Grunt
  • Setup the TYPO3 installation
    • git clone
    • Git GUIs
    • composer install
    • yarn install
      • yarn tasks
    • Setting up a Working TYPO3 Installation
  • Git Setup
    • Prerequisites
    • Set Username and Email
    • Set autosetuprebase
    • Install Your Commit Hooks
      • commit-msg Hook
      • pre-commit Hook
      • Alternative: Setup With Composer
    • Setting up Your Remote
    • Setting up a Commit Message Template
    • Show Configuration
    • Other resources
  • Setup your IDE
    • Coding Guidelines

HOWTOS

  • Report an Issue
    • Introduction to Forge
    • Searching for Existing Issues
    • Identify the Issue
    • Create an issue
      • Tracker
      • Subject
      • Description
      • Category
      • TYPO3 version
      • PHP Version
      • (optional) Files
    • Best practices for writing a good bug report
    • Hints for formatting in Redmine
      • Images
      • Code formatting
      • External Links
    • Additional Resources
  • Create a Patch
    • Step by Step Walkthrough
    • Helpful links
    • Next Steps
  • Add Documentation
    • Changelog
      • reST File Generator
      • Types of Changes
        • Breaking Changes
        • Deprecations
        • Features
        • Important Information
      • Check Your rst File
      • Render the Changelog
    • Policy for Changing the Main Documentation
    • Document System Extensions
    • More Information
  • Run Tests
    • Practical Considerations
    • How to Run the Tests
    • Run Tests with runTests.sh using docker
      • Prerequisites
      • Examples
        • Show help
        • Run all unit tests
        • Run unit tests with xdebug (uses default port 9000)
        • Run specific unit tests with xdebug
        • Run functional tests
        • Run functional tests with PostgreSQL
        • Run acceptance tests
      • Additional hints
      • Troubleshooting
      • Results
    • Run tests directly without docker
      • Run all unit tests
      • Run specific unit tests
      • Run all functional tests
      • Check for Coding Guidelines
    • More information
  • Debug TYPO3
    • Debugging With PhpStorm and Xdebug
      • php.ini
      • Install Plugin
      • PhpStorm
    • More Information
  • Handle and Improve a Patch (Gerrit)
    • Introduction to Gerrit
      • Overview of the UI
    • Find a review on Gerrit
      • Forger
      • Email notification
      • Gerrit: Your Changes
      • Gerrit: Open Changes
      • Gerrit: Search
      • Forge
    • Cherry-pick a patch
    • Cleanup tasks
      • Cleanup git repository
      • Cleanup TYPO3 installation
    • Upload a new Patch Set
    • Rebase
      • What is rebase?
      • When should you rebase?
      • How do you rebase?
        • Method 1: Use Rebase button on Gerrit
        • Method 2: git pull –rebase
    • Resolve Merge conflicts
      • What are merge conflicts?
        • Example
      • How to see merge conflicts in Gerrit or Forger
      • How to resolve conflicts?
        • Identify files with conflicts
        • Identify files with conflicts (cherry-pick)
        • Resolve the conflicts
        • Resume command
          • Resume git rebase
          • Resume git cherry-pick
    • Review a patch
      • Code Review
      • Test a patch
      • Comment files
      • Vote
        • Policy for votes
        • Low brainers
        • Practical considerations
    • Backport a change to other branches
      • Use Gerrit for the cherry-pick
      • Manual backport
    • Revert patches
  • Issue Workflow (Forge)
    • Target Versions
    • Status

OTHER

  • Git Cheat Sheet
    • git clone
    • Setup
    • Workflow - common commands
    • Workflow - work in progress
    • Workflow -other branches
    • Workflow - commit msg
    • Workflow - Undoing / fixing things
    • References
  • Troubleshooting
    • Git Troubleshooting
      • Permission Denied
      • Debugging the SSH Connection
      • Push: invalid committer
      • You are not a committer
      • Missing Change-Id in commit message
      • Push: prohibited by gerrit
      • Push: Invalid Key Format
      • Pushing old Patch Set again
  • Appendix
    • OS X help
      • Working with Git Tower
        • Enabling Extended Gerrit Support in Tower
        • Pushing to Gerrit
      • COMPOSER install on OSX
      • GRUNT install on OSX
      • Yarn install on OSX
      • Creating a SSH Public Key on OSX
    • Microsoft Windows help
      • Cloning with SourceTree on Windows
        • SourceTree General Setup
          • Prerequisites
          • Installation
          • Basic Settings
          • Clone
          • Automatic links to Forge and Gerrit
        • Reviewing and testing patches
          • Update the repository
          • Cherry-picking
        • Creating patches
          • Commit hook
          • Setup for pushing to Gerrit
          • Create a branch
          • Send the patch to Gerrit
          • Cleaning up
      • Working with Git for Windows
        • Installation
        • Configuration
          • Initial clone
          • Setting the SSH key in TortoiseGit
          • Commit hook
          • Push to Gerrit
          • Links to bugtracker
        • Review walkthrough
          • Update the repository
          • Create a branch
          • Cherry-picking
          • Cleaning up
        • Starting a new patch
        • Send the patch to Gerrit
      • Creating a SSH Public Key on Windows
        • Generate Your Keys With Putty
        • Use Pageant to Load Your Pivate Key on Startup
      • Troubleshooting for Windows
        • SSH
          • Permission denied (publickey)
            • Checklist for ssh problems
    • Linux/Unix help
      • Creating a SSH Public Key on Unix/Linux
      • Setting up TYPO3 manually under Linux
        • Prerequisites
        • Setup
          • Apache Webserver
          • PHP 7.2
          • MySQL Server
          • ImageMagick
          • Create a basic site for your installation
          • Create a domain in your /etc/hosts
        • Next step
    • Aliases & Git Aliases
      • Aliases
        • Sample List of Aliases
      • Git Aliases
        • Sample Git Aliases (Commands)
        • Sample Git Aliases (.gitconfig)
      • Additional Information
        • General
        • Linux
        • MacOS
    • Coding Guidelines
      • PHP
      • JavaScript
      • TypeScript
      • Xliff files
    • cglFixMyCommit
      • Linux and MacOS
      • Windows
    • Commit Hooks
      • commit-msg Hook
      • pre-commit Hook
      • Post-checkout hook for composer install
    • Commit Message rules for TYPO3 CMS
      • Summary line (first line)
        • Deprecations
        • Some examples of topic descriptions
      • Description (Message body)
        • Relationships
      • Reverting patches
      • Commit Template
      • Bad summary lines examples vs. good examples
    • Composer
      • About Composer
      • Install Composer
      • Composer Commands
      • Custom TYPO3 Composer Commands
    • How to deprecate classes, methods, arguments and hooks in the TYPO3 core
      • Deprecate a class
      • Deprecate method
      • Deprecate method arguments
      • Deprecate a hook
      • Deprecate methods still called by the TYPO3 Core
    • PhpStorm: Gerrit Plugin
    • PhpStorm: Setup
      • Conventions on this page
      • General setup
      • Coding Guidelines
        • EditorConfig
        • PHP files
        • More information
      • Plugins for PhpStorm
        • Install plugins in PhpStorm
        • Recommended Plugins
        • Optional Plugins
      • Setting up PhpStorm for the Testing Framework
      • Other Resources
    • Setting up TYPO3 with DDEV
      • Setting up the prerequisites
      • Clone TYPO3
      • Configure DDEV
      • Start DDEV
      • Install dependencies via composer
      • Check for database credentials
      • FIRST_INSTALL
      • Setup your TYPO3 installation
      • Additional setup
      • Shutdown DDEV
      • Resources
        • Slack channels
        • DDEV documentation
    • Setting up TYPO3 manually
      • Prerequisites
      • Clone TYPO3
      • Create the database
      • Create FIRST_INSTALL
      • Continue …
    • Slack
      • Slack channels
        • Botty on Slack
    • Information for editing this guide
      • General information
      • Resources for this guide
      • Best practices for editing this guide
        • Images
          • Hints for creating images
          • Hints for adding images
  • Sitemap
 
TYPO3 Contribution Guide - Core Development
  • Docs »
  • Appendix
  • Edit me on GitHub
Next Previous

Appendix¶

The appendix contains some additional information that covers topics in more depth than what is already described in the main section.

  • OS X help
    • Working with Git Tower
    • COMPOSER install on OSX
    • GRUNT install on OSX
    • Yarn install on OSX
    • Creating a SSH Public Key on OSX
  • Microsoft Windows help
    • Cloning with SourceTree on Windows
    • Working with Git for Windows
    • Creating a SSH Public Key on Windows
    • Troubleshooting for Windows
  • Linux/Unix help
    • Creating a SSH Public Key on Unix/Linux
    • Setting up TYPO3 manually under Linux
  • Aliases & Git Aliases
  • Coding Guidelines
  • cglFixMyCommit
  • Commit Hooks
  • Commit Message rules for TYPO3 CMS
  • Composer
  • How to deprecate classes, methods, arguments and hooks in the TYPO3 core
  • PhpStorm: Gerrit Plugin
  • PhpStorm: Setup
  • Setting up TYPO3 with DDEV
  • Setting up TYPO3 manually
  • Slack
  • Information for editing this guide
Next Previous

View page source

© Copyright since 2000 by TYPO3 Association

Last rendered on Sep 30, 2019 08:36

Built with Sphinx and t3SphinxThemeRtd. Report theme issues here.

Legal Info

Versions
Project
Contact
Issues
Repository
Downloads
Related Links v: 1.0