mirror of
https://github.com/microsoft/BCQuality.git
synced 2026-08-06 09:26:52 +01:00
62dabf9a11
The /samples/ top-level tree is replaced with sibling files in each
knowledge-layer folder. An article and its demonstrations now live
side-by-side:
microsoft/knowledge/<domain>/<slug>.md
microsoft/knowledge/<domain>/<slug>.good.al
microsoft/knowledge/<domain>/<slug>.bad.al
Rationale:
- Proximity. An article and its paired samples are one unit; the
filesystem now reflects that.
- Layer ownership. Samples inherit layer precedence for free -- a
/custom/ fork can override an article and its samples atomically,
which the shared /samples/ tree previously made awkward.
- Trivial migration path. Action-skill source globs
(*/knowledge/<domain>/**/*.md) are unchanged; sample discovery is a
sibling-filename lookup.
Changes:
- git mv of all 65 sample files from samples/<domain>/<slug>/{bad,good}.al
to microsoft/knowledge/<domain>/<slug>.{bad,good}.al (history preserved).
- Update See-sample references in all 37 articles that ship samples.
- skills/read.md: replace the no-code-blocks bullet with a pointer to a
new Sample files section that fully specifies the sibling convention,
the kinds (good/bad + forward-compatible), multi-technology rules,
demonstration-only status, and layer-precedence behaviour.
- skills/write.md: update the samples pointer to match.
- README.md: annotate the knowledge tree with the sample sibling shape.
- samples/README.md deleted; content lifted into skills/read.md.
- Both generators (C:\temp\gen_performance_knowledge.py,
C:\temp\gen_security_knowledge.py) updated to emit at the new paths
and to stop writing samples/README.md. Re-running them is idempotent
against the committed layout.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
||
|---|---|---|
| .. | ||
| avoid-sensitive-data-in-error-messages.bad.al | ||
| avoid-sensitive-data-in-error-messages.good.al | ||
| avoid-sensitive-data-in-error-messages.md | ||
| compose-secrets-with-secretstrsubstno.bad.al | ||
| compose-secrets-with-secretstrsubstno.good.al | ||
| compose-secrets-with-secretstrsubstno.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-put-credentials-in-urls.bad.al | ||
| do-not-put-credentials-in-urls.good.al | ||
| do-not-put-credentials-in-urls.md | ||
| do-not-swallow-security-errors-silently.bad.al | ||
| do-not-swallow-security-errors-silently.good.al | ||
| do-not-swallow-security-errors-silently.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 | ||
| require-https-for-external-calls.bad.al | ||
| require-https-for-external-calls.good.al | ||
| require-https-for-external-calls.md | ||
| set-timeouts-for-external-calls.bad.al | ||
| set-timeouts-for-external-calls.good.al | ||
| set-timeouts-for-external-calls.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 | ||