AGENT SKILL

emitter-prep-for-pr

Prepare language emitter changes for PR: validate (build, format, lint), add a changeset, and push. This skill is specifically for the language emitter packages (http-client-python, http-client-csharp, http-client-java) - NOT for core TypeSpec packages like compiler, http, openapi3, etc. Use when the user wants to finalize emitter changes, says things like "prep for pr", "prepare for PR", "validate and push", "add changeset", or "finalize changes".

License 许可
MIT
所属仓库
microsoft/typespec
最近更新
2026-11-14
Stars
★ 5.9k
Forks
423

01 前言 Front Matter

name
emitter-prep-for-pr
description
Prepare language emitter changes for PR: validate (build, format, lint), add a changeset, and push. This skill is specifically for the language emitter packages (http-client-python, http-client-csharp, http-client-java) - NOT for core TypeSpec packages like compiler, http, openapi3, etc. Use when the user wants to finalize emitter changes, says things like "prep for pr", "prepare for PR", "validate and push", "add changeset", or "finalize changes".

03 SKILL.md 正文

Emitter Prep for PR

Prepares language emitter changes for pull request by running build/format/lint, checking for a changeset, and pushing to the remote branch.

This skill is for language emitter packages only:

  • http-client-python
  • http-client-csharp
  • http-client-java

Do NOT use this skill for core TypeSpec packages (compiler, http, openapi3, etc.).

Workflow

Step 1: Determine the emitter package

Figure out which emitter package the user is working on from context (cwd, recent changes, or ask). The package will be under packages/<package-name>/.

Step 2: Build, format, and lint the emitter package

cd ~/Desktop/github/typespec/packages/PACKAGE_NAME

# Build
npm run build

# Format (includes both TypeScript and Python formatting)
npm run format

# Lint (emitter-only is fine for quick validation)
npm run lint -- --emitter

If any step fails, report the error and stop. Do not proceed.

Step 3: Run format at repo root

cd ~/Desktop/github/typespec
pnpm format

Important: pnpm format may touch files outside the emitter package (e.g., .devcontainer/, other packages). When staging changes in Step 6, only stage files within the emitter package directory (packages/PACKAGE_NAME/) and .chronus/changes/ and .github/skills/. Discard any formatting changes to unrelated files with git checkout -- <file>.

Step 4: Check for existing changeset

Check if a changeset already exists for the current branch:

cd ~/Desktop/github/typespec
BRANCH=$(git rev-parse --abbrev-ref HEAD)
ls .chronus/changes/ | grep -i "$BRANCH" || echo "NO_CHANGESET"
  • If a changeset exists: Skip to Step 6 (no need to create one).
  • If NO_CHANGESET: Proceed to Step 5 to create one.

Step 5: Create changeset (only if none exists)

Ask the user what kind of change this is, or infer from context:

  1. changeKind - one of: internal, fix, feature, deprecation, breaking, dependencies
  2. message - concise user-focused description

Then create the file:

cd ~/Desktop/github/typespec
BRANCH=$(git rev-parse --abbrev-ref HEAD)
TIMESTAMP=$(date +"%Y-%m-%d-%H-%M-%S")
FILENAME=".chronus/changes/${BRANCH}-${TIMESTAMP}.md"
---
changeKind: <KIND>
packages:
  - "<PACKAGE>"
---

<MESSAGE>

Step 6: Stage, commit, and push

cd ~/Desktop/github/typespec
git add -A
git status

Show the user what will be committed and ask for confirmation. Then:

BRANCH=$(git rev-parse --abbrev-ref HEAD)
git commit -m "<COMMIT_MESSAGE>

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>"

# Always push to origin (user's fork), never upstream
git push origin "$BRANCH"

Changeset Guidelines

changeKind reference

  • internal: Tests, CI/CD, refactoring, docs, skills — not user-facing
  • fix: Bug fixes users would notice
  • feature: New user-facing capabilities
  • deprecation: Marking something as deprecated
  • breaking: Removing or changing behavior incompatibly
  • dependencies: Dependency version bumps

Message examples

  • internal: "Improve CI pipeline performance and test infrastructure"
  • fix: "Fix incorrect deserialization of nullable enum properties"
  • feature: "Add support for XML serialization in request bodies"

Package names

Folder Package Name
http-client-python @typespec/http-client-python
http-client-csharp @typespec/http-client-csharp
http-client-java @typespec/http-client-java

04 同仓库更多 Skills

microsoft
microsoft/typespec

test-unbranded-emitter

Build and test the @typespec/http-client-python emitter. Use this skill whenever the user wants to test their local changes to the emitter, run the generator test suite, check if their http-client-python changes are passing, or validate a fix. Triggers on phrases like "test the emitter", "run tests", "check if my changes pass", "run test:generator", "run CI", or any mention of testing/validating changes in the emitter package.

测试与质量Skill与智能体开发
★ 5.9k
microsoft
microsoft/typespec

generate-from-typespec

Generate Python SDK code from a TypeSpec specification using the local emitter. Use this skill when the user wants to generate/regenerate a Python client from a TypeSpec spec, provides a GitHub URL or local path to a TypeSpec project, or says things like "generate from this spec", "emit Python from this tsp", "regenerate the SDK", or "compile this TypeSpec for Python".

Skill与智能体开发
★ 5.9k
microsoft
microsoft/typespec

diff-upstream

Regenerate the local emitter and diff the generated code against the upstream baseline checked into autorest.python. Use this skill when the user wants to see how their emitter changes affect generated code compared to what's currently in production, says things like "diff upstream", "compare to baseline", "what changed vs production", "show me the diff", "how does this affect generated code", or wants to validate their changes produce the expected output differences.

Skill与智能体开发
★ 5.9k
microsoft
microsoft/typespec

writing-python-sdk-spector-mock-api-tests

Writes TypeSpec http-client-python generator mock API tests (azure/unbranded/shared) from a Spector case. Use when given a Spector case link or a PR link that modifies Spector cases under http-specs/azure-http-specs.

开发工程师内容创作者后端与接口写作与文案
★ 5.9k
microsoft
microsoft/typespec

pnpm-format

Format the codebase with pnpm and recover from common formatting failures.

★ 5.9k
microsoft
microsoft/typespec

minimal-repro

Help create a minimal reproduction for a TypeSpec compiler or emitter bug. Use when a user provides TypeSpec source (pasted code or a GitHub URL) and describes an issue. Reproduces locally and reduces to a single-file repro.

★ 5.9k