Links

TER:https://typo3.org/extensions/repository/view/restdoc Bug Tracker:https://forge.typo3.org/projects/extension-restdoc/issues Release Notes:https://forge.typo3.org/projects/extension-restdoc/wiki Git Repository:https://git.typo3.org/TYPO3CMS/Extensions/restdoc.git Translation:https://translation.typo3.org/projects/TYPO3.ext.restdoc/ Contact:@xperseguers

How to contribute

This extension is using the same contribution workflow as for TYPO3 Core, using https://review.typo3.org for the review process. Please read more about the workflow in the TYPO3 wiki.

tl;dr

cd /path/to/site/typo3conf/ext/

# Replace TER version with a git clone (or use symbolic link if you prefer)
rm -rf restdoc
git clone https://git.typo3.org/TYPO3CMS/Extensions/restdoc.git
cd restdoc

# Setup your environment
git config user.name "Your Name"
git config user.email "your-email@example.com"
git config branch.autosetuprebase remote
# TODO: replace "xperseguers" with your own typo3.org username
git config url."ssh://xperseguers@review.typo3.org:29418".pushInsteadOf https://git.typo3.org

# Install commit hook (if this fails, please read "New to Gerrit?" below)
# TODO: replace "xperseguers" with your own typo3.org username
scp -p -P 29418 xperseguers@review.typo3.org:hooks/commit-msg .git/hooks/

You may now change, enhance and/or fix whatever you want, then submit your patch:

cd /path/to/site/typo3conf/ext/restdoc
# Stage changes for commit (don't add everything blindly of course!)
git add .
# Commit (or amend using "git commit --amend" if enhancing an existing patch)
git commit
# Send patch for review
git push origin HEAD:refs/for/master

New to Gerrit?

You may need to configure your Gerrit SSH key in order to push your patches.

1. Open https://review.typo3.org and authenticate with your typo3.org username.
2. Go to Settings ‣ SSH public keys and add your SSH public key.

Please refer to https://wiki.typo3.org/Contribution_Walkthrough_Environment_Setup if you have problems.

Contribution rules

• There must be a ticket in the project’s bug tracker explaining the problem / the suggested enhancement
• PSR-2 coding guidelines are enforced
• Commit message complies to the format used by TYPO3 (the “releases:” line is useless here)
• Unique logical change per patch [1]

Footnotes

[1]	The term “patch” is used in the sense of “patch set” in Gerrit, and may be the result of multiple (amended) commits.