You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/codestyle.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,16 +4,16 @@ sidebar_position: 5
4
4
Coding Style Guide
5
5
=======================
6
6
7
-
Since Joomla version 4.2 Joomla is using the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standard. You can enable the coding standard in your IDE to get hints when you're violating the rules or can use an auto fix, too.
8
-
We recommend that you follow this standard also when developing your own extensions to stay compatible always with core and that you don't have to switch when working with core.
7
+
Since Joomla version 4.2, Joomla uses the [PSR-12](https://www.php-fig.org/psr/psr-12/) coding standard. You can enable this coding standard in your IDE and get hints if you're not following the coding standard or use an auto fix, too.
8
+
We recommend that you follow this standard when developing your own extensions to stay compatible with core and to ensure your code will hopefully work with future versions.
9
9
10
10
## Install code style checker
11
11
:::caution TODO
12
12
Copy from https://docs.joomla.org/Joomla_CodeSniffer and update to the new version
13
13
:::
14
14
15
15
## Use integrated checker
16
-
The Joomla core system is shipping a so called "code sniffer" and a "code fixer" to check for code standard violations and to fix most (but sometimes not all) of them. This only works if you're using the full developer version from GitHub, not when you're working with a installation zip package.
16
+
If you download the full developer version from GitHub of Joomla (not the downloadable installation zip package), you will find a so called "code sniffer", to check for coding standard violations, and a "code fixer" to fix most (but, sometimes, not all) of them.
17
17
18
18
To run the code sniffer/fixer you need to start a terminal, navigate to your Joomla root folder (the folder where your Joomla is installed) and run one of the following commands (don't forget the "."):
- Read the [End-User documentation](https://docs.joomla.org)
@@ -26,14 +26,13 @@ the ability to get the most out of the guide as a developer.
26
26
The Joomla Developers Manual is written using Docusaurus, a system that can allow all users of Joomla to
27
27
contribute to the documentation using Markdown language.
28
28
29
-
A good place to start if new to Markdown is the Markdown Guide
29
+
A good place to start, if new to Markdown, is the Markdown Guide
30
30
https://www.markdownguide.org/
31
31
32
-
The documentation is maintained via GitHub where you can anytime create/edit/delete content to improve the content
33
-
of the documentation. Click the **Edit this Page** link at the bottom of this page to contribute via a Pull Request.
32
+
The documentation is maintained via GitHub where you can at anytime create/edit/delete content to improve the documentation. Click the **Edit this Page** link at the bottom of this page to contribute via a Pull Request.
34
33
35
34
:::caution TODO
36
35
37
36
This page is unfinished, please use the **Edit this Page** link at the bottom of this page to help make it more useful.
0 commit comments