File tree Expand file tree Collapse file tree 1 file changed +39
-0
lines changed Expand file tree Collapse file tree 1 file changed +39
-0
lines changed Original file line number Diff line number Diff line change
1
+ # Introduction
2
+
3
+ This is the MediaCT coding standard for Magento 2 projects. It is a mix of the
4
+ default MediaCT coding standard and the Magento marketplace standard.
5
+
6
+ Some tests have been removed from both of the standards to create a workable
7
+ and fast standard.
8
+
9
+ # Installation
10
+
11
+ Use composer to require the standard in a project.
12
+
13
+ ``` shell
14
+ $ composer require --dev mediact/coding-standard-magento2
15
+ ```
16
+
17
+ To let PHPCS know that this standard should be used add a phpcs.xml file in the
18
+ root of the project.
19
+
20
+ ``` xml
21
+ <?xml version =" 1.0" ?>
22
+ <ruleset >
23
+ <rule ref =" ./vendor/mediact/coding-standard-magento2/src/MediactMagento2" />
24
+ </ruleset >
25
+ ```
26
+
27
+ # Integration with PHPStorm
28
+
29
+ When the phpcs.xml file exists it will be automatically configured by
30
+ ` media/coding-standard-phpstorm ` . This is triggered by the composer command.
31
+
32
+ ``` shell
33
+ $ composer install
34
+ ```
35
+
36
+ # Contribution guidelines
37
+
38
+ Contributions are welcome. Please create pull requests which add or remove
39
+ tests.
You can’t perform that action at this time.
0 commit comments