Added project architecture sniffer docs #3014
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
profuel
reviewed
Jan 7, 2025
| Existing projects and demo-shops may contain rule violations. | ||
| The decision to refactor existing violations may be at the discretion of each project individually. | ||
| It is recommended to approach this in a differentiated manner. | ||
| To integrate rules into the project immediately, there recommended to generate a [baseline](https://phpmd.org/documentation/#baseline) and move forward. |
There was a problem hiding this comment.
Suggested change
| To integrate rules into the project immediately, there recommended to generate a [baseline](https://phpmd.org/documentation/#baseline) and move forward. | |
| To integrate rules into the project immediately, generate a [baseline](https://phpmd.org/documentation/#baseline) and move forward, developing only violations free code. | |
| We still recommend to review violations and plan refactoring for the most important ones. | |
| Also make sure to explain developers how to fix violations from the baseline: | |
| 1. Fix violation in the code. | |
| 2. Remove fixed error from the baseline. |
| The decision to refactor existing violations may be at the discretion of each project individually. | ||
| It is recommended to approach this in a differentiated manner. | ||
| To integrate rules into the project immediately, there recommended to generate a [baseline](https://phpmd.org/documentation/#baseline) and move forward. | ||
| It is also permissible to [suppress rules](https://phpmd.org/documentation/suppress-warnings.html) on a case-by-case basis. |
There was a problem hiding this comment.
Suggested change
| It is also permissible to [suppress rules](https://phpmd.org/documentation/suppress-warnings.html) on a case-by-case basis. | |
| It is also permissible to [suppress rules](https://phpmd.org/documentation/suppress-warnings.html) on a case-by-case basis. Although we strongly recommend to use baseline, since ignoring violations may hide consequential violations as well. |
|
|
||
| {% info_block infoBox %} | ||
|
|
||
| Spryker demo shops may contain violations when analyzed with the Architecture Sniffer, as the tool includes more specific rules by default. |
There was a problem hiding this comment.
Suggested change
| Spryker demo shops may contain violations when analyzed with the Architecture Sniffer, as the tool includes more specific rules by default. | |
| Spryker demo shops may contain violations when analyzed with the Architecture Sniffer, as the tool includes more project specific rules by default. |
There was a problem hiding this comment.
Honestly, I'd check demoshops and either push baseline with it, or fix violations.
We should aim for perfection and hassle free development by our customers.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR labels
When the PR is ready for review, add a TW review needed label. This lets us keep track of PRs that need to be merged and merge them in time.
PR Description
Describe the context for your changes and the changes you've made.
Tickets
If changes are associated with a ticket, add a docs ticket here.
Checklist