Skip to content

Commit 1deb130

Browse files
authored
Merge pull request #136 from lenaorobei/master
Magento Coding Standard Versioning Strategy
2 parents 587f1c0 + ede2e4c commit 1deb130

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Magento Coding Standard Versioning
2+
The purpose of this document is the defining versioning strategy for [Magento Coding Standard](https://github.com/magento/magento-coding-standard).
3+
4+
## Release Line
5+
One release line will be supported based on incremental approach despite introduced changes (new rules, bug fixes, etc).
6+
General overview scheme:
7+
8+
```
9+
3 - 4 - 5 - ... - 42 - ... - N
10+
11+
```
12+
13+
Single number sequence-based version identifier will be incremented every release.
14+
15+
Once new release happens it automatically means that all users (core developers, community contributors, system integrators and extension developers) need to follow the latest version.
16+
17+
**Only the latest version** will be supported.
18+
19+
## Dependency
20+
Since we want all users (core developers, community contributors, system integrators and extension developers) to follow the latest version of Coding Standard, the dependency should be `"*"`.
21+
```
22+
"require-dev": {
23+
...
24+
"magento/magento-coding-standard": "*",
25+
...
26+
}
27+
```
28+
29+
## Side Effects
30+
- No `patch` or `minor` dependency will be possible, so any change may lead to build (code check) failure.
31+
- If released Magento package will contain `"*"` dependency any update may lead to build (code check) failure.
32+
33+
## Marketplace Notifications
34+
- Developers on Marketplace will be notified prior EQP will update the version for PHPCodeSniffer check.
35+
- Developers on Marketplace will see in the report what version was used during the check.
36+
- Extension will be rejected in case it does not follow the latest Coding Standard version.

0 commit comments

Comments
 (0)