mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-06 09:26:52 +01:00
a9f3c50863
The previous LLM-generated knowledge files contained factual
hallucinations. The most visible was the claim that `FindFirst` /
`FindLast` "forces a full-table scan" on an unfiltered record - it does
not; those APIs return a single row via the current key.
Other inaccuracies the audit found and fixed:
* `FindSet(true)` was described as "taking a LockTable". The correct
upstream phrasing is that `FindSet(true)` sets
`ReadIsolation::UpdLock` on the read. UpdLock and LockTable are
related but distinct mechanisms.
* The list of production-scale tables had been invented beyond the
upstream source (e.g. "Detailed Cust. Ledg. Entry") without a
citation. The regenerated list matches the ten tables upstream lists
with their P95 row counts.
* `SetLoadFields` guidance had been augmented with an extra mechanism
claim ("the database resolves the filter using the index without
hydrating the value") not present in upstream.
Approach: full regeneration of `microsoft/knowledge/` from the six
upstream BCApps Code Review instruction files, with Microsoft Learn /
the AL language reference as a secondary source. Every claim in every
regenerated file is anchored to a verbatim upstream quote (or a Learn
URL); the audit trail lives in artifacts/trace-<domain>.json on the
session workspace.
The PR #11 transaction/error-handling cluster is preserved verbatim:
* performance/understand-implicit-transaction-boundary.md
* performance/codeunit-run-as-atomic-sub-operation.{md,good.al,bad.al}
* performance/codeunit-run-requires-prior-commit-inside-transaction.{md,good.al,bad.al}
* performance/use-tryfunction-for-error-catching-not-rollback.{md,good.al,bad.al}
* performance/avoid-commit-inside-loops.{md,good.al,bad.al}
* security/commitbehavior-attribute-scopes-explicit-commits.{md,good.al,bad.al}
* testing/transactionmodel-attribute-governs-test-transactions.{md,good.al,bad.al}
These articles already cite Microsoft Learn and were carefully
cross-referenced; the regeneration skips their topics rather than
duplicating them.
File counts after regeneration:
performance 35 .md (5 preserved + 30 new)
privacy 17 .md
security 18 .md (1 preserved + 17 new)
style 33 .md
testing 1 .md (preserved)
ui 19 .md
upgrade 18 .md
Total 141 atomic knowledge files, each strictly one rule. All pass
.github/scripts/validate_frontmatter.py with 0 errors and 0 warnings.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| abouttitle-abouttext-teaching-tips.bad.al | ||
| abouttitle-abouttext-teaching-tips.good.al | ||
| abouttitle-abouttext-teaching-tips.md | ||
| api-page-camelcase-properties.bad.al | ||
| api-page-camelcase-properties.good.al | ||
| api-page-camelcase-properties.md | ||
| api-page-delayedinsert-true.bad.al | ||
| api-page-delayedinsert-true.good.al | ||
| api-page-delayedinsert-true.md | ||
| api-page-entity-naming-singular-plural.bad.al | ||
| api-page-entity-naming-singular-plural.good.al | ||
| api-page-entity-naming-singular-plural.md | ||
| api-page-version-format.bad.al | ||
| api-page-version-format.good.al | ||
| api-page-version-format.md | ||
| begin-on-same-line-as-then-else-do.bad.al | ||
| begin-on-same-line-as-then-else-do.good.al | ||
| begin-on-same-line-as-then-else-do.md | ||
| block-keywords-start-new-line.bad.al | ||
| block-keywords-start-new-line.good.al | ||
| block-keywords-start-new-line.md | ||
| caption-required-on-page-fields.bad.al | ||
| caption-required-on-page-fields.good.al | ||
| caption-required-on-page-fields.md | ||
| case-action-on-line-after-possibility.bad.al | ||
| case-action-on-line-after-possibility.good.al | ||
| case-action-on-line-after-possibility.md | ||
| error-passes-parameters-directly-not-strsubstno.bad.al | ||
| error-passes-parameters-directly-not-strsubstno.good.al | ||
| error-passes-parameters-directly-not-strsubstno.md | ||
| event-subscriber-param-names-match-publisher.md | ||
| fieldcaption-not-fieldname-in-user-messages.bad.al | ||
| fieldcaption-not-fieldname-in-user-messages.good.al | ||
| fieldcaption-not-fieldname-in-user-messages.md | ||
| file-name-object-type-pattern.md | ||
| function-call-parentheses-required.bad.al | ||
| function-call-parentheses-required.good.al | ||
| function-call-parentheses-required.md | ||
| label-comment-explains-placeholders.bad.al | ||
| label-comment-explains-placeholders.good.al | ||
| label-comment-explains-placeholders.md | ||
| label-locked-for-non-translatable.bad.al | ||
| label-locked-for-non-translatable.good.al | ||
| label-locked-for-non-translatable.md | ||
| label-suffix-approved-list.bad.al | ||
| label-suffix-approved-list.good.al | ||
| label-suffix-approved-list.md | ||
| lowercase-reserved-keywords.bad.al | ||
| lowercase-reserved-keywords.good.al | ||
| lowercase-reserved-keywords.md | ||
| named-invocations-not-object-ids.bad.al | ||
| named-invocations-not-object-ids.good.al | ||
| named-invocations-not-object-ids.md | ||
| no-begin-end-around-single-statement.bad.al | ||
| no-begin-end-around-single-statement.good.al | ||
| no-begin-end-around-single-statement.md | ||
| no-else-after-terminating-statement.bad.al | ||
| no-else-after-terminating-statement.good.al | ||
| no-else-after-terminating-statement.md | ||
| no-space-before-method-parenthesis.bad.al | ||
| no-space-before-method-parenthesis.good.al | ||
| no-space-before-method-parenthesis.md | ||
| object-name-30-char-limit.md | ||
| optioncaption-required-and-matches-membercount.bad.al | ||
| optioncaption-required-and-matches-membercount.good.al | ||
| optioncaption-required-and-matches-membercount.md | ||
| page-name-must-match-source-table.md | ||
| single-space-after-not-operator.bad.al | ||
| single-space-after-not-operator.good.al | ||
| single-space-after-not-operator.md | ||
| single-space-around-binary-operators.bad.al | ||
| single-space-around-binary-operators.good.al | ||
| single-space-around-binary-operators.md | ||
| temporary-variable-temp-prefix.bad.al | ||
| temporary-variable-temp-prefix.good.al | ||
| temporary-variable-temp-prefix.md | ||
| this-keyword-in-codeunits.bad.al | ||
| this-keyword-in-codeunits.good.al | ||
| this-keyword-in-codeunits.md | ||
| tooltip-required-on-page-fields.bad.al | ||
| tooltip-required-on-page-fields.good.al | ||
| tooltip-required-on-page-fields.md | ||
| variable-declaration-order-by-type.bad.al | ||
| variable-declaration-order-by-type.good.al | ||
| variable-declaration-order-by-type.md | ||
| variable-name-must-not-shadow.bad.al | ||
| variable-name-must-not-shadow.good.al | ||
| variable-name-must-not-shadow.md | ||
| xmldoc-for-public-library-procedures.md | ||