mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-10-05 14:46:55 +01:00
Address second round of Jesper Schulz-Wedde's review on PR #157
- log-writes-must-survive-rollback.good.al: fixed invalid trigger OnRun(var Rec: ...) declaration; Rec is implicit when TableNo is set. - exposed-objects-must-be-in-a-permission-set.md: distinguished the three exposure mechanisms (page/query web service or API, codeunit published as a web service, [ServiceEnabled] bound action on a page) and their actual permission targets (page/query "..." = X vs codeunit "..." = X). - code-must-not-change-workdate.md: scoped from an absolute "never" to "not as a side effect of unrelated logic" - verified real WorkDate(x) setter usage in BCApps demo-data generators and test codeunits. - bcpt-scenarios-must-be-app-specific.md: SingleInstance and StartScenario/EndScenario reframed as context-dependent patterns, not mandatory requirements - BCPT Create Customer uses neither. - test-feature-scenario-tags.good.al/.bad.al: replaced the invented LibrarySales.CreateCustomerWithPrice/"Item Price Mgt." calls with a real, verified price-list-line test using Library - Sales/Library - Inventory/ Library - Price Calculation. - page-design-must-match-bc-page-type-conventions.md: scoped the missing UsageCategory anti-pattern to pages intended as searchable entry points. - defensive-vs-offensive-code-must-match-blast-radius.md/.good.al/.bad.al: replaced the VAT registration number "low blast radius" example with a genuinely cosmetic field (customer home page URL). - source-organized-by-feature-not-object-type.md: anti-pattern reframed as inconsistency with a repo's own convention, not the object-type scheme itself. - pictures-must-use-media-not-blob.md: removed leftover "image variants" wording contradicting the already-corrected MediaSet description. Proactively fixed while sweeping all fixtures for invented APIs: - given-blocks-must-cover-full-precondition-chain.bad.al: PostSalesOrder called with wrong arity and referenced an undeclared variable. - ui-test-codeunit-naming.good.al/.bad.al: replaced the same fake "Item Price Mgt."/TestPage "Item Price" with real Library - Sales calls and the real Customer Card TestPage. Worklist completeness: added review-skill cues for the 12 of 18 new rules that had none (al-appsource-review.md, al-data-modeling-review.md, al-error-handling-review.md, al-security-review.md, al-style-review.md x3, al-testing-review.md x2, al-ui-review.md, al-upgrade-review.md, al-web-services-review.md), and fixed test-feature-scenario-tags' cue, which only matched the compliant (tagged) shape instead of the anti-pattern (untagged/generic-named test). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
parent
0120b874b2
commit
3842ef7138
26 changed files with 219 additions and 89 deletions
|
|
@ -28,9 +28,21 @@ Each feature folder holds every object type it needs; shared code has one dedica
|
|||
|
||||
## Anti Pattern
|
||||
|
||||
A repository that documents or has established feature-based organization
|
||||
as its convention, but then mixes in object-type folders for new work
|
||||
anyway:
|
||||
|
||||
src/
|
||||
├── Tables/
|
||||
├── Pages/
|
||||
├── Sales/
|
||||
│ └── Invoice/
|
||||
├── Tables/ <- new objects land here instead of a feature folder
|
||||
└── Codeunits/
|
||||
|
||||
Finding everything related to one feature now requires searching multiple folders and mentally reassembling it from scattered pieces.
|
||||
The anti-pattern is inconsistency with the project's own chosen convention,
|
||||
not the object-type scheme itself — a repository that deliberately and
|
||||
consistently organizes by object type throughout is exercising the other
|
||||
reasonable choice described above, not violating this rule. What actually
|
||||
costs a reader time is a codebase where some features live under their own
|
||||
folder and others are scattered across type folders, so finding everything
|
||||
related to one feature means checking both schemes and reassembling it from
|
||||
wherever each object happened to land.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue