NEXT-23389 - Mapping software area

Author: shyim

adr/workflow/2022-09-28-mapping-of-product-area.md

@@ -0,0 +1,30 @@
+# 2022-09-28 - Mapping of Product Area
+
+## Context
+
+We have a lot of teams working on different parts of the Shopware 6 platform.
+We want to have a clear mapping of the teams to the source code, so that we can easily assign the right area to a ticket.
+This allows us also to map automatically errors reported in our SaaS application to the right area.
+
+## Decision
+
+We decided to add a `@package <area>` annotation to all files in the `src` and `tests` directory of the `platform`, `rufus` and `commercial` repository.
+This annotation will be used to map the files to the product areas.
+
+The areas are:
+
+- admin
+- storefront
+- core
+- inventory
+- checkout
+- sales-channel
+- content
+- business-ops
+- merchant-service
+- customer-order
+- system-settings
+
+## Consequences
+
+We will add a PHP-doc/JavaScript comment to any file with `@package <area>`

ecs.php

@@ -1,5 +1,6 @@
 <?php declare(strict_types=1);
 
+use PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis\AssignmentInConditionSniff;
 use PhpCsFixer\Fixer\Basic\NonPrintableCharacterFixer;
 use PhpCsFixer\Fixer\CastNotation\ModernizeTypesCastingFixer;
 use PhpCsFixer\Fixer\ClassNotation\ClassAttributesSeparationFixer;
@@ -20,8 +21,10 @@
 use PhpCsFixer\Fixer\Phpdoc\PhpdocAnnotationWithoutDotFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocIndentFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocLineSpanFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocNoPackageFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocOrderFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocSummaryFixer;
+use PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer;
 use PhpCsFixer\Fixer\Phpdoc\PhpdocTrimConsecutiveBlankLineSeparationFixer;
 use PhpCsFixer\Fixer\PhpTag\BlankLineAfterOpeningTagFixer;
 use PhpCsFixer\Fixer\PhpUnit\PhpUnitConstructFixer;
@@ -36,7 +39,6 @@
 use PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer;
 use PhpCsFixer\Fixer\Whitespace\BlankLineBeforeStatementFixer;
 use PhpCsFixer\Fixer\Whitespace\CompactNullableTypehintFixer;
-use PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer;
 use PhpCsFixerCustomFixers\Fixer\NoImportFromGlobalNamespaceFixer;
 use PhpCsFixerCustomFixers\Fixer\NoSuperfluousConcatenationFixer;
 use PhpCsFixerCustomFixers\Fixer\NoUselessCommentFixer;
@@ -49,7 +51,6 @@
 use Symplify\EasyCodingStandard\Config\ECSConfig;
 use Symplify\EasyCodingStandard\ValueObject\Option;
 use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
-use PHP_CodeSniffer\Standards\Generic\Sniffs\CodeAnalysis\AssignmentInConditionSniff;
 
 return static function (ECSConfig $ecsConfig): void {
     $ecsConfig->sets([
@@ -133,12 +134,13 @@
         // would otherwise destroy markdown in the description of a route annotation, since markdown interpreted spaces/indents
         PhpdocIndentFixer::class => [
             'src/**/*Controller.php',
-            'src/**/*Route.php'
+            'src/**/*Route.php',
         ],
         // would otherwise remove lines in the description of route annotations
         PhpdocTrimConsecutiveBlankLineSeparationFixer::class => [
             'src/**/*Controller.php',
-            'src/**/*Route.php'
+            'src/**/*Route.php',
         ],
+        PhpdocNoPackageFixer::class => null,
     ]);
 };