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. |
||
|---|---|---|
| .. | ||
| compose-secrets-with-secretstrsubstno.bad.al | ||
| compose-secrets-with-secretstrsubstno.good.al | ||
| compose-secrets-with-secretstrsubstno.md | ||
| do-not-disable-validatetablerelation-on-user-input.bad.al | ||
| do-not-disable-validatetablerelation-on-user-input.good.al | ||
| do-not-disable-validatetablerelation-on-user-input.md | ||
| do-not-expose-sensitive-data-in-event-publishers.bad.al | ||
| do-not-expose-sensitive-data-in-event-publishers.good.al | ||
| do-not-expose-sensitive-data-in-event-publishers.md | ||
| do-not-hardcode-environment-specific-guids.bad.al | ||
| do-not-hardcode-environment-specific-guids.good.al | ||
| do-not-hardcode-environment-specific-guids.md | ||
| follow-least-privilege-in-permission-sets.bad.al | ||
| follow-least-privilege-in-permission-sets.good.al | ||
| follow-least-privilege-in-permission-sets.md | ||
| never-hardcode-secrets-in-al.bad.al | ||
| never-hardcode-secrets-in-al.good.al | ||
| never-hardcode-secrets-in-al.md | ||
| prefer-azure-key-vault-for-production-secrets.md | ||
| use-indirect-permissions-for-elevated-access.bad.al | ||
| use-indirect-permissions-for-elevated-access.good.al | ||
| use-indirect-permissions-for-elevated-access.md | ||
| use-inherent-permissions-to-grant-minimal-access.bad.al | ||
| use-inherent-permissions-to-grant-minimal-access.good.al | ||
| use-inherent-permissions-to-grant-minimal-access.md | ||
| use-isolated-storage-for-module-and-company-secrets.bad.al | ||
| use-isolated-storage-for-module-and-company-secrets.good.al | ||
| use-isolated-storage-for-module-and-company-secrets.md | ||
| use-nondebuggable-when-parsing-secrets.bad.al | ||
| use-nondebuggable-when-parsing-secrets.good.al | ||
| use-nondebuggable-when-parsing-secrets.md | ||
| use-secrettext-for-credentials.bad.al | ||
| use-secrettext-for-credentials.good.al | ||
| use-secrettext-for-credentials.md | ||
| use-secrettext-with-httpclient.bad.al | ||
| use-secrettext-with-httpclient.good.al | ||
| use-secrettext-with-httpclient.md | ||