Skip to content

Commit ce91a93

Browse files
authored
Check new line around control structure (#50)
- Check new line around control structures - Add proposal doc section
1 parent a26a059 commit ce91a93

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

docs/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,13 @@
22

33
Run CS check and fixer against ShoppingFeed coding standards
44

5+
### Proposal
6+
7+
Anyone is welcome to propose new rules. To do so, create a `new_rule` issue on
8+
github : https://github.com/shoppingflux/coding-style-php/issues.
9+
Fill issue template and require Vote from every developers. If the proposition
10+
get the majoriry, it can be added to existing rules.
11+
512
### Installation
613

714
```
@@ -52,4 +59,4 @@ Here are the steps you have to follow :
5259
- invite people to vote (all members of the team)
5360
2. If approved by a simple majority, you’ll need to propose a new PR on this same repository, one that :
5461
- updates the readme file with the voted proposition
55-
- enforces it in the validation rules used by our different tools that make-up our continuous integration pipeline (such as the code sniffer) - this second step is optional
62+
- enforces it in the validation rules used by our different tools that make-up our continuous integration pipeline (such as the code sniffer) - this second step is optional

phpcs/ruleset.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@
124124
<config name="installed_paths" value="../../slevomat/coding-standard"/>
125125
<rule ref="SlevomatCodingStandard.Commenting.RequireOneLinePropertyDocComment.MultiLinePropertyComment"/>
126126
<rule ref="SlevomatCodingStandard.Commenting.UselessFunctionDocComment.UselessDocComment"/>
127+
<rule ref="SlevomatCodingStandard.ControlStructures.BlockControlStructureSpacing"/>
127128
<rule ref="SlevomatCodingStandard.ControlStructures.JumpStatementsSpacing"/>
128129
<rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
129130
<rule ref="SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly"/>

readme.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ Once connected to the container you can :
1818
- Update composer dependencies : `composer update`
1919
- Run test : `composer test`
2020

21+
### Proposal process
22+
23+
See [proposal](docs/index.md#proposal)
24+
2125
### Documentation
2226

2327
Documentation is driven by [mkdocs](https://www.mkdocs.org/) and uses [material theme](https://squidfunk.github.io/mkdocs-material/)

0 commit comments

Comments
 (0)