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. |
||
|---|---|---|
| .. | ||
| add-sift-keys-for-flowfields.good.al | ||
| add-sift-keys-for-flowfields.md | ||
| avoid-calcfields-in-loops.bad.al | ||
| avoid-calcfields-in-loops.good.al | ||
| avoid-calcfields-in-loops.md | ||
| avoid-commit-inside-loops.bad.al | ||
| avoid-commit-inside-loops.md | ||
| avoid-findfirst-with-next.bad.al | ||
| avoid-findfirst-with-next.md | ||
| avoid-user-interaction-in-transactions.bad.al | ||
| avoid-user-interaction-in-transactions.good.al | ||
| avoid-user-interaction-in-transactions.md | ||
| combine-multiple-modifyall-calls.bad.al | ||
| combine-multiple-modifyall-calls.good.al | ||
| combine-multiple-modifyall-calls.md | ||
| do-not-flag-performance-on-bounded-tables.md | ||
| do-not-modify-records-in-onaftergetrecord.bad.al | ||
| do-not-modify-records-in-onaftergetrecord.good.al | ||
| do-not-modify-records-in-onaftergetrecord.md | ||
| do-not-re-get-rec-inside-onaftergetrecord.bad.al | ||
| do-not-re-get-rec-inside-onaftergetrecord.good.al | ||
| do-not-re-get-rec-inside-onaftergetrecord.md | ||
| do-not-retarget-flowfield-calcformula-to-larger-tables.md | ||
| filter-before-find.bad.al | ||
| filter-before-find.good.al | ||
| filter-before-find.md | ||
| guard-before-get-not-after.bad.al | ||
| guard-before-get-not-after.good.al | ||
| guard-before-get-not-after.md | ||
| keep-event-subscribers-lightweight.bad.al | ||
| keep-event-subscribers-lightweight.md | ||
| keep-sourcetabletemporary-on-api-and-background-pages.md | ||
| maintainsqlindex-false-disables-sift.md | ||
| only-fetch-records-you-use.bad.al | ||
| only-fetch-records-you-use.good.al | ||
| only-fetch-records-you-use.md | ||
| prefer-direct-record-over-recordref.bad.al | ||
| prefer-direct-record-over-recordref.good.al | ||
| prefer-direct-record-over-recordref.md | ||
| prefer-get-for-primary-key-lookups.bad.al | ||
| prefer-get-for-primary-key-lookups.good.al | ||
| prefer-get-for-primary-key-lookups.md | ||
| set-current-key-to-match-filters.good.al | ||
| set-current-key-to-match-filters.md | ||
| skip-setloadfields-on-narrow-tables-and-short-loops.md | ||
| split-read-only-and-write-paths-to-avoid-locktable.bad.al | ||
| split-read-only-and-write-paths-to-avoid-locktable.good.al | ||
| split-read-only-and-write-paths-to-avoid-locktable.md | ||
| treat-ledger-entry-tables-as-production-scale.md | ||
| use-addloadfields-in-report-layouts.good.al | ||
| use-addloadfields-in-report-layouts.md | ||
| use-calcsums-for-flowfield-totals.bad.al | ||
| use-calcsums-for-flowfield-totals.good.al | ||
| use-calcsums-for-flowfield-totals.md | ||
| use-findset-readonly-by-default.bad.al | ||
| use-findset-readonly-by-default.good.al | ||
| use-findset-readonly-by-default.md | ||
| use-findset-with-next.bad.al | ||
| use-findset-with-next.good.al | ||
| use-findset-with-next.md | ||
| use-insert-false-when-skipping-triggers.good.al | ||
| use-insert-false-when-skipping-triggers.md | ||
| use-isempty-for-existence-checks.bad.al | ||
| use-isempty-for-existence-checks.good.al | ||
| use-isempty-for-existence-checks.md | ||
| use-setloadfields-for-partial-records.bad.al | ||
| use-setloadfields-for-partial-records.good.al | ||
| use-setloadfields-for-partial-records.md | ||
| use-single-instance-codeunits-for-caching.good.al | ||
| use-single-instance-codeunits-for-caching.md | ||
| use-temporary-tables-for-intermediate-data.good.al | ||
| use-temporary-tables-for-intermediate-data.md | ||