-
Notifications
You must be signed in to change notification settings - Fork 150
Magento Coding Standard Versioning Strategy #136
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 1 commit
861a8fb
969dbb5
458aa55
e556317
8a16753
5971055
ede2e4c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| # Magento Coding Standard Versioning | ||
|
|
||
| The purpose of this document is the defining versioning strategy for [Magento Coding Standard](https://github.com/magento/magento-coding-standard). | ||
|
|
||
| ## Summary | ||
|
|
||
| Version number should be increased with taking [Semantic Versioning](https://semver.org/) into account. | ||
| Given a version number `{major}`.`{minor}`.`{patch}`, following rules MUST be applied: | ||
|
|
||
| - `{patch}` version MUST be incremented when backward compatible changes (bug fixes) were made. | ||
|
|
||
| - `{minor}` version MUST be incremented when backward compatible changes (new features) were added. | ||
|
|
||
| - `{major}` version MUST be incremented when backward incompatible changes were made. | ||
|
|
||
| ### Terminology | ||
|
|
||
| **PHP CodeSniffer OOB rule** - rule that goes out-of-box with PHP CodeSniffer, the part of its package, the part of specific Coding Standard (PSR2, Squiz, etc). | ||
|
|
||
| **Magento rule** - Magento specific rule, tah part of Magento Coding Standard, located under [Magento2/Sniffs/](https://github.com/magento/magento-coding-standard/tree/develop/Magento2/Sniffs) directory. | ||
|
|
||
| ### Versioning use cases | ||
|
|
||
| Following use cases are representing code change examples relatively to the version part that needs to be changed. | ||
|
|
||
| ### `{patch}` Release | ||
| - Bug fix to existing rule that prevents false-positive findings. | ||
| - Removing PHP CodeSniffer OOB rule from Magento Coding Standard `ruleset.xml` file. | ||
| - Removing Magento rule from MagentoCoding Standard (sniff code + `ruleset.xml`). | ||
|
||
| - Adding unit tests to existing rules. | ||
|
|
||
| ### `{minor}` Release | ||
|
||
| - Adding new OOB rule to Magento Coding Standard `ruleset.xml` file. | ||
| - Implementing new Magento rule and adding it to `ruleset.xml` file. | ||
| - Changing the behaviour of existing Magento rule (extending functionality). | ||
|
|
||
| ### `{major}` Release | ||
| - Changing platform requirements. | ||
| - Namespace changes. | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Move to
minor.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moved.