mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-06 17:36:53 +01:00
e570d6113f
Adds 55 articles (plus 76 code samples) spanning four new domains and two existing domains, extracted from the internal Business Central review-agent prompt. Content was filtered against BCQuality's remedial-knowledge premise: each article encodes BC-specific behaviour, a CodeCop rule, a platform API semantic, or an anti-false-positive guideline that a capable LLM would otherwise get wrong. New domains: - privacy (11 articles): DataClassification inheritance semantics, the StrSubstNo-defeats-Error-telemetry-classification pitfall, Privacy Notice consent for outgoing requests, anti-false-positives for pages and in-memory data. - upgrade (11 articles): upgrade-codeunit structure, upgrade-tag lifecycle and registration, protected DB reads, DataTransfer for large datasets, InitValue semantics, enum-ordinal preservation, obsolete-workflow, first-install detection. - ui (9 articles): caption capitalization by phrase type, tooltip voice, teaching-tip vs tooltip, tour-tip conventions, character limits, banned terms, ampersand handling, title punctuation. - style (11 articles): label-suffix convention, API page naming, temporary-variable prefix, label properties (Comment/Locked), named invocations, FieldCaption in user messages, OptionCaption pairing, Error-parameter passing, `this` keyword, required parentheses, file naming. Gaps in existing domains: - performance (11 articles): production-scale table catalog (no row counts, per internal-data concern), anti-false-positive for bounded tables, guard-before-Get ordering, redundant-Get-in-OnAfterGetRecord, LockTable in read-only helpers, combined ModifyAll passes, writes in OnAfterGetRecord, SetLoadFields heuristics, temporary-table regressions, FlowField source-table widening, MaintainSQLIndex disabling SIFT. - security (2 articles): environment-specific hardcoded GUIDs, ValidateTableRelation=false on user input. Intentionally excluded: specific production P95 row-count numbers (aggregated internal telemetry); rewritten as categorical guidance on which tables to treat as production-scale without publishing sizes. All articles use `bc-version: [all]` (applies to every BC version, per the new schema sentinel). Validator passes with 0 errors / 0 warnings. |
||
|---|---|---|
| .. | ||
| call-methods-from-onupgrade-triggers-not-inline-code.bad.al | ||
| call-methods-from-onupgrade-triggers-not-inline-code.good.al | ||
| call-methods-from-onupgrade-triggers-not-inline-code.md | ||
| detect-first-install-via-dataversion-zero.bad.al | ||
| detect-first-install-via-dataversion-zero.good.al | ||
| detect-first-install-via-dataversion-zero.md | ||
| do-not-make-external-calls-in-upgrade-codeunits.md | ||
| enum-changes-must-be-additive-at-the-end.bad.al | ||
| enum-changes-must-be-additive-at-the-end.good.al | ||
| enum-changes-must-be-additive-at-the-end.md | ||
| guard-every-database-read-in-upgrade-codeunits.bad.al | ||
| guard-every-database-read-in-upgrade-codeunits.good.al | ||
| guard-every-database-read-in-upgrade-codeunits.md | ||
| initvalue-does-not-populate-existing-records.bad.al | ||
| initvalue-does-not-populate-existing-records.good.al | ||
| initvalue-does-not-populate-existing-records.md | ||
| register-upgrade-tags-with-subscribers.bad.al | ||
| register-upgrade-tags-with-subscribers.good.al | ||
| register-upgrade-tags-with-subscribers.md | ||
| skip-non-essential-work-during-upgrade-context.bad.al | ||
| skip-non-essential-work-during-upgrade-context.good.al | ||
| skip-non-essential-work-during-upgrade-context.md | ||
| use-datatransfer-for-large-dataset-initialization.bad.al | ||
| use-datatransfer-for-large-dataset-initialization.good.al | ||
| use-datatransfer-for-large-dataset-initialization.md | ||
| use-obsolete-pending-before-removed.bad.al | ||
| use-obsolete-pending-before-removed.good.al | ||
| use-obsolete-pending-before-removed.md | ||
| use-upgrade-tags-not-version-checks.bad.al | ||
| use-upgrade-tags-not-version-checks.good.al | ||
| use-upgrade-tags-not-version-checks.md | ||