Skip to content

Latest commit

 

History

History
54 lines (47 loc) · 2.09 KB

CONTRIBUTING.md

File metadata and controls

54 lines (47 loc) · 2.09 KB
Raw

Contribute

  • Be verbose about your intentions.
  • Keep the docs up to date with your changes.
  • Before creating a Feature Pull Requests please contact us, otherwise your work might be in vain!
  • Strictly follow PSR-12.
  • Use tags in commit messages. The full list can be found here: http://vxvr.de/ideas/commitmessages.html
  • Commit messages are imperative. They must make sense when read as "When applied, this commit will $COMMITMESSAGE" ( without the tag in square brackets).
  • Always include the copyright notice (see below) in new files.
  • Do not add your name to existing copyright notice if you did not add new code.

Code Quality

This project has several code quality tools configured. They are easily executed using grumphp.

  1. Install grumphp and QA deps: phive install
  2. Enable grumphp: git config core.hooksPath .project/githooks/

Copyright notice to include in all PHP files

Replace all |TAG| with the correct value

/*
 * Copyright notice
 *
 * (c) |CURRENTYEAR| in2code.de and the following authors:
 * |FIRST_NAME| |LAST_NAME| <|YOUR_EMAIL|>
 *
 * All rights reserved
 *
 * This script is part of the TYPO3 project. The TYPO3 project is
 * free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * The GNU General Public License can be found at
 * http://www.gnu.org/copyleft/gpl.html.
 *
 * This script is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This copyright notice MUST APPEAR in all copies of the script!
 */