Skip to content

Latest commit

 

History

History
34 lines (26 loc) · 1.41 KB

CONTRIBUTING.md

File metadata and controls

34 lines (26 loc) · 1.41 KB
Raw

Contributing to Contao

The following is a set of guidelines for contributing to Contao and its packages, which are hosted in the Contao organization on GitHub. These are just guidelines, not rules, use your best judgement and feel free to propose changes to this document in a pull request.

Submitting issues

  • Use the search function to see if a similar issue has already been submitted.
  • Describe the issue in detail and include all the steps to follow in order to reproduce the bug in the online demo.
  • Include the version of Contao and PHP you are using.
  • Include screenshots if possible; they are immensely helpful.
  • If you are reporting a bug, please include any related error message you are seeing and also check the var/logs/ directory for related log files.

Pull requests

  • Follow the Contao coding standards.
  • For new features, create your pull request against the master branch.
  • For bug fixes, create your pull request against the lowest affected branch, e.g. 4.4 if the bug is in Contao 4.4 or 4.5 if the bug is in Contao 4.5.
  • Include screenshots in your pull request whenever possible.

Git commit messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to …" not "Moves cursor to …").
  • Reference issues and pull requests liberally.