« Previous - Version 3/5 (diff) - Next » - Current version
Andy Grunwald, 2012-07-02 16:53


Activate a new sniff in ci.typo3.org

This is a short tutorial which requirements must be reached to activate a new sniff in http://ci.typo3.org

  1. All violations of the chosen sniff must be fixed in master branch (inluding master branches of submodules)
  2. The chosen sniff must be a) part of the offical cgl or b) prevent PHP (strict)-warnings and check about the correct usage of PHP keywords (likes self::, final, ...)
  3. A ticket in Forge-Project ci.typo3.org must be created for each sniff
  4. A post on the Core mailinlist must be created, to inform other developers about the activation of the chosen sniff after 24 hours. It is recommend to use the template
    TYPO3-CI: Activation of a new CGL-Sniff "###SNIFF-NAME###" in ci.typo3.org
    ==============================================
    Hi,
    
    after cleaning up the TYPO3 core + system extensions i will enable the CGL-Sniff "###SNIFF-NAME###" at ci.typo3.org tomorrow.
    
    This will fix "#TASK-NUMBER ###TICKET-HEADLINE###" [1].
    In the wiki of PHP_CodeSniffer you can find a code example. [2]
    
    It is necessary to rebase your local branch to current master before pushing a new patch set to gerrit to avoid breaking the build and make Mr. Jenkins happy.
    If you got any reasons against the activation please let us know.
    Thanks for everyone who contributed to this!
    
    Regards,
    ###YOUR-NAME###
    
    [1] ###TICKET-LINK###
    [2] http://forge.typo3.org/projects/team-php_codesniffer/wiki/TYPO3v4_Sniffs_with_code_examples###CODE-EXAMPLE###
    
  5. If no one reached his hand and mentioned a good reason against activating this sniff, it is possible to activate this in Jenkins