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. |
||
|---|---|---|
| .. | ||
| apply-approved-label-suffixes.bad.al | ||
| apply-approved-label-suffixes.good.al | ||
| apply-approved-label-suffixes.md | ||
| follow-api-page-naming-rules.bad.al | ||
| follow-api-page-naming-rules.good.al | ||
| follow-api-page-naming-rules.md | ||
| include-comment-on-labels-with-placeholders.bad.al | ||
| include-comment-on-labels-with-placeholders.good.al | ||
| include-comment-on-labels-with-placeholders.md | ||
| match-optioncaption-count-to-optionmembers.bad.al | ||
| match-optioncaption-count-to-optionmembers.good.al | ||
| match-optioncaption-count-to-optionmembers.md | ||
| name-files-as-object-dot-type-dot-al.md | ||
| pass-parameters-directly-to-error-no-strsubstno.bad.al | ||
| pass-parameters-directly-to-error-no-strsubstno.good.al | ||
| pass-parameters-directly-to-error-no-strsubstno.md | ||
| prefix-temporary-record-variables-with-temp.bad.al | ||
| prefix-temporary-record-variables-with-temp.good.al | ||
| prefix-temporary-record-variables-with-temp.md | ||
| require-parentheses-on-function-calls.bad.al | ||
| require-parentheses-on-function-calls.good.al | ||
| require-parentheses-on-function-calls.md | ||
| use-fieldcaption-and-tablecaption-in-user-messages.bad.al | ||
| use-fieldcaption-and-tablecaption-in-user-messages.good.al | ||
| use-fieldcaption-and-tablecaption-in-user-messages.md | ||
| use-named-invocations-instead-of-object-ids.bad.al | ||
| use-named-invocations-instead-of-object-ids.good.al | ||
| use-named-invocations-instead-of-object-ids.md | ||
| use-this-keyword-in-codeunits.bad.al | ||
| use-this-keyword-in-codeunits.good.al | ||
| use-this-keyword-in-codeunits.md | ||