Skip to content

Commit ea0efeb

Browse files
author
Ashoka de Wit
committed
Add readme
1 parent 5d2a4d8 commit ea0efeb

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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.

0 commit comments

Comments
 (0)