diff --git a/.github/skills/find-package-skill/SKILL.md b/.github/skills/find-package-skill/SKILL.md new file mode 100644 index 000000000000..e364f2706758 --- /dev/null +++ b/.github/skills/find-package-skill/SKILL.md @@ -0,0 +1,25 @@ +--- +name: find-package-skill +description: '**UTILITY SKILL** — Must be consulted before making any changes to packages under sdk/. Provides package-specific domain knowledge that prevents common mistakes. WHEN: add feature to package; fix bug in package; modify package code; regenerate from typespec; change client library.' +--- + +# Find Package Skill + +Before modifying any SDK package in this monorepo, check this registry to see +if a package-specific skill exists. Package skills contain tribal knowledge +(architecture, data flows, type mappings, pitfalls) that prevents common mistakes. + +Always check this registry before modifying any SDK package — even if you think +you already know the package well. + +## How to Use + +1. Find the package you're modifying in the table below. +2. Read the SKILL.md at the listed path using the Read tool. Then read all files under the `references/` directory next to it for additional context. +3. If the package isn't listed, no package-specific skill exists yet — proceed normally. + +## Package Skills + +| Package | Path | +| -------------------------- | ------------------------------------------------------------------------------------------------- | +| `azure-search-documents` | `sdk/search/azure-search-documents/.github/skills/search-documents/SKILL.md` | diff --git a/sdk/search/azure-search-documents/.github/skills/search-documents/SKILL.md b/sdk/search/azure-search-documents/.github/skills/search-documents/SKILL.md new file mode 100644 index 000000000000..8e4f72d5f40b --- /dev/null +++ b/sdk/search/azure-search-documents/.github/skills/search-documents/SKILL.md @@ -0,0 +1,65 @@ +--- +name: search-documents +description: 'Post-regeneration customization guide for azure-search-documents SDK. After running tsp-client update, consult this skill to re-apply search-specific customizations and produce a production-ready SDK. WHEN: regenerate search SDK; search tsp-client update; fix search customization errors; search API version update; search SDK release; update search service version.' +--- + +# azure-search-documents — Package Skill + + + +## Common Pitfalls + + + +## Architecture + + + +### Source Layout + + + +### Generated vs Custom Code + + + +## Regeneration Workflow + + + +## Key Files + + + +## Service Version Management + + + +## Post-Regeneration Customizations + + + +## Testing Notes + + + +## References + +| File | Contents | +|------|----------| +| [references/architecture.md](references/architecture.md) | Source layout, package map, dependencies | +| [references/customizations.md](references/customizations.md) | JavaParser AST patterns, per-customization update guidance | diff --git a/sdk/search/azure-search-documents/.github/skills/search-documents/references/architecture.md b/sdk/search/azure-search-documents/.github/skills/search-documents/references/architecture.md new file mode 100644 index 000000000000..49393c38d070 --- /dev/null +++ b/sdk/search/azure-search-documents/.github/skills/search-documents/references/architecture.md @@ -0,0 +1,4 @@ +# azure-search-documents SDK Architecture + + diff --git a/sdk/search/azure-search-documents/.github/skills/search-documents/references/customizations.md b/sdk/search/azure-search-documents/.github/skills/search-documents/references/customizations.md new file mode 100644 index 000000000000..eaa28fb33c05 --- /dev/null +++ b/sdk/search/azure-search-documents/.github/skills/search-documents/references/customizations.md @@ -0,0 +1,4 @@ +# azure-search-documents — Customization Guide + +