-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOK] Adds information regarding contributing
- Loading branch information
Showing
2 changed files
with
42 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -59,3 +59,4 @@ Table of Contents | |
User/Index | ||
Changelog/Index | ||
Faq/Index | ||
Contribute/Index |