/t3kit

Primary LanguagePHP

#t3kit Travis Travis ###Starter kit for TYPO3 CMS. Tools, extensions, configurations and templates.

Required dependencies:


Getting started with t3kit

The best way to start working with t3kit is to use our t3kit_vagrant machine

###List of tools and extensions:

  • TBD

Contributing

Everyone can add feedback, bug reports and fixes. Here is several rules for contribute this repository. Please keep this in mind for better cooperation.

Issues

If you have a question(feature) not covered in the documentation or want to report a bug, the best way to ensure it gets addressed is to file it in the appropriate issues tracker. Please check that you've completed the following steps:

  • Make sure you're on the right version of t3kit
  • Make sure you're on the right version of submodules
  • Used the search feature to ensure that the bug hasn't been reported before
  • Included as much information about the bug as possible, including any output you've received, what OS and version you're on, etc.
  • Try to reduce your code to the bare minimum required to reproduce the issue. This makes it much easier (and much faster) to isolate and fix the issue.

Pull Requests

  • Please check to make sure that there aren't existing pull requests attempting to address the issue mentioned. We also recommend checking for issues related to the issue on the tracker, as a team member may be working on the issue in a branch or fork.
  • Non-trivial changes should be discussed in an issue first
  • Develop in a topic branch, not master
  • Follow Style Guides
  • Follow Git commit conventions
  • Write a convincing description of your PR and why we should land it

Internal Fixes t3kit team


Style Guide

This project uses special style guides. Those rules you can find on appropriate file: .editorconfig

Git commit conventions and output formatting

Please use semantic labels for your messages, but if commit message is not very important, you can skip labels. All commits with labels will be added in changelog, that's why it is important to use labels on your commits. ####Git labels:

  • [FEATURE] A new feature
  • [FIX] A bug fix
  • [DOC] Documentation
  • [STYLE] Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • [TEST] Adding missing tests
  • [CHORE] Changes to the build process or auxiliary tools, extensions and libraries

Examples:

  • '[CHORE] update submodules'
  • '[CHORE] add new Vagrant configuration'
  • '[CHORE] update TYPO3 to 7.5.0'
  • '[FIX] fix bug on image slider'
  • '[TEST] add test for subscribe form on start page'
  • '[TEST] implement CI tests'
  • '[DOC] update changelog'
  • '[DOC] add requirements info'
  • '[FEATURE] add google map'
  • '[FEATURE] add new content element'
  • 'fix link in documentation'
  • 'add new db path to vagrant config'

Please ensure any pull requests of fixes follow this closely. If you notice existing code which doesn't follow these practices, feel free to shout and we will address this.

Versioning system

  • Main development is on master branch.
  • Every release synchronized with specific release of TYPO3.
  • Every release tagged by git tag using Semantic Versioning
  • Major version should be almost always the same as on TYPO3.

When we starting new major version of t3kit previous will be moved to new branch, so in this case we can keep developing new and support old one.

Examples:

  • Branch master => last t3kit release t3kit 9.1.3 = TYPO3 9.1.0
  • Branch t3kit8 => last t3kit release t3kit 8.3.2 = TYPO3 8.7.2
  • Branch t3kit7 => last t3kit release t3kit 7.1.5 = TYPO3 7.7.1

Also in some specific cases it can be possible to use new version of TYPO3 for old version of t3kit Example:

  • Branch t3kit7 => last t3kit release t3kit 7.2.0 = TYPO3 8.7.2