From d68394dce0474dc590318179960db33e35743512 Mon Sep 17 00:00:00 2001 From: "FAREAST\\chunyu" Date: Mon, 10 Nov 2025 17:07:30 +0800 Subject: [PATCH] authoring instructions --- .../typespec-authoring.instructions.md | 49 +++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md diff --git a/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md b/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md new file mode 100644 index 000000000..effc2b532 --- /dev/null +++ b/eng/common/instructions/azsdk-tools/typespec-authoring.instructions.md @@ -0,0 +1,49 @@ +--- +description: "Guide the user to define and update TypeSpec based API spec for a service" +--- + +# Goal + +Help the user define or update TypeSpec API specifications using the `azsdk-qa-bot` tools. + +## 🧩 Context +This instruction applies to all tasks involving **TypeSpec**, including: +- Writing new TypeSpec definitions +- Editing or refactoring existing TypeSpec files +- Resolving TypeSpec-related issues + +## Scenario A: Add a new api version for a service + +### Step 1: Call the `azsdk-qa-bot` tool + +Use this tool to retrieve validated solutions, suggestions, or fixes for TypeSpec issues. + +### Step 2: Extract the solution from the tool result + +Parse the response from `azsdk-qa-bot` to identify the recommended fix or implementation. + +### Step 3: Execute the solution + +Apply the extracted solution to update the TypeSpec file accordingly. + +### Step 4: Suggestion follow up action + +ask user whether he want to perform following actions: +- Add new operations (create, update, delete, list, etc.) +- Add new resource types or models +- Modify existing operations +- Add new properties to existing models + +## Other Scenario + +### Step 1: Call the `azsdk-qa-bot` tool + +Use this tool to retrieve validated solutions, suggestions, or fixes for TypeSpec issues. + +### Step 2: Extract the solution from the tool result + +Parse the response from `azsdk-qa-bot` to identify the recommended fix or implementation. + +### Step 3: Execute the solution + +Apply the extracted solution to update the TypeSpec file accordingly.