Skip to content

Commit

Permalink
[DOK] Adds information regarding contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
buepro committed Apr 25, 2019
1 parent c145bbd commit 353ac38
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 0 deletions.
41 changes: 41 additions & 0 deletions Documentation/Contribute/Index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
.. include:: ../Includes.txt


.. _contribute:

==========
Contribute
==========

To keep the quality development respects the guidelines established by TYPO3 found in the `Core API Reference
<https://docs.typo3.org/typo3cms/CoreApiReference/>`__.

Prefixes
========

The following prefixes are used:

====== ====================== =========================================================================================
Prefix Meaning Description
====== ====================== =========================================================================================
pp Pizpalue Base prefix
ppc Pizpalue complement Mainly used for classes complementing other classes.
ce Content element Used in conjunction with content elements
====== ====================== =========================================================================================

Examples
--------

**SCSS**

.. code-block:: css
pp-demo-item {
border: blue 1px solid;
&.ppc-right {
border-right: green 3px solid;
}
}
In the above example the class :css:`ppc-right` complements the class :css:`pp-demo-item`. The complementing classes
help to be more specific and less exhaustive (alternatively to :css:`ppc-right` one might have used
:css:`pp-demo-item-right`). They should only be used in the context of other classes.
1 change: 1 addition & 0 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,3 +59,4 @@ Table of Contents
User/Index
Changelog/Index
Faq/Index
Contribute/Index

0 comments on commit 353ac38

Please sign in to comment.