Add breaking-changes knowledge domain and review leaf skill#44
Open
JesperSchulz wants to merge 1 commit into
Open
Add breaking-changes knowledge domain and review leaf skill#44JesperSchulz wants to merge 1 commit into
JesperSchulz wants to merge 1 commit into
Conversation
Seed a new breaking-changes (AL API stability) knowledge domain with six articles plus good/bad AL samples, a new al-breaking-changes-review leaf skill, and minimal wiring into al-code-review and the README. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Seeds a new
breaking-changesknowledge domain (AL API stability) for BCQuality, mirroring the structure of the mergederror-handlingdomain: each article is a<slug>.mdwith sibling<slug>.good.al/<slug>.bad.alsamples, and a new leaf review skill is wired intoal-code-review.The six articles (
microsoft/knowledge/breaking-changes/)var) breaks dependents. Add a new procedure/overload instead; naming a previously unnamed return value is the one safe in-place change.[Obsolete('reason','tag')], keep it through a deprecation window, then remove it.ObsoleteState = Pending→Removedwith reason + tag.[Obsolete]or#if not CLEANxxare scheduled for removal; build on the replacement, don't extend the obsolete member.SecretText; keep secretsinternal/localand expose only non-sensitive business data.internal/local; make a memberpubliconly when you intend to support it as a stable contract.New leaf skill + wiring
microsoft/skills/review/al-breaking-changes-review.md(5 H2 sections: Source, Relevance, Worklist, Action, Output;outputs: findings-report; source domainbreaking-changes).al-code-review.md(frontmattersub-skills,## Sourcebullet, line-6 description) and bumps the README leaf-skill count seven→eight, appendingbreaking-changesto the domain list.Origin / IP
Content is written from scratch as general AL best practice and verified against Microsoft Learn for version-sensitive facts (the
[Obsolete]attribute applies to procedures whileObsoleteStateapplies to objects/fields;SecretTextis v23+, so it is referenced only in prose to keep all samples valid for[all]). All articles arebc-version: [all]. Object IDs 50300–50329, unique names and IDs across the batch.Validation
python .github/scripts/validate_frontmatter.py→ 0 errors, 0 warningsTest-KnowledgeIndex.ps1→ PASSED (166 articles, deterministic, full coverage)Expected conflict
The parallel interfaces (#42) and events (#43) PRs edit the same
al-code-review.mdsub-skills list and README count lines, so a trivial wiring conflict is expected when they land. Resolution: keep ALL leaves, and set the README count = base count + number of new domains merged.Part of #34.