diff --git a/.github/instructions/markdown.instructions.md b/.github/instructions/markdown.instructions.md index 78714542..3a9db1b0 100644 --- a/.github/instructions/markdown.instructions.md +++ b/.github/instructions/markdown.instructions.md @@ -142,7 +142,7 @@ Use Markdown image syntax with paths relative to the Markdown file: ## Path conventions -- Per-path lessons: `cli/`, `vscode/`, `cloud/`, `app/`. Files are numbered by lesson order: `1-installing.md`, `2-custom-instructions.md`, etc. +- Per-path lessons: `cli/`, `vscode/`, `cloud/`, `app/`. Files are numbered by lesson order: `1-install-copilot-cli.md`, `3-custom-instructions.md`, etc. - Support images live in `_images/` directories and are excluded from routing by `website/src/content.config.ts`. ## Cross-repo links diff --git a/AUTHORING.md b/AUTHORING.md index ac043196..4ba24b4b 100644 --- a/AUTHORING.md +++ b/AUTHORING.md @@ -16,7 +16,7 @@ copilot-workshops/ │ ├── vscode/ ← VS Code lessons (0-prerequisites.md + numbered exercises) │ ├── cloud/ ← Cloud agent lessons (0-prerequisites.md + numbered exercises) │ ├── app/ ← GitHub Copilot app lessons (setup 0–1, core modules 2–10) -│ ├── es-es/ ja-jp/ ... ← Translated locale trees (currently the app harness) +│ ├── es-es/ ja-jp/ ... ← Translated App and CLI locale trees │ └── _images/ ← Screenshots and diagrams (shared across locales) ├── website/ ← Optional Astro + Starlight publisher │ ├── astro.config.mjs ← Site URL, base path, locales, sidebar @@ -31,7 +31,7 @@ copilot-workshops/ ### Add a new lesson -1. **Pick a path and number.** Lessons live under `docs/{cli,vscode,app,cloud}/N-name.md`. `N` is the next available integer in that path; the number drives the URL slug (`/cli/3-generating-code/`). +1. **Pick a path and number.** Lessons live under `docs/{cli,vscode,app,cloud}/N-name.md`. `N` is the next available integer in that path; the number drives the URL slug (`/cli/4-build-filtering/`). 2. **Create the file** with frontmatter: ```markdown --- @@ -44,8 +44,8 @@ copilot-workshops/ 3. **Write the body.** Follow the [lesson pattern](#lesson-pattern), using Markdown and GitHub admonition syntax (`> [!NOTE]`) for callouts. See **Style essentials** below. 4. **Add prev/next navigation.** Define `[previous-lesson]` and `[next-lesson]` reference links at the bottom of the page, pointing at the adjacent lessons in the same path: ```markdown - [previous-lesson]: ../2-custom-instructions/ - [next-lesson]: ../4-mcp/ + [previous-lesson]: ../3-custom-instructions/ + [next-lesson]: ../5-agent-skills/ ``` Then surface them in the body using **the same style as the other lessons in your path** — don't mix styles within a path: - **Woven into prose** (common in the CLI path): end the lesson with a sentence like ``the next step is to [create the PR][next-lesson]``. @@ -97,7 +97,7 @@ When you add a new harness or locale landing, name it `README.md` and set its `s ### Edit an existing lesson -1. **Find the file** under `docs/` (use the published URL as a hint — `/cli/3-generating-code/` lives at `docs/cli/3-generating-code.md`). +1. **Find the file** under `docs/` (use the published URL as a hint — `/cli/4-build-filtering/` lives at `docs/cli/4-build-filtering.md`). 2. **Edit the Markdown.** Same conventions apply — see **Style essentials** below. 3. **Preview** with `npm run dev` in `website/`. 4. **Commit, PR, merge.** diff --git a/README.md b/README.md index f86ad396..40167758 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ For PR/CI rules, see **[CONTRIBUTING.md](./CONTRIBUTING.md)**. - **`docs/`** — **Lesson source (plain Markdown). Edit here.** Browsable directly on github.com, no build required. - `README.md` — Workshop landing page (also the published site's home via `slug: index`). - `cli/`, `vscode/`, `cloud/`, `app/` — Per-harness lessons (Copilot CLI / VS Code / cloud agent / GitHub Copilot app). Each codespace-based harness opens with its own `0-prerequisites.md` setup lesson, and a folder `README.md` (routed via a `slug:` matching the folder) is its landing page. - - `es-es/`, `ja-jp/`, `ko-kr/`, `pt-br/`, `zh-cn/` — Translated locale trees (currently the app harness). + - `es-es/`, `ja-jp/`, `ko-kr/`, `pt-br/`, `zh-cn/` — Translated App and CLI locale trees. - `_images/` — Screenshots and diagrams (shared across all locales). - **`website/`** — Optional Astro + Starlight site that publishes `docs/` to GitHub Pages. Only needed to self-host or preview the rendered site. - `astro.config.mjs` — Site URL, base path, `locales` block, sidebar. diff --git a/docs/README.md b/docs/README.md index 83601fa5..72fed219 100644 --- a/docs/README.md +++ b/docs/README.md @@ -3,7 +3,7 @@ title: "Hands-on with GitHub Copilot's agents" slug: index authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- The recent additions to the capabilities of GitHub Copilot provide powerful tools to the developer across the entire software development lifecycle (SDLC). This includes working with issues and pull requests on GitHub, interacting with external services, and of course code creation. This lab explores the functionality, providing real-world use cases and tips on how to get the most out of the tools. @@ -23,7 +23,7 @@ GitHub Copilot inside **Visual Studio Code** and GitHub Codespaces. Work with Co ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI** — an agentic assistant that runs in your terminal. Install it, connect MCP servers, generate code with plan mode, and build your own skills, custom agents, and slash commands, all from the command line. +**GitHub Copilot CLI** — an agentic assistant that runs in your terminal. After setup, follow nine core modules: ship a star-rating quick win, establish instructions, plan and build filtering, create a quality-checks skill, validate through Playwright MCP, create a QA agent, and merge the feature. Finish with CLI controls and a wrap-up. The flow has three pull-request milestones. ### 🤖 [Copilot App](app/) diff --git a/docs/cli/0-prerequisites.md b/docs/cli/0-prerequisites.md index b75cccb2..f4112c39 100644 --- a/docs/cli/0-prerequisites.md +++ b/docs/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "Exercise 0: Prerequisites" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Before you start the Copilot CLI exercises, you need to get everything ready. You'll create your own copy of the Tailspin Toys repository and spin up a [codespace][codespaces], whose integrated terminal you'll use to install and run Copilot CLI in the next exercise. +In this exercise, you will: + +- create your own repository from the Tailspin Toys template. +- open a codespace and confirm the workspace is ready for CLI setup. + ## Setting up the lab repository To create a copy of the repository for the code you'll create, you'll make an instance from the [template][template-repository]. The new instance will contain all of the necessary files for the lab, and you'll use it as you work through the exercises. +Use a fresh template copy. It includes repository instructions, application code, tests, and CI, but no supplied custom agents or skills. You'll create those assets yourself. If you are returning to an older copy, inspect existing customizations before changing them; do not overwrite your own work. + 1. In a new browser window, navigate to the GitHub repository for this lab: `https://github.com/github-samples/tailspin-toys`. 2. Create your own copy of the repository by selecting the **Use this template** button on the lab repository page. Then select **Create a new repository**. @@ -26,6 +33,9 @@ To create a copy of the repository for the code you'll create, you'll make an in > **Your backlog is ready** > > When you create your repository from the template, a backlog of GitHub issues is created for you automatically. You'll work from these issues throughout the workshop — there's nothing to file yourself. + +Wait for the issue-bootstrap workflow to finish, then check the **Issues** tab for **Allow users to filter games by category and publisher** and **Update our repository coding standards**. Use their actual titles and URLs in the lessons, not assumed issue numbers. If the backlog is missing, inspect the workflow result before proceeding. + ## Creating a codespace Next up, you'll use a codespace to complete the lab exercises. @@ -49,6 +59,8 @@ The creation of the codespace will take several minutes, although it's still far > [!NOTE] > This workshop is built to run inside a codespace or local [dev container][dev-containers]. Both ensure the environment has all the necessary prerequisites installed for a smooth experience. If you'd prefer to run it locally, open the cloned repository in VS Code and select **Reopen in Container** when prompted — VS Code will build the same dev container the codespace uses. +Once your codespace is ready, [Exercise 1][next-lesson] will open its terminal and check the repository, runtime, and authentication before installing Copilot CLI. + ## Summary Congratulations, you have created a copy of the lab repository! You also began the creation process of your codespace, which you'll use when you begin working with Copilot CLI. diff --git a/docs/cli/1-install-copilot-cli.md b/docs/cli/1-install-copilot-cli.md index 722b8516..89188725 100644 --- a/docs/cli/1-install-copilot-cli.md +++ b/docs/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "Exercise 1 - Installing GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [GitHub Copilot CLI][about-copilot-cli] is a powerful agentic coding assistant that runs in your terminal, enabling you to explore codebases, generate code, run commands, and interact with external tools - all from the command line. It allows you to offload tasks, request changes, and stay in the zone. The first step, as you might imagine, is to install the tool! Fortunately this can be done using tools you're already familiar with. @@ -21,10 +21,25 @@ Your team is starting to use AI agents to work through a growing backlog. Copilo Before installing Copilot CLI, you need to open a terminal window in your codespace. -1. Return to your codespace if you're not already there. +1. Return to your codespace and wait for its setup to finish. 2. Open a terminal window by pressing Ctrl+\`. 3. You should see a terminal panel appear at the bottom of your VS Code window. +## Confirm the learner environment + +In the codespace terminal, confirm you are in your own Tailspin Toys repository, not the workshop-content repository. Read its `README.md` and `package.json` for setup and check commands. Current Tailspin Toys requires Node.js 22.13 or later, project dependencies, and Playwright Chromium for E2E testing. + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +GitHub CLI (`gh`) will help inspect PRs and CI. If authentication is missing, use `gh auth login` and follow its browser instructions. Confirm your account can push branches and create and merge PRs in this repository; organizational policies may require another reviewer. Resolve missing prerequisites using the repository setup instructions before starting code changes, and review any installation before authorizing it. + +The CLI runs against the checkout where you start it; starting a conversation does not automatically create an isolated worktree. This workshop uses one branch per PR milestone. You'll merge star ratings and the instructions demonstration first, then keep the same filtering branch through Exercises 4–8. + ## Install Copilot CLI You can install Copilot CLI through [npm][install-npm], [WinGet][install-winget], and [Homebrew][install-homebrew]. Since GitHub Codespaces come with Node.js pre-installed you'll use npm to install Copilot CLI. @@ -35,7 +50,7 @@ You can install Copilot CLI through [npm][install-npm], [WinGet][install-winget] node --version ``` - You should see version 22 or higher (e.g., `v22.x.x`). + Tailspin Toys requires version 22.13 or higher, even if the CLI's own requirement differs. Follow the learner repository's setup instructions if your version is too old. 2. Install Copilot CLI globally in the codespace using npm: @@ -51,8 +66,8 @@ You can install Copilot CLI through [npm][install-npm], [WinGet][install-winget] You should see the version number displayed (e.g., `v1.0.XX`). -> [!TIP] -> If you encounter permission errors, you may need to use `sudo npm install -g @github/copilot` on some systems. However, this shouldn't be necessary in GitHub Codespaces. +> [!NOTE] +> If installation fails with a permission error, inspect your npm configuration or ask your workshop leader for help rather than rerun an unfamiliar command with elevated privileges. ## Authenticate with GitHub @@ -85,22 +100,39 @@ Now that you're at the Copilot CLI prompt for the first time, let's trust this w 2. For this workshop, select **Yes, and remember this folder for future sessions** since you'll be working in this repository throughout. 3. Ask Copilot a simple question to verify it's working: - ``` + ```plaintext What files are in this project? ``` 4. Copilot should explore the repository and provide a summary of the project structure. 5. Try the `/help` command to see available slash commands: - ``` + ```text /help ``` -6. Exit Copilot CLI by entering the following command in the terminal. We will return back to Copilot CLI in a future exercise! +6. Exit this session by entering the following command at the Copilot prompt. You'll start a fresh session for the first change. + ```text + /exit ``` - exit - ``` + +## Understand modes and permissions + +Copilot CLI works in the directory and Git branch where you launch it. Trusting a directory lets it use repository context; it is not the same as approving every tool action. Review permission requests for file changes, shell commands, and GitHub operations. + +Start the code exercises from your learner repository root with: + +```bash +copilot --enable-all-github-mcp-tools +``` + +The GitHub MCP server is built in. This flag exposes its full tool set for issue and PR work; authentication, repository permissions, and tool approvals still apply. It does not authorize a commit or PR on its own. + +Use Shift+Tab to cycle between standard **Interactive**, **Plan**, and **Autopilot** modes. Check the mode indicator before sending a request. You'll stay Interactive for the early changes, plan filtering before building it, and explicitly return to Interactive before creating and reviewing customizations. + +> [!CAUTION] +> Mode and permission settings are different. Autopilot continues working autonomously; `--allow-all` and its alias `--yolo` grant all tool, path, and URL permissions. This workshop does not require starting every session with unrestricted permissions. Review the scope before granting access, even inside a codespace. ## Summary and next steps @@ -111,7 +143,7 @@ Congratulations! You've successfully installed and authenticated GitHub Copilot - trust a directory for Copilot CLI to work with. - verify the installation is working correctly. -Now that Copilot CLI is installed, let's give Copilot some project context. Continue to [Exercise 2 - Custom instructions with CLI][next-lesson]. +Now that Copilot CLI is installed, make a small, reviewable change in [Exercise 2 - Add star ratings: a quick win][next-lesson]. ## Resources @@ -120,7 +152,7 @@ Now that Copilot CLI is installed, let's give Copilot some project context. Cont - [Using Copilot CLI][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/cli/10-review.md b/docs/cli/10-review.md new file mode 100644 index 00000000..7203a4a7 --- /dev/null +++ b/docs/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "Exercise 10 - Wrap-up and next steps" +description: "Review the shared development workflow, reusable artifacts, and three CLI pull-request milestones." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +You've used Copilot CLI to move from a small change to a planned feature with reusable verification. Setup in Exercises 0–1 prepared your environment; the nine core modules in Exercises 2–10 taught a complete development workflow. + +## Review the three PR milestones + +| Milestone | Merged outcome | Review habit | +| --- | --- | --- | +| PR 1: star ratings | Existing `starRating` displayed on game cards, including `No rating yet` for `null` | Keep the change bounded and verify both cases | +| PR 2: custom instructions | A focused documentation convention and a small real-code demonstration | Check that instructions improve actual code, not just chat examples | +| PR 3: filtering and verification | Filtering, the quality-checks skill, QA profile, and associated tests | Review all checkpoints, current QA evidence, and CI before merging | + +The first two PRs merged before the next milestone began from updated `main`. Exercises 4–8 shared one branch and checkout. Checkpoint commits preserved progress without creating a PR for every module. The controls exercise did not launch another feature or PR. + +## Review the shared artifacts + +These are the same core outcomes as the [Copilot app workshop][app-workshop], reached through a terminal interface: + +- **Repository instructions** explain project context and standards; path-scoped instructions add detail for relevant files. +- **The filtering implementation and tests** satisfy the issue and the clarifications you approved during planning. +- **The quality-checks skill** packages reusable instructions and actual shell scripts that run the project's four checks. +- **Playwright MCP configuration** supplies browser tools for direct observation. In this CLI flow it lives in user configuration rather than the feature PR. +- **The QA custom agent** defines a reusable role that starts from requirements, checks coverage, uses the skill and browser tools, and reports truthful results. +- **PR and verification evidence** connects the reviewed changes to test results, browser observations, limitations, and CI. + +A skill is more than a list of commands, and a profile is more than a filename. You inspected generated assets, confirmed actual execution, and selected the custom agent before relying on its report. + +## Keep the validation purposes distinct + +Planning clarified the requirements before implementation. Autopilot carried out that bounded plan; returning to Interactive restored deliberate review points before customization authoring. + +The implementation used existing npm checks before any skill existed. The skill exercise proved its bundled scripts and argument forwarding worked. MCP demonstrated direct browser interaction rather than repeating a full suite. QA combined criteria, coverage, browser evidence, and all four skill-driven checks. The PR reused current QA results while CI checked the submitted revision. + +Failures and blockers are useful outcomes. Missing browser tools, skipped tests, stale servers, or an unresolved requirement mean **NO-GO**, not permission to lower the standard. Test additions are justified by real gaps; adding no tests is correct when existing coverage is adequate. + +## Carry these habits forward + +- Give Copilot the issue, the reason for the change, and clear boundaries. +- Review plans before approving autonomous work. +- Inspect generated instructions, skills, and profiles before running them. +- Know which checkout, branch, server, and revision a result describes. +- Use the smallest justified correction and refresh evidence after changes. +- Keep installations, destructive actions, sharing, and PR merges explicit. + +## Continue learning + +The [Copilot app workshop][app-workshop] reaches the shared outcomes through its graphical interface and adds a canvas milestone. The [VS Code workshop][vscode-workshop] and [Cloud agent workshop][cloud-workshop] explore other ways to work with agents. + +Use [Awesome Copilot][awesome-copilot] to find instruction, skill, and custom-agent examples. The [skill examples in Exercise 5][skill-examples] include contribution workflows, requirements documents, diagrams, and browser testing. Review prerequisites and behavior before adopting community content. + +For everyday reference, consult the [CLI command reference][cli-reference], [agent skills documentation][agent-skills], and [custom-agent documentation][custom-agents]. Keep experimenting on bounded tasks and share only reviewed material through approved channels. + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#more-skill-examples +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/cli/2-add-star-rating.md b/docs/cli/2-add-star-rating.md new file mode 100644 index 00000000..bc28577f --- /dev/null +++ b/docs/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "Exercise 2 - Add star ratings: a quick win" +description: "Display existing game ratings, review and validate the change, and merge your first pull request." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Start with a small change you can understand and verify. Tailspin Toys already stores each game's `starRating` and shows it on the details page. You'll display that existing value on the game cards, including a clear message when a game has no rating. + +In this exercise, you will: + +- request a focused change in an Interactive CLI session. +- inspect the diff and verify rated and unrated cards. +- commit, open, review, and merge PR 1. + +## Scenario + +Visitors can see ratings on a game's details page but cannot compare them while browsing the catalog. Tailspin Toys wants the existing ratings on the game cards, with a clear unrated state. This small change lets you practice requesting, reviewing, and shipping work before tackling a larger feature. + +## Start the first milestone + +From your learner repository root, confirm the working tree is clean, update `main`, and create a branch. If `git status` shows unexpected changes, resolve them before switching; do not discard them. + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +Trust the repository when prompted. Check that you are in **Interactive** mode and use `/model` to inspect the available models or select **Auto**. Review tool approvals as they appear. + +## Request the change + +Send this prompt: + +```plaintext +On the game cards, show each game's star rating. The Game type already includes a starRating field — it's a number out of 5, or null when a game hasn't been rated yet. Display it on each card in src/components/GameCard.astro, and when starRating is null show "No rating yet" instead. Keep the change small and don't restructure the card layout. + +Inspect and follow the repository instructions. Use the existing data model; do not add a rating API, new schema, or unrelated feature. Add or update appropriate tests for the rated and unrated cases. Do not commit, push, or open a pull request yet. +``` + +Copilot should inspect the existing type and component before editing. Read its tool activity as well as its final response. A confident summary is not evidence that the implementation is correct. + +## Review and validate + +1. Enter `/diff` and inspect every changed file in your editor or the diff view. +2. Confirm the card uses the existing `starRating`, displays a value out of 5, and shows `No rating yet` for `null`. A truthiness check alone can incorrectly treat a numeric zero as unrated. +3. Check that the change preserves the card layout and gives the rating a meaningful text label rather than relying only on a star symbol or color. +4. Ask Copilot to verify the change using the existing checks: + + ```plaintext + Inspect package.json and the test configuration, then run lint, type checks, and the existing unit or E2E tests appropriate to this card change. Verify both numeric ratings and the null fallback; report the exact commands and results, including any missing coverage or blocked checks. Do not install anything, change branches, commit, push, or open a PR. + ``` + +5. Review the command output and any test changes. Resolve failures before shipping; ask before installing missing prerequisites. + +To observe the card in a browser, open a second terminal in this same checkout and run: + +```bash +npm run dev +``` + +Open the forwarded port in your codespace's **Ports** panel. Inspect rated cards on the home page. If the current seed data has no unrated example, require an automated fixture covering `null`; do not claim you observed an unrated card. Stop your development server with Ctrl+C in its terminal before E2E checks or leaving the exercise. Playwright's automated tests must not reuse a server from another checkout. + +## Create and merge PR 1 + +After reviewing the change and passing checks, authorize this milestone separately: + +```plaintext +Review the current diff and check results. Commit only the reviewed star-rating change and its tests, push the current branch, and create a pull request into main using this repository's PR template if one exists. Include the change summary and actual verification results. Do not merge the PR or start another task. +``` + +Open the returned PR URL. Inspect **Files changed** and the check results, not just the agent's summary. Review the workflow definitions in your Tailspin repository when interpreting CI; CI does not replace your browser observation. Address any failures and reverify changed code. + +When the PR meets the repository's review and check requirements, select **Merge pull request** and confirm the merge on GitHub. If branch protection requires another reviewer, wait for that approval. Confirm the PR is **Merged** before continuing. + +Exit the Copilot session with `/exit`. In the next exercise, you'll update local `main` before creating the instructions branch; do not start it from this unmerged feature branch. + +## Summary and next steps + +You've completed the first cycle: a bounded prompt, reviewed code, verification evidence, and a merged PR. Next, [guide Copilot with custom instructions][next-lesson] and demonstrate a documentation convention in a second small PR. + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/cli/2-custom-instructions.md b/docs/cli/2-custom-instructions.md deleted file mode 100644 index e1bfab7d..00000000 --- a/docs/cli/2-custom-instructions.md +++ /dev/null @@ -1,229 +0,0 @@ ---- -title: "Exercise 2 - Custom instructions (Copilot CLI)" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[← Previous lesson: Installing Copilot CLI][previous-lesson] · [Next lesson: Generating code with CLI →][next-lesson] - -Context is key when working with generative AI. If a task needs to be done a particular way — or there's background information Copilot should know — you want to make sure that context is available. There are several tools available to you to help Copilot, which we'll explore throughout this workshop. We're going to start with [instruction files][instruction-files], which are typically focused on how the code itself should be structured. This helps Copilot understand not just *what* code you want but *how* it should be structured. - -In this exercise, you will: - -- explore how project-specific context, coding guidelines, and documentation standards reach Copilot through repository custom instructions and path-scoped instruction files, -- generate the first data slice for filtering (a publishers helper) with the *current* instructions in place, -- add a new repository-wide standard to `.github/copilot-instructions.md`, -- run a follow-up prompt and watch the regenerated code adopt the new standard, -- commit the instruction updates and helper so the next exercise can build on them. - -> [!CAUTION] -> Generated code may diverge from some of the standards you set. Copilot is non-deterministic. The goal is to see the *trend* in behavior change after updating the instructions, not to match output character-for-character. - -## Instruction files - -### Scenario - -As any good dev shop, Tailspin Toys has a set of guidelines and requirements for development practices. These include: - -- The data layer always needs unit tests. -- UI should be in dark mode and have a modern feel. -- Documentation should be added to code in the form of TSDoc doc comments. -- A block of comments should be added to the head of each file describing what the file does. - -Through the use of instruction files you'll ensure Copilot has the right information to perform the tasks in alignment with the practices highlighted. - -### Custom instructions - -Custom instructions allow you to provide context and preferences to Copilot, so that it can better understand your coding style and requirements. This is a powerful feature that can help you steer Copilot to get more relevant suggestions and code snippets. You can specify your preferred coding conventions, libraries, and even the types of comments you like to include in your code. You can create instructions for your entire repository, or for specific types of files for task-level context. - -There are two types of instructions files: - -- `.github/copilot-instructions.md`, a single instruction file sent to Copilot for **every** request for the repository. This file should contain project-level information — context relevant for most chat or CLI requests sent to Copilot. This could include the tech stack being used, an overview of what's being built, best practices, and other global guidance. -- `.github/instructions/*.instructions.md` files can be created for specific tasks or file types. You can use them to provide guidelines for particular languages (like TypeScript or Astro), or for tasks like creating a UI component or a new set of unit tests. - -> [!NOTE] -> When working in your IDE, instructions files are only used for code generation in Copilot Chat — not for code completions or next-edit suggestions. -> -> Copilot Chat, Copilot CLI and Copilot cloud agent use both repository-level and `*.instructions.md` files (with `applyTo` front matter) when generating code. -> -> Finally, Copilot [supports instructions files using other standards][custom-instructions-support], including AGENTS.md and CLAUDE.md files. - -### Best practices for managing instructions files - -A full conversation about creating instructions files is beyond the scope of the workshop. However, the examples provided in the sample project show a representative approach. At a high level: - -- Keep instructions in `copilot-instructions.md` focused on project-level guidance, such as a description of what's being built, the structure of the project, and global coding standards. -- Use `*.instructions.md` files to provide specific instructions for file types (unit tests, Astro components, the data layer), or for specific tasks. -- Use natural language. Keep guidance clear. Provide examples of how code should (and shouldn't) look. - -There isn't one specific way to create instructions files, just as there isn't one specific way to use AI. You will find through experimentation what works best for your project. - -> [!TIP] -> Every project using GitHub Copilot should have a robust collection of instruction files. As you explore the ones in this project, you may notice there are files for numerous types of tasks, including [UI updates][ui-instructions] and [Astro][astro-instructions]. -> -> Copilot can also help generate instruction files for you. Each surface exposes this differently (for example, **Configure Chat → Generate Agent Instructions** in VS Code, or `/init` in Copilot CLI) — the lesson for the surface you're on will call it out where it's relevant. -> -> Looking for templates or a starting point? Explore [awesome-copilot][awesome-copilot], a repository full of instruction files, custom agents, and other resources. - -## Explore the custom instructions files in this project - -Take a moment to read the instruction files this repository ships with — there's one core `copilot-instructions.md` and a collection of `*.instructions.md` files for various tasks. Open these in your editor or the GitHub web UI. - -1. Open `.github/copilot-instructions.md`. -2. Explore the file, noting the brief description of the project plus sections such as **Agent notes**, **Code standards**, **Scripts**, and **Repository Structure**. Under **Code standards**, note the nested **GitHub Actions Workflows** guidance. These are applicable to any interactions you'd have with Copilot. -3. Open the `.github/instructions` folder and look around. Note there are instructions for Astro files, the Drizzle data layer, tests, and more. -4. Open `.github/instructions/unit-tests.instructions.md`. Note the `applyTo` field at the top — this sets a glob (relative to the repo root) that determines which files the instructions apply to. Here, any TypeScript test file (for example, one matching `**/*.test.ts`) will match. -5. Note the instructions specific to creating unit tests for this project. -6. Finally, open `.github/instructions/drizzle.instructions.md` and scroll to the bottom. Note the links to other instruction files (like `unit-tests.instructions.md`) and existing files in the project. This lets you break larger instruction sets into smaller, reusable files, and point Copilot at examples to follow when generating code. (Paths there are relative to the instruction file rather than the repo root.) - -> [!NOTE] -> The **Code formatting requirements** section in `copilot-instructions.md` documents the project's coding standards, but it doesn't yet require in-code documentation. In the next steps, you'll add rules for TSDoc doc comments and file comment headers. -## Create a branch - -You'll be making code changes, so create a branch to work in. - -1. From your codespace terminal, create and switch to a new branch: - - ```bash - git checkout -b update-custom-instructions - ``` - -2. Confirm Copilot CLI is installed and authenticated: - - ```bash - copilot --version - ``` - - If the command isn't found or you haven't logged in, return to [Exercise 1 - Installing GitHub Copilot CLI](../1-install-copilot-cli/). - -## Use Copilot CLI *before* updating the instructions - -To see the impact of custom instructions, start by generating code with the current instructions in place. Later, you'll update the file and run a follow-up prompt. - -> [!CAUTION] -> `--yolo` enables full automatic permissions (`--allow-all-tools`, `--allow-all-paths`, and `--allow-all-urls`). Use it only in an isolated environment like a Codespace or VM, and never alias it as your default for day-to-day development. See [Allowing and denying tool use][allow-all-warning] for details. - -Running Copilot CLI from the **repository root** ensures it picks up `.github/copilot-instructions.md` automatically. `--enable-all-github-mcp-tools` turns on the read/write GitHub MCP tools so Copilot can read your backlog and open pull requests later in the workshop. - -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**. -3. At the Copilot CLI prompt, ask it to generate the publishers helper that the filtering UI will use: - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -4. Copilot CLI will explore the project, propose a plan, and write the file in this `--yolo` session. Monitor the changes in your terminal output, then review in your editor. -5. Open the generated `src/lib/publishers.ts` in your editor. -6. Notice the helper is a typed function that takes a `db` client as its first argument and returns a typed array of publishers — that's coming from the data-layer conventions in `.github/instructions/drizzle.instructions.md` (which applies to `src/lib/*.ts`). -7. Notice the generated code **is missing** TSDoc doc comments and a file-level comment header. - -> [!CAUTION] -> Copilot is probabilistic — there's a chance it'll add doc comments even without being told. If that happens, that's fine; the *consistency* improvement after the instruction update is still the takeaway. - -## Add a new repository standard - -As highlighted previously, `.github/copilot-instructions.md` is designed to provide project-level information to Copilot. Let's ensure repository coding standards are documented to improve code suggestions. - -1. Re-open `.github/copilot-instructions.md`. -2. Locate the **Code formatting requirements** section, which should be near line 27. Note how it documents the project's coding standards — but it has no rule yet for in-code documentation, which is why the generated helper had no doc comments. -3. Add the following lines of markdown right below the existing standards to instruct Copilot to add file comment headers and TSDoc doc comments: - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. Save `copilot-instructions.md`. - -> [!TIP] -> As you saw in the previous lesson, instruction files can be created at the repository level (`.github/copilot-instructions.md`) for global guidance, or as `*.instructions.md` files for specific languages, file types, or tasks. The repository-level file is the right home for project-wide standards like the doc comment rule you just added. -## Re-run the prompt and observe the change - -Now that the instructions have a doc comment rule, ask Copilot CLI to update the publishers file you just generated. The same standards directive will steer the rewrite. - -1. Send `/clear` in your Copilot CLI session to start with a clean conversation. -2. Send the following prompt: - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. Let the edit complete, then reopen `src/lib/publishers.ts`. -4. Notice that the file now opens with a comment block similar to: - - ```typescript - /** - * Publisher data-access helpers for the Tailspin Toys Crowd Funding platform. - * Provides functions to retrieve publisher information from the database. - */ - ``` - -5. Notice that the generated function now includes a TSDoc comment similar to: - - ```typescript - /** - * Returns a list of all publishers with their id and name. - * - * @param db - The Drizzle database client. - * @returns A promise that resolves to an array of publisher objects. - */ - ``` - -6. Keep this updated file in place. It's the first data slice you'll build on in the next exercise. - -## Commit and push this first filtering slice - -1. In your terminal, verify the changed files: - - ```bash - git status - ``` - -2. Stage the instruction update and the helper: - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. Commit the changes: - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. Push the branch: - - ```bash - git push -u origin update-custom-instructions - ``` - -## Summary and next steps - -You explored how Copilot picks up context from instruction files in this project, then used Copilot CLI to: - -- generate a publishers data-access helper foundation for filtering with the *existing* instructions, -- add a new repository-wide standard to `.github/copilot-instructions.md`, -- run a follow-up prompt and watch the regenerated code adopt the new standard, -- commit and push both the instructions update and the helper foundation. - -Next, you'll apply these instructions while implementing backlog work in [the generating-code exercise][next-lesson]. - -## Resources - -- [Instruction files for GitHub Copilot customization][instruction-files] -- [Best practices for creating custom instructions][instructions-best-practices] -- [5 tips for writing better custom instructions for Copilot][copilot-instructions-five-tips] -- [Awesome Copilot — a collection of instruction files and other resources][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support diff --git a/docs/cli/3-custom-instructions.md b/docs/cli/3-custom-instructions.md new file mode 100644 index 00000000..b3b2c886 --- /dev/null +++ b/docs/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "Exercise 3 - Guide Copilot with custom instructions" +description: "Add a focused documentation convention, demonstrate it on existing code, and merge the second pull request." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Context helps Copilot understand not just *what* to build but *how* your team expects code to be written. You'll add a focused documentation convention, observe its effect on real code, and merge the instructions and demonstration together as PR 2. + +In this exercise, you will: + +- explore repository-wide and path-scoped instructions. +- add a documentation standard without implementing filtering early. +- demonstrate the standard on a small existing helper or component. +- validate and merge the instructions milestone. + +## Scenario + +The Tailspin Toys team wants useful code documentation to be a repeatable convention, not a request someone must remember in every conversation. You'll add the standard to the repository instructions and demonstrate it on existing code without changing behavior or starting filtering early. + +## Explore the instructions + +The repository already contains two useful kinds of instructions: + +- `.github/copilot-instructions.md` supplies repository-wide context, such as the stack, structure, and common practices. +- `.github/instructions/*.instructions.md` supplies scoped guidance. An `applyTo` frontmatter glob identifies the files the instructions apply to. + +Open these files in your editor: + +1. Read `.github/copilot-instructions.md` and locate the current coding and verification standards. +2. Explore `.github/instructions/`, including the Astro, data-layer, and test guidance. +3. In `unit-tests.instructions.md`, inspect the `applyTo` pattern and the testing conventions. +4. In `drizzle.instructions.md`, inspect the data-access patterns and references to examples. + +Keep repository-wide instructions concise, place file-specific detail in the relevant scoped file, and avoid conflicting copies of the same rule. [GitHub's instruction support reference][instruction-support] explains which instruction formats each harness supports. + +> [!NOTE] +> Instructions influence generation; they do not guarantee compliance. Your review will check both the instruction text and its effect on code. If Copilot already produces good comments, the lesson is about making the convention explicit and repeatable, not forcing a before-and-after failure. + +## Start from merged PR 1 + +Confirm the star-rating PR is merged. From the learner repository terminal, start the next milestone from updated `main`: + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +If the working tree is not clean or the pull fails, resolve that state before continuing. Stay in **Interactive** mode. + +In the repository's **Issues** tab, find **Update our repository coding standards** and copy its actual URL. The issue provides the broader context: explain intent, document exported data-layer functions and component contracts, and keep comments current. This exercise takes a bounded documentation slice, not a repository-wide refactor or a promise to complete every issue criterion. + +## Add the documentation convention + +Replace the placeholder with the actual issue URL and send: + +```plaintext +Read this coding-standards issue for context: . Inspect the existing repository and scoped instructions. Add a focused documentation convention: explain intent rather than restating code, document exported functions in db/ and src/lib/ with TSDoc/JSDoc covering purpose, parameters, and return values, document reusable Astro component Props contracts, and keep comments current when related code changes. + +Put each rule in the appropriate existing instruction file and avoid duplication or contradictions. Preserve the existing formatting and linting standards; link to or summarize the documentation convention in README where appropriate. Limit this change to the documentation standard, not a formatting-tool migration or repository-wide rewrite. Do not create a skill or agent, implement filtering, commit, push, or open a PR. Stop so I can inspect the instructions before the demonstration. +``` + +Inspect the diff. The convention should encourage useful comments, not demand a boilerplate header on every file or comments that merely repeat obvious code. Ask for corrections before proceeding. + +## Demonstrate the convention on real code + +Choose a small existing exported helper or reusable component after inspecting the repository. It does not need to be a publisher helper, and there is no requirement that `src/lib/publishers.ts` already exists. + +Send: + +```plaintext +Using the updated instructions, select one small existing exported helper or reusable Astro component that would benefit from clearer documentation. Apply the convention directly to that file without changing runtime behavior or adding filtering functionality. Explain which instruction guided the change, and stop before committing or opening a PR. +``` + +Open the actual changed file. For a helper, check that the comments accurately describe its parameters, return value, and any injected database argument. For a component, check that its `Props` contract is documented. Confirm the explanation matches the code rather than just looking for a comment block. + +> [!TIP] +> An illustrative snippet in the chat is not the demonstration: inspect a real repository change. If the selected code already meets the convention, choose another small existing target where an improvement is justified rather than add redundant comments. + +## Validate and merge PR 2 + +Ask Copilot to validate the reviewed changes: + +```plaintext +Review the instruction changes and the small documentation demonstration. Confirm runtime behavior is unchanged. Inspect package.json, run npm run lint and npm run typecheck:all, and run affected existing tests where the code change warrants them. Report exact commands and results. Do not install anything, create a skill, commit, push, or open a PR yet. +``` + +Resolve failures and inspect the final diff. Then authorize the milestone: + +```plaintext +Commit only the reviewed documentation instructions, directly related README update, and small code demonstration. Push the current branch and create a PR into main following the repository's PR template. Include the verification results and reference the coding-standards issue as a partial contribution; do not use a closing keyword unless every issue criterion is actually satisfied. Do not merge or start filtering. +``` + +Open the PR URL, inspect **Files changed**, and review CI. After all required checks and reviews pass, merge on GitHub and confirm PR 2 is **Merged**. Exit the CLI session with `/exit`. Do not start the next milestone until this PR is merged. + +## Summary and next steps + +Your documentation convention and a real demonstration are now on `main`. Next, you'll [build filtering with Plan and Autopilot][next-lesson] in a fresh branch based on that merged state. + +## Resources + +- [Adding repository custom instructions][repository-instructions] explains repository-wide and path-scoped guidance. +- [Awesome Copilot][awesome-copilot] offers examples to review and adapt, not blindly adopt. + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/cli/3-generating-code.md b/docs/cli/3-generating-code.md deleted file mode 100644 index 7a71d1f2..00000000 --- a/docs/cli/3-generating-code.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Exercise 3 - Adding project features with GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -As you might expect, the core tasks you'll perform with GitHub Copilot CLI is to add features, functionality, and code to a project. Let's take one of the issues from your backlog and ask Copilot to help us implement it. - -## Scenario - -The time has come to complete filtering in the project. You already have the filtering issue in your backlog and a foundation helper from the previous exercise. Let's have Copilot retrieve the issue details, account for existing work, and build the remaining functionality. - -In this exercise, you will: - -- utilize plan mode to generate a plan for implementing the filtering functionality. -- generate the code necessary to add filtering to the website with Copilot. - -By the end of this exercise, you will have added new functionality to the project. - -## Utilize plan mode - -One of the best uses of AI is planning. Oftentimes you'll have a good concept of what you want to build, but just need to bounce some ideas off of something. AI tools can help you crystalize your thoughts by asking you follow up questions and working through different pitfalls or missing components. To support this process, Copilot CLI offers a plan mode. Additionally, that time you spend planning will help Copilot generate code that best matches the requirements set forth. - -You'll start the process of creating the new functionality by utilizing plan mode in Copilot CLI. - -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**. -3. Enter the following prompt into Copilot CLI to create a plan based on the filtering issue: - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -4. Copilot may ask follow-up questions as it builds out its plan. As those arise, answer them based on how you'd build out the functionality. -5. Once the plan is generated, review the blueprint. You should notice it recommends remaining changes across the data layer and UI, as well as generating tests. -6. Copilot CLI will offer you the ability to provide additional feedback to the plan. You can cursor down to the indicated section, then type your suggestions. Copilot will incorporate your suggestions into a new version of the plan. -7. Once you're satisfied, select the option provided by Copilot to begin work building the new feature! - -> [!NOTE] -> Because Copilot is probabilistic, the exact text and options provided will vary. But you will notice an option to begin building that will read something similar to: -> -> `Yes, and switch to autopilot mode`. -> -> Copilot may offer you the option to enable [autopilot mode](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot), as shown in the example above. Autopilot mode allows Copilot CLI to work through a task without waiting for your input after each step. Once you give the initial instruction, Copilot CLI works through each step autonomously until it determines the task is complete. As we are running in a contained environment, we're OK running autopilot and allowing all tools. - -8. Copilot will get to work generating the files! - -> [!NOTE] -> This operation will likely take several minutes. You will see Copilot edit and create files, update and generate tests, and run all of the tests to ensure everything succeeds. Now's a good time to reflect on what you've explored thus far, or to enjoy a beverage. - -## Review the code - -All AI code needs to be reviewed before being merged into production. Let's take the time now to explore the files Copilot created and modified in implementing the new feature. - -1. Use Copilot CLI to display the "diff" or code changes by using the following command in Copilot CLI: - - ``` - /diff - ``` - -2. Note the files changed. Use your arrow keys to switch left and right to view the different files. You should see updates to files such as the games listing page (where the new filter controls and client-side filtering live) and `src/lib/games.ts`, plus tests like `games.test.ts`. You may also see updates to `publishers.ts` if Copilot refines your existing helper to align with the full implementation. - -## Summary and next steps - -You've now added filtering functionality to the website with the help of Copilot CLI! Specifically, you: - -- utilized plan mode to generate a plan for implementing the filtering functionality. -- generated the code necessary to add filtering to the website with Copilot. - -Of course, the next step from here is to make sure it works. Let's [test your feature with the Playwright MCP server][next-lesson] before we open a pull request. - -## Resources - -- [Using Copilot CLI][using-copilot-cli] -- [About Copilot CLI][about-copilot-cli] -- [Context management in Copilot CLI][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/cli/4-build-filtering.md b/docs/cli/4-build-filtering.md new file mode 100644 index 00000000..169f0f37 --- /dev/null +++ b/docs/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "Exercise 4 - Build filtering with Plan and Autopilot" +description: "Agree filtering requirements, approve an implementation plan, validate the code, and checkpoint on the feature branch." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Now build the larger feature: let users filter games by category and publisher. You'll plan before coding, explicitly authorize **Autopilot**, review and test the implementation, and save a checkpoint. This exercise does not create the skill, QA agent, or feature PR. + +In this exercise, you will: + +- read the filtering issue and agree on unclear requirements in Plan mode. +- explicitly approve a bounded Autopilot implementation. +- review the diff and all four check results, then save a checkpoint. + +## Scenario + +Tailspin Toys' catalog is growing, and visitors need to narrow the games by category and publisher. The backlog issue describes the feature, but details such as combining categories need agreement before coding. You'll use Plan mode to resolve those decisions, then authorize a bounded implementation with Autopilot. + +## Start the filtering milestone + +Confirm PRs 1 and 2 are merged. In your learner repository terminal: + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +Continue only with a clean working tree and a successful update from `main`. Exercises 4–8 use this same branch and checkout. Later checkpoint commits will add the skill and QA profile; do not create a branch per exercise. + +## Retrieve the actual issue + +Find **Allow users to filter games by category and publisher** in your repository's **Issues** tab and copy its URL. Do not assume the template's filename or an issue number identifies the issue in your copy. + +The current issue requires: + +- selecting one or more categories. +- filtering by publisher and combining that with categories. +- data-access helpers in `src/lib/` that support both filters. +- accessible controls with keyboard navigation, appropriate ARIA, visible focus states, and `data-testid` attributes. +- Vitest unit coverage for helpers and Playwright E2E coverage for filtering behavior. + +Read the live issue as the source of truth. Keep its URL and any clarifications you approve available for the QA prompt in Exercise 7. + +## Plan before coding + +Use Shift+Tab to select **Plan** mode, or begin with `/plan`. Replace the issue placeholder and send: + +```plaintext +Plan the filtering feature described in this issue: . Read the issue, repository instructions, existing data-access helpers, UI, and tests before proposing changes. Treat the current checkout as the baseline; do not assume a publisher helper has already been created. + +Cover multiple-category selection, publisher filtering, their combination, data-access support, accessible controls, and unit/E2E coverage. Ask me to clarify unspecified behavior such as how multiple categories combine, clearing filters, and empty results; record the decisions with the approved plan. Preserve the static Astro architecture rather than introducing an unnecessary server API. + +Plan implementation on the current branch, including the required unit and E2E tests, and verification with npm run lint, npm run test:unit, npm run test:e2e, and npm run typecheck:all. Inspect prerequisites and server ownership first; report blockers rather than install software or stop unrelated processes. + +Include these execution boundaries in the plan: after I approve it, implement only the filtering feature and required tests, run the checks, then stop so I can review. Do not create the quality-checks skill, a QA agent, or other later workshop artifacts. Do not change branches, commit, push, or open or merge a PR. + +Do not edit application code or begin implementation until I approve the plan. +``` + +Answer the follow-up questions. Do not add hidden acceptance criteria later: save the agreed answers with the issue URL so the implementation, browser checks, and QA can all use the same requirements. + +Review the plan for data-layer and UI changes, tests, accessible controls, and the documentation convention you merged. Confirm it explicitly includes all four checks, the stop-for-review boundary, and the prohibitions on later workshop artifacts, branch changes, commits, pushes, and PR operations. Ask for revisions before approval if any limit or criterion is missing or it proposes work outside the issue. + +## Explicitly approve Autopilot + +Only after the plan includes the reviewed scope and execution boundaries, use the plan approval option to **Accept plan and build on autopilot**. If your version presents different wording, explicitly select the option that switches to **Autopilot**, then check the mode indicator. Approval starts execution of the bounded plan; do not rely on a later prompt to add limits after work has begun. + +> [!CAUTION] +> Autopilot controls continued work, not just tool permissions. Review the permissions dialog before choosing. Full permissions allow tool, path, and URL access; limited permissions may block actions that require approval. A codespace is not permission to expose secrets or change unrelated resources. Resolve blocked access deliberately rather than treating skipped checks as passing. + +Monitor the work and command results. Autopilot may pause at a continuation limit or report a blocker before completing the plan. Review that state before authorizing it to continue, preserving the same scope. + +## Return to Interactive and review + +When implementation stops, use Shift+Tab to return to **Interactive** mode before sending any further prompts. Autopilot can remain active after a task; do not assume it switched back. + +Enter `/diff` and inspect all changed files. Compare the implementation with the issue and your approved clarifications: + +- Can users select multiple categories, filter by publisher, and combine them as agreed? +- Do the data-access helpers actually support the filters rather than only changing the UI? +- Do controls have meaningful labels, keyboard support, visible focus, and stable test identifiers? +- Do tests assert behavior, including the agreed clearing and empty-result cases, without weakening existing assertions? +- Does the code follow the documentation convention and preserve the static app's architecture? + +Review evidence for all four npm checks. You have not created `quality-checks` yet, so these checks run directly. Playwright's E2E configuration builds and serves a preview; stop only a development server you started before running the suite so it cannot reuse stale content. A port conflict or missing browser is a blocker to resolve, not a reason to kill another process or claim a pass. + +Request focused corrections if needed, rerun affected checks, and ensure the final implementation has complete verification. Direct browser observation comes in Exercise 6; it has a different purpose from this automated verification. + +## Save the implementation checkpoint + +Once the diff and results are satisfactory, authorize a local checkpoint: + +```plaintext +Review the current diff and verification results. Create a checkpoint commit containing only the reviewed filtering implementation and its tests. Keep the current filtering branch and checkout. Do not push, open a PR, or create the skill or QA agent yet. +``` + +## Summary and next steps + +You've agreed the filtering requirements, reviewed the implementation and tests, and saved a checkpoint. Record the tested revision and keep the issue URL and approved clarifications. Stay **Interactive** and continue in this same checkout to [Exercise 5 - Create and use a quality-checks skill][next-lesson]. + +## Resources + +- [Autopilot mode and permissions][autopilot] explains autonomous continuation and switching back to Interactive. +- [Copilot CLI command reference][cli-reference] lists current mode controls and commands. + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/cli/4-mcp.md b/docs/cli/4-mcp.md deleted file mode 100644 index 35bc2649..00000000 --- a/docs/cli/4-mcp.md +++ /dev/null @@ -1,143 +0,0 @@ ---- -title: "Exercise 4 - Testing your feature with the Playwright MCP server" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -You just generated the filtering feature with Copilot CLI. Before you open a pull request, you should confirm it works in the browser. Rather than click through the app yourself, you'll connect the **Playwright MCP server** and let Copilot drive a real browser to test the feature for you. - -In this exercise, you will: - -- understand what Model Context Protocol (MCP) is and how MCP servers extend Copilot CLI. -- add the Playwright MCP server to Copilot CLI. -- ask Copilot to use it to manually test your filtering feature in a browser. - -## What is Model Context Protocol (MCP)? - -[Model Context Protocol (MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/) provides AI agents with a way to communicate with external tools and services. By using MCP, AI agents can communicate with external tools and services in real-time. This allows them to access up-to-date information (using resources) and perform actions on your behalf (using tools). - -These tools and resources are accessed through an MCP server, which acts as a bridge between the AI agent and the external tools and services. The MCP server is responsible for managing the communication between the AI agent and the external tools (such as existing APIs or local tools like NPM packages). Each MCP server represents a different set of tools and resources that the AI agent can access. - -A couple of popular existing MCP servers are: - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**: This server provides access to a set of APIs for managing your GitHub repositories. It allows the AI agent to perform actions such as creating new repositories, updating existing ones, and managing issues and pull requests. -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**: This server provides browser automation capabilities using Playwright. It allows the AI agent to perform actions such as navigating to web pages, filling out forms, and clicking buttons. - -There are many other MCP servers available that provide access to different tools and resources. GitHub hosts an [MCP registry](https://github.com/mcp) to enhance discoverability and contributions to the ecosystem. - -> [!CAUTION] -> With regard to security, treat MCP servers as you would any other dependency in your project. Before using an MCP server, carefully review its source code, verify the publisher, and consider the security implications. Only use MCP servers that you trust and be cautious about granting access to sensitive resources or operations. - -> [!NOTE] -> The [GitHub MCP server][github-mcp-server] is **built in** to Copilot CLI — it's already available without any setup, which is how Copilot has been reading and writing to your repository throughout the workshop. In this exercise you'll add a *second* server, Playwright, to give Copilot a browser. - -## Add the Playwright MCP server - -The quickest way to add a server is the interactive `/mcp add` command. You'll register the [Playwright MCP server][playwright-mcp-server], which gives Copilot a browser it can control. - -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**. -3. In your Copilot CLI session, enter: - - ```text - /mcp add - ``` - -4. A configuration form appears. Use Tab to move between fields and fill it in as follows: - - - **Server Name**: `playwright` - - **Server Type**: select **Local** (also labelled **STDIO**) - - **Command**: `npx @playwright/mcp@latest --headless` - - **Tools**: leave as `*` to allow all of the server's tools - -5. Press Ctrl+S to save. The server is added and available immediately — no restart required. - -The `--headless` flag tells Playwright to run the browser without a visible window, which is required inside a codespace where there's no desktop to display it. Behind the scenes, this writes the server to your `~/.copilot/mcp-config.json` file: - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -6. Confirm the server is registered and active by listing your MCP servers: - - ```text - /mcp show - ``` - -7. You should see `playwright` listed alongside the built-in `github` server. - -> [!NOTE] -> The Tailspin Toys project already uses Playwright for its end-to-end tests, so the browser Playwright needs is typically already installed. If Copilot later reports that a browser is missing, have it run `npx playwright install chromium` and try again. - -## Start the website - -The Playwright MCP server needs a running app to test against. Start the Astro dev server in a **separate** terminal so it keeps running while you work in Copilot CLI. - -1. Open a new terminal in your codespace by selecting Ctrl+\`. -2. Start the website: - - ```bash - npm run dev - ``` - -3. Leave this terminal running. Once you see the `Astro server: http://localhost:4321` banner, the app is ready. - -## Test the filtering feature - -Return to your Copilot CLI session and ask Copilot to test the feature. - -The [Playwright MCP server][playwright-mcp-server] gives Copilot a real browser to drive. Instead of you clicking through the app to check your work, the agent can open a page, navigate, apply filters, and read the result back to you — then summarize what it saw. It's the fastest way to confirm a feature behaves the way you expect without leaving the conversation. - -Under the hood, the Playwright MCP server works from the page's [accessibility tree][playwright-mcp-server] rather than screenshots. That means the agent reasons over structured, labelled elements (buttons, links, list items) the same way assistive technology does — so a quick functional check doubles as a light accessibility sanity check. - -With the server connected and the app running, ask Copilot to exercise the filtering feature you just built: - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -Copilot will launch a browser through the Playwright MCP server, walk through each step, and report back what it found. Read its summary against the acceptance criteria in the issue — if something looks off, ask follow-up questions or send it back to fix the code before you open a pull request. - -> [!NOTE] -> The app needs to be running at `http://localhost:4321` for this test. If you stopped the dev server, start it again before sending the prompt. The first time Copilot uses the Playwright MCP server it may need to download a browser — if it reports a missing browser, have it run `npx playwright install chromium` and try again. - -## Summary and next steps - -Congratulations, you used the Playwright MCP server to manually test your feature with Copilot CLI! To recap, you: - -- learned what Model Context Protocol (MCP) is and how MCP servers extend Copilot CLI. -- added the Playwright MCP server with `/mcp add`. -- asked Copilot to drive a browser and verify your filtering feature before shipping it. - -Now that you've confirmed the feature works, you can continue to the next exercise, where you'll [open a pull request with the help of an agent skill][next-lesson]. - -## Resources - -- [What the heck is MCP and why is everyone talking about it?][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [Adding MCP servers for Copilot CLI][cli-add-mcp] -- [GitHub MCP Server][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp diff --git a/docs/cli/5-agent-skills.md b/docs/cli/5-agent-skills.md index 5eecd846..8bcaed2a 100644 --- a/docs/cli/5-agent-skills.md +++ b/docs/cli/5-agent-skills.md @@ -1,105 +1,99 @@ --- -title: "Exercise 5 - Using agent skills" +title: "Exercise 5 - Create and use a quality-checks skill" +description: "Ask Copilot to create reusable shell-bundled quality checks, inspect the skill, and execute it on the filtering branch." authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -Doing app development often involves repeatable tasks like generating builds, running tests, or creating pull requests. **Agent skills** let you give Copilot — and other AI agents — guidance on how to perform those tasks. A skill is a folder of instructions, scripts, and resources that the agent can load on demand. [Agent Skills is an open standard][agent-skills-repo] used by a range of agents, so the same skill can work across Copilot Chat in agent mode, Copilot cloud agent, Copilot CLI, and the GitHub Copilot app. +Your filtering feature is implemented and checked with the existing npm commands. Now you'll package those checks as a reusable **agent skill**. Stay in the same filtering session and branch through Exercises 4–8; this exercise does not create a pull request. -Let's explore how a skill can ensure pull requests follow the specifications set forth by our team. +In this exercise, you will: + +- return to **Interactive** mode before creating customizations. +- ask Copilot to create and then stop for inspection of `quality-checks`. +- execute all four checks through its bundled scripts and prove a single-file test argument selects only that file. +- checkpoint the skill alongside the filtering feature. ## Scenario -The team has a set of requirements for pull requests (PR): +Tailspin Toys needs the same quality checks whenever filtering changes. Instead of explaining the commands and prerequisites in every conversation, the team wants a reusable skill. You'll create it, inspect its scripts, and verify that another request can run the checks correctly. -- clear commit messages, with files grouped logically. -- all tests must pass before a PR is created. -- each PR must contain the following sections: - - a description of why the changes were made. - - an overview of the files changed. - - snippets of important code blocks. - - details of the changes made grouped together. +## Instructions, scripts, and resources -As the team is using Copilot to generate code and PRs, it wants to ensure the AI tools follow these requirements. +Skills package reusable task instructions, executable scripts, and supporting resources that an agent loads on demand. Custom agents define specialist roles, instructions, and available tools. These are complementary: a custom agent can execute scripts, including those bundled with a skill. -In this exercise you will: +A repository skill lives in `.github/skills//SKILL.md`, with `name` and `description` frontmatter and Markdown instructions. Scripts and other resources live beside it. You'll ask Copilot to generate `.github/skills/quality-checks/SKILL.md` and its bundled scripts, rather than copy a prebuilt answer. The [Agent Skills specification][skill-spec] describes the format. -- explore an existing skill for creating pull requests. -- learn how skills are utilized by the AI agent. -- create a PR which matches the guidelines with the help of the skill. +Copilot uses a discovered skill's description to decide when to load it. Don't assume a new skill is immediately discovered in an already open session; the run section includes an explicit-read fallback. A portable format does not remove shell or project prerequisites. -## Creating agent skills +## Create the skill -Skills live in the `.github/skills` folder of a project, or globally in `~/.copilot/skills`. Each skill is a folder containing a `SKILL.md` file with YAML frontmatter (a `name` and a `description`) followed by the markdown instructions: +Return to **Interactive** mode before sending the prompt. Keep the current checkout and branch. If you started with an older template that already has this skill, inspect and extend it rather than overwrite your customizations. -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +```plaintext +Create .github/skills/quality-checks/SKILL.md and four scripts wrapping npm run lint, npm run test:unit, npm run test:e2e, and npm run typecheck:all. Read package.json, README, test configuration, and repository instructions first. -Skills can also include subfolders with scripts, assets, and reference material. The full structure is covered in the [agent skills specification][agent-skills-spec]. +Detect this environment. Create ONLY Bash .sh scripts for macOS/Linux/WSL OR PowerShell .ps1 scripts for native Windows; ask if uncertain. Do not create both. Keep wrappers limited to resolving the repository root from their own location, verifying this project's package.json there, and invoking npm. Fail clearly for an invalid root. Support any working directory and paths with spaces. Preserve output and failure exit codes, including PowerShell native failures. Insert npm's -- exactly once; callers supply tool arguments directly without another --. No port or process management. -> [!TIP] -> Skills are loaded dynamically. The agent decides which skill applies based on the `description` field — a clear, scenario-specific description is the difference between a skill that gets used and one that gets ignored. +Give SKILL.md name/description frontmatter, instructions to run all four wrappers, prerequisites, troubleshooting, and portable examples including one existing unit-test file. Every Bash example must invoke bash explicitly; never bypass PowerShell execution policy. Explain Playwright server reuse: stop only servers you actually started; otherwise ask. -## Executing skills +Only create the skill and necessary scripts. Do not run checks or probes, install anything, change application code, commit, or open a PR. Stop for inspection. +``` -Skills are loaded dynamically when the agent determines they're necessary. The decision of what skills to use is driven by the description in the `SKILL.md` file. As such, it's important to have clear descriptions which define the use case for the skill. +## Inspect the skill -## Exploring the PR skill +1. Open `.github/skills/quality-checks/SKILL.md` and its bundled scripts in your editor, and inspect the diff. +2. Check that `name` and `description` describe the skill and when it applies. Read the instructions, not just the metadata. +3. Confirm the execution sequence actually invokes bundled scripts under `.github/skills/quality-checks/` for lint, unit tests, E2E, and type checking. +4. Inspect each wrapper for script-relative root resolution and an explicit check that the derived directory contains this checkout's intended `package.json`. A command that succeeds because npm searches ancestor directories does not prove the root is correct. Check quoted paths, argument forwarding, visible output, and failure exits; PowerShell must propagate native npm failures. +5. Check the documented single-unit-test-file example. The wrapper inserts npm's `--` separator, so callers pass target-tool arguments directly without another separator. Keep reusable instructions free of machine-specific absolute checkout paths. Ask Copilot to correct gaps before running anything. +6. Keep the scripts limited to root/manifest validation and running the existing npm checks. Port and process decisions belong in SKILL.md, not shell process-management code. Confirm that only servers actually started by the agent may be stopped; a matching working directory or process name does not establish ownership. The delivered files should contain only the skill, required wrappers, and any needed shared helper, without temporary probe or debug files. -Because Tailspin Toys has a set of requirements for creating PRs, they created a skill to help AI tools be able to generate PRs which follow these guidelines. Let's explore the skill to understand what it'll do. +> [!NOTE] +> Current Tailspin Toys requires Node.js 22.13 or later, project dependencies, and Playwright Chromium for E2E checks. Confirm prerequisites in your checkout's README and `package.json`. Missing prerequisites or a blocked PowerShell execution policy need an approved resolution, not an automatic installation, policy bypass, or silent switch to direct npm. -1. Open `.github/skills/make-contribution/SKILL.md`. -2. Note the name and description. Notice how the description highlights the scenario in which it should be used, which is whenever a request is made to create a pull request or committing code. -3. Read through the skill. Notice the rules are defined about how branches should be created, commits generated, and the contents of the pull request. +## Run the skill -## Using the skill +Confirm the development server from the previous exercise has stopped. Playwright builds and serves a preview for E2E, but its local configuration can reuse a server on port `4321`. A server from another checkout is not valid evidence for your feature. -As highlighted previously, skills are automatically invoked by Copilot CLI. As a result, all we need to do is ask Copilot to create a PR! +If Copilot CLI offers `/quality-checks`, select it to explicitly invoke the discovered skill and include the request below. If it is not discovered, send the same request directly in this session; reading the skill is a supported fallback for this exercise. -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**. -3. Ask Copilot to create a PR by using the following prompt: +```plaintext +Read .github/skills/quality-checks/SKILL.md and follow its instructions to validate the filtering feature in this checkout. First inspect each wrapper's code to verify that it derives the directory containing this checkout's intended package.json and explicitly fails for an invalid root, rather than relying on npm's ancestor-package discovery. Do not move, rename, delete, or modify repository files to simulate failures. Actually run its bundled scripts for lint, unit tests, end-to-end tests, and type checks. Also run the documented single-unit-test-file example, passing target-tool arguments directly because the wrapper owns npm's -- separator. Verify from the test runner's results that ONLY the named file ran, and report that filename and the executed test-file count. Echoing arguments or returning exit code 0 alone is not proof of correct selection. - ``` - Can you please create a pull request for me! - ``` +Report each script invocation and result, including failures, skipped checks, or missing prerequisites. Do not silently substitute direct npm commands for an unusable skill script. Identify the checkout and server under test, stop only servers you started, and ask before installing anything or stopping another process. Do not change application code, change branches, commit, push, or open a pull request. +``` + +Inspect the tool calls and output. All four scripts must actually execute; a description of the checks or a skipped check is not a pass. For the single-file example, compare the requested filename with the runner's actual file results and reported count: only that file should run. Echoed arguments or exit code 0 are insufficient if other files also ran. A failure is useful evidence: correct the skill or resolve the setup blocker with approval, then rerun the affected checks. Don't stop unrelated processes or force a port conflict away. -4. Copilot will acknowledge the request. After a few moments, you'll notice Copilot will indicate it's utilizing the **make-contribution** skill. -5. Copilot will then follow the instructions in the skill. It will start by running the tests, then create a branch, commits, and eventually the PR. -6. Once the PR is created, return to your repository and open the PR. Note the sections follow the guidelines set forth in the skill, matching the requirements the team put forth. -7. Before moving to the next exercise, reset your local workspace to a fresh branch from `main` so your accessibility work stays separate from this filtering PR: +## Save a checkpoint - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +Once you have reviewed the skill and its results, authorize a local checkpoint: + +```plaintext +Review the current diff and create a checkpoint commit for the quality-checks skill files only. Keep the existing filtering branch. Do not push or create a pull request. +``` ## Summary and next steps -With the help of an agent skill, you created a new PR which matches documented requirements! You: +You've created, inspected, and run a reusable quality-checks skill, including its single-file test example. The skill files will accompany filtering, the QA profile, and associated tests in the feature PR in Exercise 8. Continue in this same checkout to [Exercise 6 - Validate functionality with Playwright MCP][next-lesson]. -- explored an existing skill for creating pull requests. -- learned how skills are utilized by the AI agent. -- created a PR which matches the guidelines with the help of the skill. +## More skill examples -Skills are perfect for tasks, but for more robust operations we want to take advantage of [custom agents][next-lesson], which we'll explore next! +These community examples are references, not additional tasks. Review their prerequisites and behavior before adopting them: -## Resources +- [Contribution workflow: `make-repo-contribution`][contribution-example]. +- [Requirements documents: `prd`][prd-example]. +- [Diagrams and a bundled export script: `drawio`][drawio-example]. +- [Browser testing: `webapp-testing`][browser-example]. -- [About Agent Skills][about-agent-skills] -- [Agent Skills Specification][agent-skills-spec] -- [Agent Skills Repository][agent-skills-repo] -- [Agent Skills on awesome-copilot][awesome-copilot-skills] +The upstream contribution example is named `make-repo-contribution`; older Tailspin templates used a different name, `make-contribution`. This workshop does not depend on either contribution skill. -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/cli/6-custom-agents.md b/docs/cli/6-custom-agents.md deleted file mode 100644 index e7f81dce..00000000 --- a/docs/cli/6-custom-agents.md +++ /dev/null @@ -1,97 +0,0 @@ ---- -title: "Exercise 6 - Custom agents with GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## What are custom agents? - -[Custom agents][custom-agents-concept] in GitHub Copilot allow you to create specialized AI assistants tailored to specific tasks or domains within your development workflow. By defining agents through markdown files in the `.github/agents` folder of your repository, you can provide Copilot with focused instructions, best practices, coding patterns, and domain-specific knowledge that guide it to perform particular types of work more effectively. Teams can codify their expertise into reusable agents — an accessibility agent that enforces [WCAG][wcag] compliance, a security agent that follows secure coding practices, or a testing agent that maintains consistent test patterns. - -Custom agents are defined by markdown files in the `.github/agents` folder of your project, or globally in `~/.copilot/agents`. Each file has YAML frontmatter with at least a `name` and `description`, followed by a markdown prompt that defines the agent's behavior, expertise, and instructions. - -### Custom agents compared with agent skills - -There's some logical overlap between custom agents and [agent skills][agent-skills-concept]. Both are primarily defined with markdown files and tell an AI how to perform operations. The cleanest way to separate them: a **custom agent** is the worker, and **skills** are tools. - -Custom agents have their own context window and are built to orchestrate skills (and even other agents) as part of doing their work. In this lab, the accessibility custom agent reviews and updates the site against accessibility guidelines; as part of that work it could call skills such as a pull-request workflow skill or one that runs and manages tests. - -> [!NOTE] -> There's no single "right" way to author a custom agent. As with anything in AI, test and iterate to find what works for your environments and scenarios. - -## Scenario - -Many web applications fall short of being accessible to all users, and the website you're working in is no exception. You'll use a custom agent to identify and resolve accessibility shortcomings. - -Tailspin Toys is committed to ensuring their crowdfunding platform is accessible to all users, regardless of their visual abilities or preferences. Recent user feedback has highlighted that some users find the current dark theme difficult to read due to insufficient contrast between text and background colors. To address this accessibility concern, the design team has requested the implementation of a high-contrast mode that users can toggle on and off. - -Because accessibility is critical, you want to ensure this is implemented as quickly as possible. You're going to utilize a custom agent to generate the functionality. -In this exercise, you will: - -- explore custom agents. -- enable a custom agent and assign it a task using Copilot CLI. - -## Reviewing the accessibility custom agent - -A custom agent has already been created for you for accessibility. Let's review the contents to understand how it will guide Copilot. - -1. Open `.github/agents/accessibility.md`. -2. Note the YAML frontmatter with the `name` and `description` fields. - -> [!CAUTION] -> The frontmatter with `name` and `description` is required for custom agents. - -3. From there, scan and review the next sections which highlight: - - Core responsibilities when generating code for an accessible website. - - Best practices for accessibility. - - Code examples for HTML, CSS, and JavaScript. - - A list of common pitfalls and mistakes. -## Using a custom agent in Copilot CLI - -You can start a custom agent in Copilot CLI by using the `/agent` command. Let's perform an accessibility pass on our website. - -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/models` and select **Auto**. -3. Bring up the list of agents by typing `/agent` in the prompt window in Copilot CLI and selecting Enter. -4. Select the **Accessibility agent** from the list of available agents. -5. Use the following prompt to ask the accessibility agent to perform a review and generate fixes for the accessibility backlog item: - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -6. Copilot gets to work on the task! It will start by retrieving the issue, then performing the review, generating updates, and finally creating the PR. You should also notice when it creates the PR it utilizes the skill focused on PRs for the project. - -> [!NOTE] -> This process will likely take a few minutes. It's a good time to reflect on everything you've learned, enjoy a beverage, or sneak ahead to the next module which talks about some additional commands available to you in Copilot CLI. - -## Summary and next steps - -This lesson explored [custom agents][custom-agents] in GitHub Copilot, specialized AI assistants tailored to specific tasks and domains. With custom agents you can codify your team's expertise and standards into reusable agents that guide Copilot to perform particular types of work more effectively. - -You explored these concepts: - -- how custom agents are defined. -- using a custom agent in Copilot CLI. - -Next up, let's explore [some slash commands][next-lesson] to learn some additional tricks with Copilot CLI. - -## Resources - -- [Custom agents][custom-agents] -- [Creating custom agents for a repository][creating-custom-agents] -- [Custom agents on awesome-copilot][awesome-copilot-agents] -- [Preparing to use custom agents in your organization][org-custom-agents] -- [Preparing to use custom agents in your enterprise][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ diff --git a/docs/cli/6-mcp-playwright.md b/docs/cli/6-mcp-playwright.md new file mode 100644 index 00000000..abc7f7ac --- /dev/null +++ b/docs/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "Exercise 6 - Validate functionality with Playwright MCP" +description: "Connect a browser through MCP and compare observed filtering behavior with the issue and approved plan." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Your filtering implementation and quality-checks skill already have automated verification. Now give Copilot a browser and ask it to observe the feature directly. This exercise demonstrates **Model Context Protocol (MCP)** interaction, not another full test-suite run. + +Stay in **Interactive** mode on the same filtering checkout and branch. MCP configuration does not start a new feature milestone. + +In this exercise, you will: + +- connect Playwright MCP and confirm its browser tools are available. +- compare actual filtering behavior with the issue and approved criteria. +- review the observations and stop the development server you started. + +## Scenario + +Automated checks have passed, but Tailspin Toys also needs evidence of what visitors experience. You'll give Copilot browser tools to exercise the filters and compare the displayed games with the agreed behavior, rather than treating a responsive control as proof that filtering works. + +## What MCP adds + +[MCP][mcp-overview] connects an agent to external tools and context through servers. The built-in GitHub MCP server lets Copilot work with issues and PRs. The [Playwright MCP server][playwright-mcp] gives it browser tools for opening pages, inspecting accessible elements, navigating, and interacting with controls. + +The browser's accessibility snapshot helps the agent identify controls, but it does not prove complete accessibility compliance. Compare actual actions and observations with the issue's requirements rather than accept a generic “looks good.” + +> [!CAUTION] +> Treat an MCP server like a project dependency: review the publisher, source, permissions, and any package download before enabling it. Organization policies may restrict which servers can run. Do not put credentials in committed configuration or approve unknown tools merely to finish the exercise. + +## Configure Playwright MCP + +1. In your existing CLI session, enter `/mcp` to inspect configured servers. Reuse a working Playwright configuration rather than add a duplicate. +2. If needed, enter `/mcp add` and use Tab to move through the form. +3. Set **Server Name** to `playwright`, **Server Type** to **STDIO** (or **Local**), and **Command** to `npx @playwright/mcp@latest --headless`. +4. Set **Tools** to `*` for this reviewed browser server. This makes its tools available; it does not replace the CLI's permission controls. +5. After reviewing the package and its startup command, press Ctrl+S to save. Registration starts the server and may download the package; approve that setup deliberately and respond to any package prompt. +6. Enter `/mcp show playwright` and confirm that the server is connected and its browser tools are available. + +The headless browser does not need a desktop window, which suits Codespaces. The interactive add flow saves the configuration in `~/.copilot/mcp-config.json` and makes the server available without restarting the CLI. It is user configuration, not a file to include in the feature PR. The [MCP setup guide][mcp-setup] documents the fields and configuration sources. + +> [!NOTE] +> Project E2E dependencies and the MCP browser are related but may require different setup. If a browser or system dependency is missing, inspect the actual error and resolve the specific prerequisite with approval. Do not automatically install browsers or assume a connected server proves it can launch one. + +## Start the correct app + +Open a separate terminal in this same filtering checkout. Confirm the directory and branch, then start the app: + +```bash +pwd +git branch --show-current +npm run dev +``` + +Read the actual local URL from the server output. In the codespace, the MCP server and app run in the same environment, so use that local URL, usually `http://localhost:4321`, rather than assume a forwarded browser URL is required. + +If the port is occupied or Astro chooses another port, identify the server owner before proceeding. Do not reuse an unknown server or terminate it. Use the URL of the process you just started and keep that terminal open while testing. + +## Observe filtering behavior + +Replace the placeholders with the real issue URL, approved clarifications from Exercise 4, and the app URL: + +```plaintext +Use the configured Playwright MCP server to validate the filtering feature against this issue: . These are the clarifications approved during planning: . The app for this checkout is running at . Confirm the checkout, branch, and server under test before relying on its results. + +Open the games page, note the unfiltered state, select one and then multiple categories, apply a publisher filter, and combine category and publisher selections. Exercise clearing and empty-result behavior according to the approved criteria. Check control labels, keyboard operation, and visible focus. Compare the displayed results with the selected filters and source data; do not infer success just because a control changed. + +Use actual browser tool actions and report what you observed for each criterion, with failures or missing evidence clearly marked. Do not run another full test suite solely for this browser exercise, change application code, create tests or customizations, change branches, commit, push, or open a PR. Ask before installing anything or stopping another process. +``` + +Inspect the browser tool calls and the report. Did Copilot really select multiple categories and combine them with a publisher? Do the returned games match the agreed behavior? Does the report distinguish observable browser behavior from data-layer and automated-test coverage? + +If something fails, record the observed behavior. Authorize any focused application fix separately, then repeat the affected browser checks and automated checks. Do not alter the acceptance criteria to match the implementation or count old evidence as verification of changed code. + +## Stop the owned server and continue + +Stop the development server with Ctrl+C in the terminal where you started it. Keep the Playwright MCP configuration available. Exercise 7 will coordinate fresh browser observations and automated E2E checks, which must not reuse a stale development server or another checkout's app. + +## Summary and next steps + +Stay **Interactive** before creating the QA profile. You've observed browser behavior without creating another PR or branch; next, [create and use a QA agent][next-lesson] to combine requirements, coverage, the skill, and final evidence. + +## Resources + +- [Adding MCP servers to Copilot CLI][mcp-setup] documents setup and management. +- [Microsoft Playwright MCP][playwright-mcp] documents browser configuration and tools. +- [GitHub MCP registry][mcp-registry] lists other servers to evaluate. + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/cli/7-qa-agent.md b/docs/cli/7-qa-agent.md new file mode 100644 index 00000000..eec12d81 --- /dev/null +++ b/docs/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "Exercise 7 - Create and use a QA agent" +description: "Create a requirements-first QA profile that combines test coverage, the quality-checks skill, and direct browser evidence." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +You've run repeatable checks and explored filtering through Playwright MCP. Now create a **QA custom agent** to bring the requirements, coverage, and browser evidence together. Keep the filtering session, checkout, and branch; the feature PR comes in Exercise 8. + +In this exercise, you will: + +- create and inspect a requirements-first QA profile. +- select the profile and review coverage, check results, and browser evidence. +- return to the ordinary agent and checkpoint the profile with any justified tests. + +## Scenario + +Tailspin Toys is preparing to ship filtering. Passing tests alone cannot show whether every agreed requirement is covered. The team needs a focused review that compares the issue with the implementation, identifies gaps, and explains whether the feature is ready for review. Your QA profile will guide that assessment without replacing human judgment. + +## Create the QA profile + +Stay in **Interactive** mode. A profile defines a specialist's role and instructions; a skill packages reusable task instructions, scripts, and resources. The QA agent will use your skill and configured MCP tools rather than replace them. + +Send this prompt, then inspect the definition before running it: + +```plaintext +Create a reusable QA custom agent in .github/agents/qa.agent.md. First inspect the repository instructions, package.json, test configuration, and .github/skills/quality-checks/SKILL.md. Give the profile valid YAML frontmatter with the name QA and a description explaining when to use it. Do not pin a model or add a tools list; inherit the harness's available tools and permissions. Create only the agent definition, then stop so I can inspect it before running it. + +In the agent's instructions, require every QA task to start from the issue and any approved acceptance criteria supplied by the user. Treat these requirements as the source of truth, not the implementation. Ask when requirements are missing or ambiguous. Inspect the feature and existing tests, and map each criterion to suitable automated coverage and observable behavior. + +Require direct browser validation through the configured Playwright MCP server and execution of lint, unit tests, end-to-end tests, and type checks through the existing quality-checks skill and its bundled scripts. Read the skill explicitly if it has not been automatically discovered. Report missing skills, MCP tools, prerequisites, or access as blocked; do not silently substitute another workflow or label skipped checks as passes. Identify the checkout and server under test, avoid reusing another worktree's server, stop only servers the agent started, and ask before any installation or stopping another process. + +Allow the QA agent to add the smallest necessary tests for genuine coverage gaps, following repository instructions; no additional tests is valid when coverage is already adequate. Do not weaken assertions, disable failing tests, change acceptance criteria to match the code, or modify application code without my approval. After changes, rerun affected checks and complete final verification of the resulting revision. Require a concise report mapping criteria to evidence and pass/fail/blocked status, listing tests added or explaining why none were needed, reporting all four check results, and identifying unresolved defects. GO requires all required checks and evidence; otherwise report NO-GO with the reason. Do not change branches, commit, push, open or merge PRs, or create additional agents or skills during QA. +``` + +## Inspect the profile + +Open `.github/agents/qa.agent.md` in your editor and inspect the diff. `description` is required; this exercise also supplies the readable `name` of `QA`. Confirm there is no pinned `model` or invented tool list. Omitting `tools` inherits available tools; it does not bypass harness permissions. Production profiles can restrict tools deliberately. + +Confirm the instructions start with requirements, require actual MCP browser activity and skill scripts, allow only justified test additions, and report blockers truthfully. Neither a specialist profile nor a skill requires a separate context window or orchestration of other agents. + +## Run QA against the issue + +The run prompt is for the selected **QA** custom agent, not the default agent reading a profile. Start a fresh CLI conversation in the same checkout to load the new profile without creating another feature branch. + +1. Retain the filtering issue URL and your approved clarifications. Wait for the current agent to finish, then enter `/exit` to return to the terminal. +2. Confirm you are still in the filtering repository directory and on the same branch with `git branch --show-current` and `git status --short`. Do not switch branches or create a worktree. +3. Launch the CLI with the repository profile: + + ```shell + copilot --agent qa + ``` + +4. Verify that the CLI identifies **QA** as the selected agent before running it. The [CLI command reference][cli-reference] documents `--agent`; writing or reading the profile alone is not activation. If selection fails or the agent cannot access the configured Playwright MCP tools and skill, pause and resolve that blocker with your facilitator. + +Replace both placeholders with the actual filtering issue URL and the clarifications approved in Exercise 4, or `none` when the issue is complete. Do not rely on the previous agent's memory. + +```plaintext +Verify the filtering feature against this issue: . These are the additional acceptance criteria I approved during planning: . + +Validate behavior with the Playwright MCP server, inspect test coverage, add tests only for missing coverage, and run validation through the quality-checks skill. Report evidence, check results, and blockers. Do not change application code without my approval, create a commit, or open a pull request. +``` + +## Review the evidence + +Check the report against the issue: each criterion needs appropriate automated coverage and observable behavior. Inspect actual Playwright MCP tool activity, the checkout/server identity, and all four skill-script results. Browser checks and automated E2E must not reuse a stale server or another checkout. + +Review any added tests: they should close genuine gaps without weakening assertions. No new tests is correct when coverage is adequate. A blocked or failed **NO-GO** verdict is a valid outcome, not permission to skip evidence. + +If QA identifies an application defect, approve a focused fix separately and rerun affected checks and browser observations on the resulting revision. Missing prerequisites or tools need an explicit resolution. Do not treat older evidence as proof of changed code. + +## Save a checkpoint + +When QA has finished, retain its report with the issue URL, approved clarifications, tested revision, browser observations, and check results. Enter `/exit`, then launch `copilot` without `--agent` from the same directory and branch to return to a normal conversation. Provide that context again; the fresh conversation does not inherit the QA conversation's evidence. + +When you have reviewed the profile, any test changes, and the resulting evidence, send the following request to the normal agent: + +```plaintext +Review the current diff and create a checkpoint commit for the QA agent definition and any approved test changes. Stay on the existing filtering branch. Do not push or open a pull request. +``` + +## Summary and next steps + +You've created and selected a QA profile, reviewed its evidence, and saved the profile with any justified tests. Carry unresolved findings forward; a failed or blocked verdict is not merge approval. Continue to [Exercise 8 - Create and merge the feature PR][next-lesson] with the filtering feature, skill, QA profile, tests, and current verification evidence. + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/cli/7-slash-commands.md b/docs/cli/7-slash-commands.md deleted file mode 100644 index 6f67591f..00000000 --- a/docs/cli/7-slash-commands.md +++ /dev/null @@ -1,161 +0,0 @@ ---- -title: "Exercise 7 - Slash commands in GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Like any good CLI tool, GitHub Copilot CLI includes many slash commands to interact with it. These commands expose advanced functionality, "behind-the-scenes" information, or additional configuration options. You've already explored a couple with `/clear` to clear context and `/mcp` to inspect MCP servers. Let's explore a couple of other powerful ones, including `/context`, `/model`, `/share`, and `/delegate`. - -## Scenario - -You've wrapped the core CLI flows. Now let's look at a few additional capabilities — sharing sessions, switching models, and delegating tasks to [Copilot cloud agent][about-cloud-agent]. - -In this exercise you will use: - -- `/share` to create a GitHub gist to share your session with the team. -- `/context` to see the context Copilot CLI is currently using. -- `/model` to explore the list of available models and select a new one if you so desire. -- `/delegate` to optionally hand off a task to cloud agent. This requires cloud agent, available on Copilot Student, Pro, Pro+, Business, or Enterprise — every plan except Copilot Free. - -## Sharing a session - -Using any tool, including an AI tool, is a skill. Working together as a team, sharing learnings with each other, is the best way to help improve everyone's experience and generate higher quality code. To support this, Copilot CLI provides a `/share` command. The `/share` command can generate a markdown file or GitHub gist with the details of the session, including the prompts used and logic Copilot followed. - -Let's create a GitHub gist we could share with our team. - -1. Return to your codespace. If you closed it, navigate to your repository on GitHub.com, select **Code** > **Codespaces**, then reopen your existing codespace. -2. Return to your open Copilot CLI session. If the terminal is closed or you exited Copilot CLI, open a terminal by selecting Ctrl+\`, then start it from the repository root by running `copilot --yolo --enable-all-github-mcp-tools`. Trust the project folder if prompted, then run `/model` and select **Auto**. -3. In the prompt window for Copilot CLI, send the following command: - - ``` - /share gist - ``` - -4. In just a couple of moments, Copilot will create a gist and display the link. -5. Copy the link text. -6. In a new browser tab, paste the link to explore the gist. Note how the gist highlights the prompts sent, skills and agents used, Copilot's thought process, and even the code and results from locally run commands. - -The gists and markdown files generated by `/share` can be used for documentation purposes of how code was generated, or to share with your team about how certain actions were performed that generated the desired results from Copilot. - -## Exploring Copilot CLI's context - -When working on larger or more complex tasks you may bump into the maximum context window for the model. The exact size of the window will vary based on the model being used and the version of Copilot CLI. When the context window is maxed out, Copilot CLI will automatically compact it, summarizing information and removing anything it deems isn't relevant to the current task. You can both see the current state of the context and manually compact the context by using slash commands. Let's explore the context window. - -1. In the prompt window for Copilot CLI, send the following command: - - ``` - /context - ``` - -2. In just a couple of moments, Copilot CLI will generate a visual representation of its current context: - - ![Screenshot of context window from Copilot CLI](../_images/cli-7-context-window.png) - -3. Note the model displayed (which may be different than the one in the image), and the current percentage of tokens used. The rest of the information highlights: - - | Title | Description | - | ------------ | ------------------------------------------------------ | - | System/Tools | Instructions files, file contents and tool definitions | - | Messages | Conversation history between you and Copilot | - | Buffer | Reserved space by Copilot CLI for generating responses | - | Free space | Remaining free space | - -4. Compact the conversation history by sending the following slash command to Copilot CLI: - - ``` - /compact - ``` - -5. Once completed, send the following command to display the current context stats again: - - ``` - /context - ``` - -6. Note the change in context. There might not be a drastic change as the context window is likely relatively small at the moment. - -> [!NOTE] -> Copilot CLI will automatically compact when it becomes full. As it approaches 100% capacity it will display the percentage just above the prompt window. Normally it will compact asynchronously, allowing you to continue interacting with Copilot while it does its work. It may however block a running operation for several seconds while performing its work. - -### Best practices with context - -In most sessions with Copilot context will be managed efficiently by Copilot itself without any specific guidance. However, there may be instances when you decide to manually instruct Copilot to either clear or compact its history: - -- If you are changing to a different part of the application, or to an unrelated task, you can use `/clear` to start new to avoid confusing Copilot with older, unrelated context. -- If you are approaching the maximum context window, you can manually `/compact` your context to control when it happens. - -> [!CAUTION] -> Again, the majority of the time, Copilot will manage its context without direct interaction from you. If you notice Copilot is a bit confused by older information, or are about to switch to an unrelated task, then you might consider using the manual commands. - -## Choosing your model - -Different models have different strengths, and different developers have different preferences. Copilot CLI allows you to list and select the model you wish to use! - -1. Display the list of models by sending the following slash command to Copilot CLI: - - ``` - /model - ``` - -2. Note the list of models. Each model will have both its name and cost-per-request modifier listed next to it. -3. If you wish, select a new model! Or select Esc to exit the model list. - -> [!CAUTION] -> Model selection persists in Copilot CLI. - -## Delegating to cloud agent (optional) - -There are times when you want to keep working in your terminal but hand off a longer-running task to Copilot cloud agent. The `/delegate` command sends the current Copilot CLI session to GitHub.com, where cloud agent picks it up, works asynchronously, and opens a pull request when done. - -> [!NOTE] -> `/delegate` requires cloud agent, available on Copilot Student, Pro, Pro+, Business, or Enterprise — every plan except Copilot Free. If you don't have access, read through this section and skip the hands-on steps. - -1. Clear the current session first so accumulated workshop context isn't delegated: - - ``` - /clear - ``` - -2. Send a small, well-scoped prompt. For example, you could delegate the stretch-goal pagination from your backlog: - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. Send the following slash command to hand the session to cloud agent, and confirm the prompt you want to delegate: - - ``` - /delegate - ``` - -4. Open [Copilot agents](https://github.com/copilot/agents) in a browser to monitor progress. -5. You don't need to wait for the pull request to complete in this harness; you can return to it later. If you want to dig deeper into managing asynchronous agent work, continue with the [Cloud agent harness](../../cloud/). - -## Summary and next steps - -Using slash commands in Copilot CLI allows you to configure it, share sessions, and get internal information about how Copilot's working. In this lesson you used or explored: - -- `/share` to create a GitHub gist to share your session with the team. -- `/context` to see the context Copilot CLI is currently using. -- `/model` to explore the list of available models and select a new one if you so desire. -- Learned about `/delegate` as an optional bridge to cloud agent. - -There are of course more slash commands available, and more to explore with Copilot CLI! Let's close out our journey by [reviewing what we've learned][next-lesson] and some next steps to continue learning. - -## Resources - -- [Using Copilot CLI][using-copilot-cli] -- [About Copilot CLI][about-copilot-cli] -- [Context Management in Copilot CLI][context-management] -- [Share Sessions with Copilot CLI][share-sessions] -- [Selecting Models in Copilot CLI][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm diff --git a/docs/cli/8-create-pull-request.md b/docs/cli/8-create-pull-request.md new file mode 100644 index 00000000..1fdb00a5 --- /dev/null +++ b/docs/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "Exercise 8 - Create and merge the feature PR" +description: "Review the full filtering milestone, reuse current QA evidence, and merge the third pull request after CI and review." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Now bring the filtering milestone together in PR 3. Stay on the branch and checkout used in Exercises 4–7. It contains the filtering implementation, quality-checks skill and scripts, QA profile, and associated tests. + +In this exercise, you will: + +- review the complete milestone diff and current QA evidence. +- request one feature PR and inspect its checks and review feedback. +- explicitly merge the reviewed PR and update local `main`. + +## Scenario + +The filtering work is spread across several checkpoints, but reviewers need to assess one complete feature. Tailspin Toys wants a PR that connects the requirements, implementation, reusable checks, and QA findings. You'll prepare that handoff and resolve blockers before merging. + +This is a normal scoped PR request using the repository's conventions. It does not require a contribution skill. + +> [!NOTE] +> A production team might separate a feature from reusable quality infrastructure. This workshop combines them deliberately to show the complete workflow in one feature PR. The earlier star-rating and instructions PRs should already be merged into `main`, not appear again as unrelated work. + +## Check readiness and evidence + +1. Review the QA verdict and its requirement-to-evidence mapping. A **NO-GO**, missing browser evidence, or skipped required check is a blocker to resolve before merging. +2. Confirm all four checks actually ran through the quality-checks skill: lint, unit tests, E2E, and type checks. +3. Review the tested revision and any changes since those checks. Reuse the current QA evidence only while the tested code, tests, and verification scripts remain unchanged. A checkpoint commit alone does not invalidate identical file contents, but code changes do. +4. If the implementation or tested inputs changed, run the relevant skill checks and browser observations again and update the evidence. Do not rerun the entire suite solely because you are opening a PR when current QA results still apply. +5. Inspect the full branch diff, not just the latest checkpoint or uncommitted changes. + +From another terminal in the same checkout: + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +The three-dot diff shows this branch's changes since its common ancestor with `origin/main`, including earlier checkpoints. Verify it includes only the intended filtering milestone. Inspect new files too; unexpected untracked or uncommitted files must be reviewed before staging. + +## Request PR 3 + +Exercise 7 returned you to a normal **Interactive** session before the checkpoint. Continue in that established session if the QA profile is no longer active and the filtering checkout and branch are unchanged. Keep the issue URL, approved planning clarifications, and current QA report, including the tested revision and check results, available. + +The QA profile prohibits commit and PR actions during QA. If it is still active, return to a normal session before requesting the PR: + +1. Wait until QA is idle, then enter `/exit` at its CLI prompt. If the CLI remains open because another session is active, finish or preserve that work before returning to the normal prompt and pressing Ctrl+D to shut down this CLI instance. +2. At the shell prompt, stay in the same filtering checkout and branch. Confirm their identity, then start a fresh normal session without `--agent qa` or a resume flag: + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. Confirm you are in **Interactive** mode and the QA profile is no longer active. Do not create another worktree, change branches, or resume the QA session. + +Replace all placeholders below with the real issue URL, approved clarifications, and current QA evidence. Supply them explicitly even if you stayed in the normal session from Exercise 7; a fresh conversation must not rely on the QA session's memory. + +```plaintext +Prepare the filtering feature PR for this issue: . These are the additional acceptance criteria I approved during planning: . This is the current QA evidence: . + +Confirm the checkout and current filtering branch. Inspect the full diff against main, all milestone checkpoint commits, git status, the repository PR template, and the supplied QA evidence. Include only the reviewed filtering implementation, quality-checks skill and bundled scripts, QA agent definition, and associated tests. + +Reuse the QA results while they still describe the final file contents. If code, tests, or verification scripts changed afterward, report that and run the relevant checks through the skill and affected browser validation before presenting them as current. Do not label failed, blocked, or skipped checks as passes. + +Commit any remaining reviewed milestone changes if needed, push this current branch, and create one PR into main following the repository conventions. Include the issue and approved criteria, implementation summary, tests added or why none were needed, browser observations, all four check results, and remaining limitations. Do not merge, create another branch, invoke a contribution skill, or start another feature. +``` + +## Review the PR and CI + +Open the returned URL and inspect **Files changed** across the entire PR. Check that the skill's scripts and QA profile are included, and that no credentials, local MCP configuration, unrelated files, generated reports, or dependency installs slipped into the diff. + +Use the PR's **Checks** tab, or run these commands in the terminal on the feature branch: + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +Inspect your repository's `.github/workflows/` rather than assume a green badge covers every kind of verification. The current Tailspin **Run tests** workflow runs lint, type checks, Vitest unit tests, and Playwright E2E tests against the built static site. It does not substitute for the direct MCP browser observations in your QA report. The workshop site's Astro build and link checks validate a different repository. + +If a check fails, inspect its logs and address the cause. A focused fix must be reviewed and reverified on the updated revision before pushing. If `main` changes and resolving a conflict changes the feature, refresh the affected evidence too. Wait for any required human review; an agent's own approval does not override branch protection. + +## Merge and update local main + +When the PR meets all review and check requirements, explicitly choose **Merge pull request** on GitHub and confirm the merge. Verify PR 3 is **Merged**. + +Exit the CLI session with `/exit`. With a clean working tree, update the local checkout: + +```bash +git status +git switch main +git pull --ff-only +``` + +## Summary and next steps + +No new branch is needed for the next exercise. You have now merged exactly three workshop PRs: star ratings; instructions and a demonstration; filtering with the quality skill, QA profile, and tests. + +Continue to [Exercise 9 - Explore slash commands and CLI options][next-lesson] for a bounded tour of CLI controls, not another implementation task. + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/cli/8-review.md b/docs/cli/8-review.md deleted file mode 100644 index c85138c5..00000000 --- a/docs/cli/8-review.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Exercise 8 - Review and Next Steps" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Over the last several exercises, you explored some of the most common use cases for GitHub Copilot CLI, including: - -- interacting with GitHub and other MCP servers. -- using instructions files to guide code generation. -- implementing skills to add tools to the Copilot CLI toolbox. -- calling custom agents for advanced and more complex tasks. -- using slash commands to manage your session, and optionally bridging back to cloud agent via `/delegate`. - -Let's talk about some slash commands, best practices, and next steps. - -## Slash commands - -Copilot CLI has a series of slash commands available to interact with it, including ones which allow you to configure it or see what's going on behind the scenes. You've already used `/clear` to start a new chat which clears the current context, and `/mcp` to inspect and manage MCP servers. Some additional ones you might find helpful are: - -| Command | Description | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | Add a directory to the trusted list for Copilot | -| `/clear`, `/new` | Clear the conversation history and start fresh | -| `/compact` | Summarize conversation history to reduce context window usage | -| `/context` | Show context window token usage and visualization | -| `/diff` | Review the changes made in the current directory | -| `/model` | Select AI model to use (Claude Sonnet, GPT-5, etc.) | -| `/plan ` | Create an implementation plan before coding | -| `/review ` | Run code review agent to analyze changes | -| `/delegate` | Delegate task to Copilot cloud agent for async processing | -| `/session` | Show session info and workspace summary | -| `/share` | Share session to markdown file or GitHub gist | -| `/skills` | Manage skills for enhanced capabilities | -| `/usage` | Display session usage metrics and statistics | - -> [!TIP] -> Use `/help` to see the full list of available commands and keyboard shortcuts. - -## Best practices - -When using any AI tool, the underlying infrastructure drives the quality of what you get out. Robust instructions files, custom agents, and agent skills all play a part — you explored each of them in this workshop. [awesome-copilot][awesome-copilot] is a good source of templates, and Copilot itself can scaffold these for you as a starting point. - -Context still matters as much as infrastructure. Clearly describing *what* you want built, *why*, and *how* meaningfully changes the output. If a piece of information would help Copilot, pass it along. - -## Next steps - -The best way to improve your skills with any tool is to keep using the tool! Use it for production code, for hobby code, for the little app you've had in your mind for years but never got around to building. Share your learnings with your team, and learn from your team. And, as always, explore the documentation. - -If you'd like to explore more of the GitHub Copilot ecosystem, check out the [VS Code harness](../../vscode/) or the [Cloud agent harness](../../cloud/). - -## Resources - -- [About Copilot CLI][about-copilot-cli] -- [Using Copilot CLI][using-copilot-cli] -- [Awesome Copilot Repository][awesome-copilot] -- [Custom Instructions Guide][repo-instructions] -- [Agent Skills Documentation][agent-skills] -- [Custom Agents Documentation][custom-agents] -- [MCP Specification][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ diff --git a/docs/cli/9-slash-commands.md b/docs/cli/9-slash-commands.md new file mode 100644 index 00000000..afe26be8 --- /dev/null +++ b/docs/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "Exercise 9 - Explore slash commands and CLI options" +description: "Inspect context, model and session controls, review sharing destinations, and explore CLI flags without launching another feature." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +The three PR milestones are complete. Now explore the CLI controls that help you understand and manage a session. This exercise does not implement another feature, delegate work, or open another PR. + +In this exercise, you will: + +- inspect context, usage, model, and mode controls. +- compare command-line options with your installed version's help. +- export a session locally and review it before sharing anything. + +## Scenario + +With the feature shipped, you want to understand the CLI controls you'll use in daily work. You'll inspect a session and its sharing options without starting another task, so that managing context or exporting a conversation does not accidentally authorize work or disclose project information. + +From the updated learner checkout, start `copilot` in **Interactive** mode. Use `/help` and the [command reference][cli-reference] to confirm which commands your installed version supports; current documentation can describe newer controls than your installation. + +## Inspect context and session information + +1. Send a bounded, read-only request: + + ```plaintext + Summarize the repository's instruction files, quality-checks skill, and QA profile. Explain how they support filtering verification. Do not modify files, execute checks, delegate work, commit, or open a PR. + ``` + +2. Enter `/context` to inspect context-window usage. Notice how messages, instructions, and tool definitions consume context. +3. Enter `/compact`, then `/context` again. Compaction summarizes history to reduce its size; a short session may show little change. +4. Enter `/session` to inspect the current session, and `/usage` to inspect usage information. + +Compaction is not a substitute for supplying requirements. When changing tasks or agents, carry forward the issue URL, approved criteria, checkout identity, and relevant evidence explicitly. + +`/clear` starts a new conversation; it does not undo files or switch Git branches. `/resume` opens the session picker for returning to prior work. Explore the picker, then press Esc to leave it without resuming another task. Do not clear the only copy of acceptance criteria or assume a resumed conversation means its old verification is still current. + +## Inspect models and modes + +Enter `/model` to inspect models available to your account, including **Auto** where offered. Read the selection details and usage information; model availability and pricing can change. Press Esc to leave the picker without changing the model. If you do change it, confirm the displayed selection and the scope your CLI version applies. + +Use Shift+Tab to inspect the mode indicator as you cycle between **Interactive**, **Plan**, and **Autopilot**, then return to **Interactive** without sending an implementation prompt. Recall the distinction: + +- Plan is for agreeing the work before coding. +- Autopilot continues through an approved, bounded task. +- Interactive gives you deliberate review and decision points. +- Permissions separately control which tool actions are allowed. + +## Inspect command-line options + +In a separate terminal, run: + +```bash +copilot --help +``` + +Compare these documented options with the help for your installed version: + +| Option | Purpose | +| --- | --- | +| `--model MODEL` | Choose the model for an invocation; confirm availability first | +| `--agent AGENT` | Select a custom agent for an invocation | +| `-p PROMPT` | Run a prompt programmatically and exit when it completes | +| `--output-format json` | Emit structured JSONL output, one JSON object per line | +| `--resume` | Resume an existing session | +| `--enable-all-github-mcp-tools` | Expose the full built-in GitHub MCP tool set | + +These are controls to understand, not another task to launch. Programmatic mode can execute real tool actions; a JSON output format does not make a request read-only. Agent selection is the verified workflow from [Exercise 7][qa-lesson], not a reason to replace custom-agent activation with a default-agent request to read the profile. Permissions and access still apply. + +## Review before sharing + +`/share` can send session content to different destinations. The [CLI command reference][cli-reference] documents `/share file [session|research] [PATH]` for Markdown export and `/share gist [session|research]` for gist publishing. With no subcommand, the current documented behavior creates a shareable GitHub link when logged in and synced, falling back to a Markdown export otherwise. Do not run the bare command while assuming it only previews content. + +For this workshop, explicitly select a local session export and filename rather than publishing: + +```text +/share file session cli-session-review.md +``` + +Open the exported file in your editor and inspect what it actually contains. Review prompts, responses, tool output, file paths, repository data, and any credentials or personal information. Do not assume the export contains every internal step or that it has automatically removed sensitive content. + +> [!CAUTION] +> A gist or shared link is an external disclosure. A secret gist is not private access control: anyone with its URL can view it. Confirm the destination, recipients, permissions, and your organization's policy before sharing. If redaction is needed, share only the reviewed, redacted artifact through an approved channel; do not publish the original session afterward. + +Keep this export out of the feature PR and repository history. After inspecting it, remove the file you just generated or move it to your approved local notes location. Do not remove unrelated files. + +Cloud delegation can create remote work and an additional PR, so do not run `/delegate` here. The [Cloud agent workshop][cloud-workshop] covers that separate workflow. + +## Summary and next steps + +You've inspected context, usage, model and mode controls, command-line options, and sharing destinations without starting another feature. Continue to [Exercise 10 - Wrap-up and next steps][next-lesson] to review the workflow and artifacts you've built. + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/cli/README.md b/docs/cli/README.md index 2ca8e6f9..76d55135 100644 --- a/docs/cli/README.md +++ b/docs/cli/README.md @@ -3,12 +3,12 @@ slug: cli title: "GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- **[GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)** puts GitHub Copilot in your terminal as an agentic coding assistant. It explores codebases, generates code, runs commands, and connects to external tools — all from the command line, so you can stay in the flow without switching to a graphical editor. -Across these exercises you'll install and authenticate Copilot CLI, then give it project context with custom instructions before using plan mode to generate a feature deliberately. You'll connect the Playwright MCP server to test that feature in a real browser, then extend Copilot with reusable agent skills and custom agents. Finally, you'll explore slash commands for managing context, models, and sharing, and wrap up with a review of what you've built. +After setup in Exercises 0–1, you'll complete nine core modules in Exercises 2–10. Start with a star-rating quick win, establish documentation instructions, and build filtering with **Plan** and **Autopilot** modes. Then create a reusable quality-checks skill, validate behavior with Playwright MCP, create a QA agent, and ship the feature. Finish by exploring CLI controls and reviewing what you've built. ## Exercises @@ -16,13 +16,21 @@ Across these exercises you'll install and authenticate Copilot CLI, then give it |----------|-------|-------------| | [0. Prerequisites][ex0] | Setup | Create your repository and codespace | | [1. Installing Copilot CLI][ex1] | Installation | Install and authenticate Copilot CLI | -| [2. Custom instructions][ex2] | Context | Add an instruction and see how Copilot CLI follows it | -| [3. Generating Code][ex3] | Code Generation | Use plan mode and generate features | -| [4. Testing with Playwright MCP][ex4] | External Tools | Add the Playwright MCP server and test your feature in a browser | -| [5. Agent Skills][ex5] | Skills | Enhance Copilot with specialized skills | -| [6. Custom Agents][ex6] | Agents | Review and use custom agents | -| [7. Slash Commands][ex7] | CLI Features | Explore context, models, sharing, and optional delegation to cloud agent | -| [8. Review][ex8] | Summary | Review key concepts and next steps | +| [2. Add star ratings: a quick win][ex2] | First change | Display existing ratings, validate, and merge PR 1 | +| [3. Guide Copilot with custom instructions][ex3] | Context | Add a documentation convention, demonstrate it, and merge PR 2 | +| [4. Build filtering with Plan and Autopilot][ex4] | Implementation | Review a plan, approve Autopilot, test, and checkpoint | +| [5. Create and use a quality-checks skill][ex5] | Skills | Generate, inspect, and run shell-bundled checks | +| [6. Validate functionality with Playwright MCP][ex6] | Browser tools | Observe filtering behavior in a real browser | +| [7. Create and use a QA agent][ex7] | Agents | Audit requirements and coverage, then collect final evidence | +| [8. Create and merge the feature PR][ex8] | Delivery | Review filtering and reusable customizations together in PR 3 | +| [9. Explore slash commands and CLI options][ex9] | CLI controls | Inspect context, models, sessions, and sharing destinations | +| [10. Wrap-up and next steps][ex10] | Summary | Review common artifacts and the three PR milestones | + +## Branches and pull requests + +You'll merge three pull requests: star ratings; instructions and a small demonstration; then filtering with the quality-checks skill, QA profile, and associated tests. Merge each of the first two PRs before starting the next milestone from updated `main`. + +Exercises 4–8 share one feature branch and checkout. Save checkpoint commits along the way; skill creation, MCP setup, and QA selection do not start new feature branches. Exercise 9 explores controls without launching another feature or PR. ## Prerequisites @@ -44,11 +52,13 @@ Before attending this workshop, please ensure you have: [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ [callout-student-plan-education]: https://github.com/education/students diff --git a/docs/es-es/README.md b/docs/es-es/README.md index 8faf6ff8..e6fa03a4 100644 --- a/docs/es-es/README.md +++ b/docs/es-es/README.md @@ -3,7 +3,7 @@ slug: es-es title: "Manos a la obra con los agentes de GitHub Copilot" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Las recientes ampliaciones de las capacidades de GitHub Copilot ofrecen a los desarrolladores herramientas potentes para todo el ciclo de vida del desarrollo de software (SDLC). Estas capacidades incluyen trabajar con incidencias y solicitudes de incorporación de cambios en GitHub, interactuar con servicios externos y, por supuesto, crear código. En este laboratorio se exploran estas funciones mediante casos de uso reales y consejos para aprovechar al máximo las herramientas. @@ -17,19 +17,19 @@ Las recientes ampliaciones de las capacidades de GitHub Copilot ofrecen a los de GitHub Copilot te acompaña allí donde trabajes. Elige el entorno que se ajuste a tu forma de desarrollar y completa sus ejercicios con el trabajo pendiente compartido de Tailspin Toys. Cada entorno comienza con su propia configuración para que puedas empezar directamente con el que elijas. -### 🖥️ [VS Code](../vscode/) +### 🖥️ [VS Code](vscode/) GitHub Copilot dentro de **Visual Studio Code** y GitHub Codespaces. Trabaja con el modo agente de Copilot Chat, servidores MCP y agentes personalizados sin salir del editor que ya utilizas. Es ideal si quieres integrar la asistencia de IA directamente en el IDE. ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI** es un asistente basado en agentes que se ejecuta en el terminal. Instálalo, conecta servidores MCP, genera código con el modo de planificación y crea tus propias skills, agentes personalizados y comandos con barra diagonal, todo desde la línea de comandos. +**GitHub Copilot CLI** es un asistente basado en agentes que se ejecuta en el terminal. Tras la configuración, sigue nueve módulos principales: entrega una mejora rápida de valoraciones por estrellas, establece instrucciones, planifica y crea el filtrado, crea una habilidad quality-checks, valida mediante MCP de Playwright, crea un agente QA y combina la funcionalidad. Termina con los controles de CLI y un resumen. El flujo tiene tres hitos de solicitudes de incorporación de cambios. ### 🤖 [Copilot App](app/) La **aplicación GitHub Copilot** es una aplicación de escritorio basada en Copilot CLI. Sigue la misma configuración y los nueve módulos principales del flujo de valoraciones por estrellas, instrucciones, filtrado, habilidad, MCP, QA y PR de la funcionalidad, mediante las sesiones aisladas de la aplicación y **Agent Merge**. Crea y combina un lienzo guardado en el repositorio como cuarto hito de solicitudes de incorporación de cambios y termina con el resumen. -### ☁️ [Copilot Cloud Agent](../cloud/) +### ☁️ [Copilot Cloud Agent](cloud/) El **agente de Copilot en la nube** es un compañero de programación asíncrono que trabaja en segundo plano en las incidencias de GitHub. Asígnale trabajo, guíalo con agentes personalizados, supervisa el progreso desde el panel de agentes y revisa las solicitudes de incorporación de cambios que abre. diff --git a/docs/es-es/cli/0-prerequisites.md b/docs/es-es/cli/0-prerequisites.md index 383b011b..5fcd4b8c 100644 --- a/docs/es-es/cli/0-prerequisites.md +++ b/docs/es-es/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "Ejercicio 0: Requisitos previos" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Antes de empezar los ejercicios de Copilot CLI, tienes que dejarlo todo preparado. Crearás tu propia copia del repositorio Tailspin Toys y pondrás en marcha un [codespace][codespaces], cuyo terminal integrado usarás para instalar y ejecutar Copilot CLI en el siguiente ejercicio. +En este ejercicio: + +- crearás tu propio repositorio a partir de la plantilla de Tailspin Toys. +- abrirás un codespace y confirmarás que el espacio de trabajo está listo para configurar CLI. + ## Configurar el repositorio del laboratorio Para crear una copia del repositorio para el código que vas a crear, generarás una instancia a partir de la [plantilla][template-repository]. La nueva instancia contendrá todos los archivos necesarios para el laboratorio y la usarás a medida que avances por los ejercicios. +Utiliza una copia nueva de la plantilla. Incluye instrucciones del repositorio, código de la aplicación, pruebas y CI, pero no agentes personalizados ni habilidades. Crearás esos recursos tú mismo. Si vuelves a una copia anterior, examina las personalizaciones existentes antes de cambiarlas; no sobrescribas tu trabajo. + 1. En una nueva ventana del navegador, ve al repositorio de GitHub de este laboratorio: `https://github.com/github-samples/tailspin-toys`. 2. Crea tu propia copia del repositorio seleccionando el botón **Use this template** en la página del repositorio del laboratorio. Después, selecciona **Create a new repository**. @@ -27,6 +34,8 @@ Para crear una copia del repositorio para el código que vas a crear, generarás > > Cuando creas tu repositorio a partir de la plantilla, se crea automáticamente un backlog de incidencias de GitHub para ti. Trabajarás con esas incidencias durante todo el taller; no tienes que crear ninguna por tu cuenta. +Espera a que termine el flujo de creación inicial de incidencias y comprueba en la pestaña **Issues** que aparecen **Allow users to filter games by category and publisher** y **Update our repository coding standards**. Utiliza sus títulos y URL reales en las lecciones, no números de incidencia supuestos. Si falta la lista de incidencias, examina el resultado del flujo antes de continuar. + ## Crear un codespace Ahora usarás un codespace para completar los ejercicios del laboratorio. @@ -53,6 +62,8 @@ La creación del codespace tardará varios minutos, aunque sigue siendo mucho m [codespaces]: https://github.com/features/codespaces [dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers +Cuando el codespace esté listo, el [Ejercicio 1][next-lesson] abrirá su terminal y comprobará el repositorio, el entorno de ejecución y la autenticación antes de instalar Copilot CLI. + ## Resumen ¡Enhorabuena! Has creado una copia del repositorio del laboratorio. También has iniciado el proceso de creación de tu codespace, que usarás cuando empieces a trabajar con Copilot CLI. diff --git a/docs/es-es/cli/1-install-copilot-cli.md b/docs/es-es/cli/1-install-copilot-cli.md index c1a08af2..b1cab318 100644 --- a/docs/es-es/cli/1-install-copilot-cli.md +++ b/docs/es-es/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "Ejercicio 1 - Instalar GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [GitHub Copilot CLI][about-copilot-cli] es un potente asistente de programación con agentes que se ejecuta en tu terminal y te permite explorar bases de código, generar código, ejecutar comandos e interactuar con herramientas externas, todo desde la línea de comandos. Te permite delegar tareas, solicitar cambios y mantener la concentración. Como imaginarás, el primer paso es instalar la herramienta. Por suerte, puedes hacerlo con herramientas que ya conoces. @@ -21,10 +21,25 @@ Tu equipo está empezando a usar agentes de IA para gestionar un backlog cada ve Antes de instalar Copilot CLI, tienes que abrir una ventana de terminal en tu codespace. -1. Vuelve a tu codespace si todavía no estás allí. +1. Vuelve a tu codespace y espera a que termine su configuración. 2. Abre una ventana de terminal pulsando Ctrl+\`. 3. Deberías ver un panel de terminal en la parte inferior de la ventana de VS Code. +## Confirmar el entorno del participante + +En la terminal del codespace, confirma que estás en tu propio repositorio Tailspin Toys, no en el repositorio de contenido del taller. Lee su `README.md` y `package.json` para conocer la configuración y los comandos de comprobación. Tailspin Toys requiere actualmente Node.js 22.13 o posterior, las dependencias del proyecto y Chromium de Playwright para las pruebas E2E. + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +GitHub CLI (`gh`) te ayudará a examinar PR y CI. Si falta autenticación, utiliza `gh auth login` y sigue sus instrucciones del navegador. Confirma que tu cuenta puede enviar ramas y crear y combinar PR en este repositorio; las directivas de la organización pueden exigir otro revisor. Resuelve los requisitos previos ausentes siguiendo las instrucciones de configuración del repositorio antes de cambiar código y revisa cualquier instalación antes de autorizarla. + +CLI se ejecuta sobre la copia de trabajo desde la que lo inicias; empezar una conversación no crea automáticamente un worktree aislado. Este taller utiliza una rama por hito de PR. Primero combinarás las valoraciones por estrellas y la demostración de instrucciones, y después mantendrás la misma rama de filtrado durante los Ejercicios 4–8. + ## Instalar Copilot CLI Puedes instalar Copilot CLI mediante [npm][install-npm], [WinGet][install-winget] y [Homebrew][install-homebrew]. Como GitHub Codespaces incluye Node.js preinstalado, usarás npm para instalar Copilot CLI. @@ -35,7 +50,7 @@ Puedes instalar Copilot CLI mediante [npm][install-npm], [WinGet][install-winget node --version ``` - Deberías ver la versión 22 o posterior (por ejemplo, `v22.x.x`). + Tailspin Toys requiere la versión 22.13 o posterior, aunque el requisito de CLI sea distinto. Sigue las instrucciones de configuración del repositorio del participante si tu versión es demasiado antigua. 2. Instala Copilot CLI globalmente en el codespace con npm: @@ -51,8 +66,8 @@ Puedes instalar Copilot CLI mediante [npm][install-npm], [WinGet][install-winget Deberías ver el número de versión mostrado (por ejemplo, `v1.0.XX`). -> [!TIP] -> Si encuentras errores de permisos, puede que necesites usar `sudo npm install -g @github/copilot` en algunos sistemas. Sin embargo, en GitHub Codespaces no debería ser necesario. +> [!NOTE] +> Si la instalación falla por un error de permisos, examina la configuración de npm o pide ayuda a la persona que dirige el taller en lugar de volver a ejecutar un comando desconocido con privilegios elevados. ## Autenticarse con GitHub @@ -85,22 +100,39 @@ Ahora que estás en el prompt de Copilot CLI por primera vez, vamos a marcar com 2. Para este taller, selecciona **Yes, and remember this folder for future sessions**, ya que trabajarás en este repositorio durante toda la sesión. 3. Haz a Copilot una pregunta sencilla para verificar que funciona: - ``` - What files are in this project? + ```plaintext + ¿Qué archivos hay en este proyecto? ``` 4. Copilot debería explorar el repositorio y ofrecer un resumen de la estructura del proyecto. 5. Prueba el comando `/help` para ver los comandos de barra disponibles: - ``` + ```text /help ``` -6. Sal de Copilot CLI introduciendo el siguiente comando en el terminal. Volveremos a Copilot CLI en un ejercicio posterior. +6. Sal de esta sesión introduciendo el siguiente comando en el prompt de Copilot. Iniciarás una sesión nueva para el primer cambio. + ```text + /exit ``` - exit - ``` + +## Comprender modos y permisos + +Copilot CLI trabaja en el directorio y la rama de Git donde lo inicias. Confiar en un directorio le permite utilizar el contexto del repositorio; no equivale a aprobar todas las acciones de herramientas. Revisa las solicitudes de permiso para cambios de archivos, comandos de shell y operaciones de GitHub. + +Inicia los ejercicios de código desde la raíz del repositorio del participante con: + +```bash +copilot --enable-all-github-mcp-tools +``` + +El servidor MCP de GitHub está integrado. Esta opción expone todas sus herramientas para trabajar con incidencias y PR; la autenticación, los permisos del repositorio y las aprobaciones de herramientas siguen siendo necesarios. No autoriza un commit ni una PR por sí sola. + +Utiliza Shift+Tab para alternar entre los modos estándar **Interactive**, **Plan** y **Autopilot**. Comprueba el indicador de modo antes de enviar una solicitud. Mantendrás Interactive para los primeros cambios, planificarás el filtrado antes de crearlo y volverás explícitamente a Interactive antes de crear y revisar personalizaciones. + +> [!CAUTION] +> Los ajustes de modo y permisos son distintos. Autopilot continúa trabajando de forma autónoma; `--allow-all` y su alias `--yolo` conceden todos los permisos de herramientas, rutas y URL. Este taller no exige iniciar todas las sesiones con permisos ilimitados. Revisa el alcance antes de conceder acceso, incluso dentro de un codespace. ## Resumen y siguientes pasos @@ -111,7 +143,7 @@ Ahora que estás en el prompt de Copilot CLI por primera vez, vamos a marcar com - confiar en un directorio para que Copilot CLI pueda trabajar con él. - verificar que la instalación funciona correctamente. -Ahora que Copilot CLI está instalado, vamos a darle a Copilot algo de contexto del proyecto. Continúa con el [Ejercicio 2 - Instrucciones personalizadas con CLI][next-lesson]. +Ahora que Copilot CLI está instalado, realiza un cambio pequeño y revisable en el [Ejercicio 2 - Añadir valoraciones por estrellas: una mejora rápida][next-lesson]. ## Recursos @@ -120,7 +152,7 @@ Ahora que Copilot CLI está instalado, vamos a darle a Copilot algo de contexto - [Usar Copilot CLI][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/es-es/cli/10-review.md b/docs/es-es/cli/10-review.md new file mode 100644 index 00000000..2a27553f --- /dev/null +++ b/docs/es-es/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "Ejercicio 10 - Repaso y próximos pasos" +description: "Repasa el flujo de desarrollo compartido, los recursos reutilizables y los tres hitos de solicitudes de incorporación de cambios de CLI." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Has utilizado Copilot CLI para pasar de un cambio pequeño a una funcionalidad planificada con verificación reutilizable. La configuración de los Ejercicios 0–1 preparó tu entorno; los nueve módulos principales de los Ejercicios 2–10 enseñaron un flujo completo de desarrollo. + +## Repasar los tres hitos de PR + +| Hito | Resultado combinado | Hábito de revisión | +| --- | --- | --- | +| PR 1: valoraciones por estrellas | El `starRating` existente se muestra en las tarjetas de juegos, incluido `No rating yet` para `null` | Mantener el cambio acotado y verificar ambos casos | +| PR 2: instrucciones personalizadas | Una convención de documentación específica y una pequeña demostración en código real | Comprobar que las instrucciones mejoran código real, no solo ejemplos del chat | +| PR 3: filtrado y verificación | Filtrado, la habilidad quality-checks, el perfil de QA y las pruebas asociadas | Revisar todos los puntos de control, las pruebas de verificación actuales de QA y CI antes de combinar | + +Las dos primeras PR se combinaron antes de iniciar el siguiente hito desde `main` actualizado. Los Ejercicios 4–8 compartieron una rama y una copia de trabajo. Los commits de puntos de control conservaron el progreso sin crear una PR por módulo. El ejercicio de controles no inició otra funcionalidad o PR. + +## Repasar los recursos compartidos + +Son los mismos resultados principales que los del [taller de la aplicación Copilot][app-workshop], alcanzados mediante una interfaz de terminal: + +- **Las instrucciones del repositorio** explican el contexto y los estándares del proyecto; las instrucciones limitadas por ruta añaden detalles para los archivos pertinentes. +- **La implementación de filtrado y las pruebas** satisfacen la incidencia y las aclaraciones que aprobaste durante la planificación. +- **La habilidad quality-checks** reúne instrucciones reutilizables y scripts reales de shell que ejecutan las cuatro comprobaciones del proyecto. +- **La configuración de MCP de Playwright** proporciona herramientas de navegador para observación directa. En este flujo de CLI reside en la configuración del usuario, no en la PR de funcionalidad. +- **El agente personalizado de QA** define un rol reutilizable que parte de requisitos, comprueba cobertura, utiliza la habilidad y las herramientas de navegador e informa de resultados veraces. +- **La PR y las pruebas de verificación** conectan los cambios revisados con los resultados de pruebas, las observaciones de navegador, las limitaciones y CI. + +Una habilidad es más que una lista de comandos y un perfil es más que un nombre de archivo. Has examinado los recursos generados, confirmado su ejecución real y seleccionado el agente personalizado antes de confiar en su informe. + +## Distinguir las finalidades de validación + +La planificación aclaró los requisitos antes de la implementación. Autopilot ejecutó ese plan acotado; volver a Interactive restableció puntos deliberados de revisión antes de crear personalizaciones. + +La implementación utilizó las comprobaciones npm existentes antes de que existiera una habilidad. El ejercicio de la habilidad demostró que sus scripts incluidos y el reenvío de argumentos funcionaban. MCP demostró interacción directa con el navegador en lugar de repetir una batería completa. QA combinó criterios, cobertura, observaciones de navegador y las cuatro comprobaciones mediante la habilidad. La PR reutilizó resultados actuales de QA mientras CI comprobaba la revisión enviada. + +Los fallos y bloqueos son resultados útiles. La ausencia de herramientas de navegador, las pruebas omitidas, los servidores obsoletos o un requisito sin resolver significan **NO-GO**, no permiso para rebajar el estándar. Añadir pruebas se justifica por carencias reales; no añadir ninguna es correcto cuando la cobertura existente es adecuada. + +## Mantener estos hábitos + +- Proporciona a Copilot la incidencia, el motivo del cambio y límites claros. +- Revisa los planes antes de aprobar trabajo autónomo. +- Examina instrucciones, habilidades y perfiles generados antes de ejecutarlos. +- Identifica la copia de trabajo, la rama, el servidor y la revisión a los que corresponde un resultado. +- Aplica la corrección más pequeña justificada y actualiza las pruebas de verificación tras los cambios. +- Mantén explícitas las instalaciones, las acciones destructivas, el uso compartido y las combinaciones de PR. + +## Seguir aprendiendo + +El [taller de la aplicación Copilot][app-workshop] alcanza los resultados compartidos mediante su interfaz gráfica y añade un hito de lienzo. El [taller de VS Code][vscode-workshop] y el [taller del agente en la nube][cloud-workshop] exploran otras formas de trabajar con agentes. + +Utiliza [Awesome Copilot][awesome-copilot] para encontrar ejemplos de instrucciones, habilidades y agentes personalizados. Los [ejemplos de habilidades del Ejercicio 5][skill-examples] incluyen flujos de contribución, documentos de requisitos, diagramas y pruebas de navegador. Revisa los requisitos previos y el comportamiento antes de adoptar contenido de la comunidad. + +Como referencia cotidiana, consulta la [referencia de comandos de CLI][cli-reference], la [documentación de habilidades de agente][agent-skills] y la [documentación de agentes personalizados][custom-agents]. Sigue experimentando con tareas acotadas y comparte solo material revisado mediante canales aprobados. + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#ejemplos-adicionales-de-habilidades +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/es-es/cli/2-add-star-rating.md b/docs/es-es/cli/2-add-star-rating.md new file mode 100644 index 00000000..ae689458 --- /dev/null +++ b/docs/es-es/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "Ejercicio 2 - Añadir valoraciones por estrellas: una mejora rápida" +description: "Muestra las valoraciones existentes de los juegos, revisa y valida el cambio y combina tu primera solicitud de incorporación de cambios." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Empieza con un cambio pequeño que puedas comprender y verificar. Tailspin Toys ya almacena el `starRating` de cada juego y lo muestra en la página de detalles. Mostrarás ese valor existente en las tarjetas de juegos, incluido un mensaje claro cuando un juego no tenga valoración. + +En este ejercicio: + +- solicitarás un cambio específico en una sesión Interactive de CLI. +- examinarás las diferencias y verificarás las tarjetas con y sin valoración. +- crearás un commit, abrirás y revisarás la PR 1 y la combinarás. + +## Escenario + +Los visitantes pueden ver las valoraciones en la página de detalles de un juego, pero no compararlas al explorar el catálogo. Tailspin Toys quiere mostrar las valoraciones existentes en las tarjetas, con un estado claro para los juegos sin valorar. Este pequeño cambio permite practicar cómo solicitar, revisar y publicar trabajo antes de abordar una funcionalidad mayor. + +## Iniciar el primer hito + +Desde la raíz del repositorio del participante, confirma que el árbol de trabajo está limpio, actualiza `main` y crea una rama. Si `git status` muestra cambios inesperados, resuélvelos antes de cambiar de rama; no los descartes. + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +Confía en el repositorio cuando se solicite. Comprueba que estás en modo **Interactive** y utiliza `/model` para examinar los modelos disponibles o seleccionar **Auto**. Revisa las aprobaciones de herramientas a medida que aparezcan. + +## Solicitar el cambio + +Envía esta indicación: + +```plaintext +Muestra la valoración por estrellas de cada juego en las tarjetas. El tipo Game ya incluye un campo starRating: un número sobre 5, o null cuando el juego aún no tiene valoración. Muéstralo en cada tarjeta de src/components/GameCard.astro y, cuando starRating sea null, muestra "No rating yet". Mantén el cambio pequeño y no reestructures el diseño de las tarjetas. + +Examina y sigue las instrucciones del repositorio. Utiliza el modelo de datos existente; no añadas una API de valoraciones, un esquema nuevo ni una funcionalidad ajena a la tarea. Añade o actualiza las pruebas adecuadas para los casos con y sin valoración. No crees commits, no envíes cambios ni abras una solicitud de incorporación de cambios todavía. +``` + +Copilot debería examinar el tipo y el componente existentes antes de editar. Lee la actividad de sus herramientas además de su respuesta final. Un resumen seguro de sí mismo no demuestra que la implementación sea correcta. + +## Revisar y validar + +1. Introduce `/diff` y examina todos los archivos modificados en el editor o la vista de diferencias. +2. Confirma que la tarjeta utiliza el `starRating` existente, muestra un valor sobre 5 y presenta `No rating yet` para `null`. Una comprobación basada solo en si el valor se evalúa como verdadero puede tratar erróneamente un cero numérico como ausencia de valoración. +3. Comprueba que el cambio conserva el diseño de la tarjeta y proporciona a la valoración una etiqueta textual significativa en lugar de depender solo de una estrella o del color. +4. Pide a Copilot que verifique el cambio con las comprobaciones existentes: + + ```plaintext + Examina package.json y la configuración de pruebas y ejecuta lint, comprobaciones de tipos y las pruebas unitarias o E2E existentes adecuadas para este cambio de tarjeta. Verifica tanto las valoraciones numéricas como la alternativa para null; informa de los comandos exactos y sus resultados, incluida cualquier carencia de cobertura o comprobación bloqueada. No instales nada, no cambies de rama, no crees commits, no envíes cambios ni abras una PR. + ``` + +5. Revisa la salida de los comandos y los cambios de pruebas. Resuelve los fallos antes de entregar; pregunta antes de instalar requisitos previos ausentes. + +Para observar la tarjeta en un navegador, abre una segunda terminal en esta misma copia de trabajo y ejecuta: + +```bash +npm run dev +``` + +Abre el puerto reenviado en el panel **Ports** del codespace. Examina las tarjetas con valoración en la página de inicio. Si los datos iniciales actuales no contienen un ejemplo sin valoración, exige un caso de prueba automatizado con datos que cubran `null`; no afirmes haber observado una tarjeta sin valoración. Detén el servidor de desarrollo con Ctrl+C en su terminal antes de las comprobaciones E2E o de salir del ejercicio. Las pruebas automatizadas de Playwright no deben reutilizar un servidor de otra copia de trabajo. + +## Crear y combinar la PR 1 + +Tras revisar el cambio y superar las comprobaciones, autoriza este hito por separado: + +```plaintext +Revisa las diferencias actuales y los resultados de las comprobaciones. Crea un commit solo con el cambio de valoraciones por estrellas revisado y sus pruebas, envía la rama actual y crea una solicitud de incorporación de cambios a main utilizando la plantilla de PR de este repositorio, si existe. Incluye el resumen del cambio y los resultados reales de verificación. No combines la PR ni empieces otra tarea. +``` + +Abre la URL de la PR que se devuelve. Examina **Files changed** y los resultados de las comprobaciones, no solo el resumen del agente. Revisa las definiciones de los flujos de trabajo del repositorio Tailspin al interpretar CI; CI no sustituye tu observación en el navegador. Resuelve los fallos y vuelve a verificar el código modificado. + +Cuando la PR cumpla los requisitos de revisión y comprobación del repositorio, selecciona **Merge pull request** y confirma la combinación en GitHub. Si la protección de ramas exige otro revisor, espera esa aprobación. Confirma que la PR está **Merged** antes de continuar. + +Sal de la sesión de Copilot con `/exit`. En el siguiente ejercicio actualizarás el `main` local antes de crear la rama de instrucciones; no la inicies desde esta rama de funcionalidad sin combinar. + +## Resumen y pasos siguientes + +Has completado el primer ciclo: una indicación acotada, código revisado, pruebas de verificación y una PR combinada. A continuación, [guía a Copilot con instrucciones personalizadas][next-lesson] y demuestra una convención de documentación en una segunda PR pequeña. + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/es-es/cli/2-custom-instructions.md b/docs/es-es/cli/2-custom-instructions.md deleted file mode 100644 index 538123fb..00000000 --- a/docs/es-es/cli/2-custom-instructions.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -title: "Ejercicio 2 - Instrucciones personalizadas (Copilot CLI)" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[← Lección anterior: Instalar Copilot CLI][previous-lesson] · [Siguiente lección: Generar código con CLI →][next-lesson] - -El contexto es clave cuando se trabaja con IA generativa. Si una tarea debe hacerse de una forma concreta, o hay información de fondo que Copilot debería conocer, te interesa asegurarte de que ese contexto esté disponible. Tienes varias herramientas a tu disposición para ayudar a Copilot, y las exploraremos a lo largo de este taller. Vamos a empezar con los [archivos de instrucciones][instruction-files], que suelen centrarse en cómo debe estructurarse el propio código. Esto ayuda a Copilot a entender no solo *qué* código quieres, sino también *cómo* debe estructurarse. - -En este ejercicio vas a: - -- explorar cómo el contexto específico del proyecto, las directrices de desarrollo y los estándares de documentación llegan a Copilot a través de las instrucciones personalizadas del repositorio y de los archivos de instrucciones con ámbito de ruta; -- generar el primer bloque de datos para el filtrado (un helper de editoriales) con las instrucciones *actuales*; -- añadir un nuevo estándar general del repositorio a `.github/copilot-instructions.md`; -- ejecutar un prompt de seguimiento y ver cómo el código regenerado adopta el nuevo estándar; -- confirmar los cambios de las instrucciones y del helper para que el siguiente ejercicio pueda basarse en ellos. - -> [!CAUTION] -> El código generado puede desviarse de algunos de los estándares que establezcas. Copilot no es determinista. El objetivo es observar la *tendencia* del cambio de comportamiento tras actualizar las instrucciones, no hacer que la salida coincida carácter por carácter. - -## Archivos de instrucciones - -### Escenario - -Como cualquier buen equipo de desarrollo, Tailspin Toys tiene un conjunto de directrices y requisitos para sus prácticas de desarrollo. Entre ellos se incluyen: - -- La capa de datos siempre necesita pruebas unitarias. -- La interfaz debe estar en modo oscuro y tener un aspecto moderno. -- Debe añadirse documentación al código en forma de comentarios de documentación TSDoc. -- Debe añadirse un bloque de comentarios al inicio de cada archivo para describir lo que hace. - -Gracias al uso de archivos de instrucciones, te asegurarás de que Copilot disponga de la información correcta para realizar las tareas de acuerdo con las prácticas indicadas. - -### Instrucciones personalizadas - -Las instrucciones personalizadas te permiten proporcionar contexto y preferencias a Copilot para que entienda mejor tu estilo de desarrollo y tus requisitos. Es una función muy potente que puede ayudarte a orientar Copilot para obtener sugerencias y fragmentos de código más relevantes. Puedes indicar tus convenciones de desarrollo preferidas, bibliotecas e incluso los tipos de comentarios que te gusta incluir en el código. Puedes crear instrucciones para todo el repositorio o para tipos de archivo concretos, con el fin de aportar contexto a nivel de tarea. - -Hay dos tipos de archivos de instrucciones: - -- `.github/copilot-instructions.md`, un único archivo de instrucciones que se envía a Copilot en **todas** las solicitudes del repositorio. Este archivo debe contener información a nivel de proyecto, es decir, contexto relevante para la mayoría de las solicitudes que se envían a Copilot desde el chat o la CLI. Puede incluir la pila tecnológica que se usa, una visión general de lo que se está construyendo, buenas prácticas y otras directrices globales. -- Se pueden crear archivos `.github/instructions/*.instructions.md` para tareas o tipos de archivo concretos. Puedes usarlos para proporcionar directrices para lenguajes concretos (como TypeScript o Astro), o para tareas como crear un componente de interfaz o un nuevo conjunto de pruebas unitarias. - -> [!NOTE] -> Cuando trabajas en tu IDE, los archivos de instrucciones solo se usan para generar código en Copilot Chat, no para las finalizaciones de código ni para las sugerencias de la siguiente edición. -> -> Copilot Chat, Copilot CLI y Copilot cloud agent usan tanto los archivos a nivel de repositorio como los archivos `*.instructions.md` (con frontmatter `applyTo`) al generar código. -> -> Además, Copilot [admite archivos de instrucciones que usan otros estándares][custom-instructions-support], incluidos los archivos AGENTS.md y CLAUDE.md. - -### Buenas prácticas para gestionar archivos de instrucciones - -Una conversación completa sobre cómo crear archivos de instrucciones queda fuera del alcance de este taller. Sin embargo, los ejemplos proporcionados en el proyecto de ejemplo muestran un enfoque representativo. A grandes rasgos: - -- Mantén las instrucciones de `copilot-instructions.md` centradas en directrices a nivel de proyecto, como una descripción de lo que se está construyendo, la estructura del proyecto y los estándares globales de desarrollo. -- Usa archivos `*.instructions.md` para proporcionar instrucciones específicas según el tipo de archivo (pruebas unitarias, componentes Astro, capa de datos) o la tarea. -- Usa lenguaje natural. Mantén las directrices claras. Proporciona ejemplos de cómo debería verse el código, y de cómo no. - -No existe una única forma de crear archivos de instrucciones, igual que no existe una única forma de usar la IA. A través de la experimentación descubrirás qué funciona mejor para tu proyecto. - -> [!TIP] -> Todos los proyectos que usan GitHub Copilot deberían contar con una colección sólida de archivos de instrucciones. Al explorar los de este proyecto, puede que veas que hay archivos para muchos tipos de tareas, incluidas [actualizaciones de la interfaz][ui-instructions] y [Astro][astro-instructions]. -> -> Copilot también puede ayudarte a generar archivos de instrucciones. Cada superficie lo presenta de una forma distinta (por ejemplo, **Configure Chat → Generate Agent Instructions** en VS Code, o `/init` en Copilot CLI); la lección de la superficie en la que estés lo señalará cuando sea relevante. -> -> ¿Buscas plantillas o un punto de partida? Explora [awesome-copilot][awesome-copilot], un repositorio lleno de archivos de instrucciones, agentes personalizados y otros recursos. - -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support - -## Explorar los archivos de instrucciones personalizadas de este proyecto - -Dedica un momento a leer los archivos de instrucciones incluidos en este repositorio: hay un `copilot-instructions.md` principal y una colección de archivos `*.instructions.md` para varias tareas. Ábrelos en tu editor o en la interfaz web de GitHub. - -1. Abre `.github/copilot-instructions.md`. -2. Explora el archivo y fíjate en la breve descripción del proyecto y en secciones como **Agent notes**, **Code standards**, **Scripts** y **Repository Structure**. En **Code standards**, fíjate en la guía anidada **GitHub Actions Workflows**. Se aplica a cualquier interacción que tengas con Copilot. -3. Abre la carpeta `.github/instructions` y échale un vistazo. Verás instrucciones para archivos Astro, la capa de datos de Drizzle, pruebas y mucho más. -4. Abre `.github/instructions/unit-tests.instructions.md`. Fíjate en el campo `applyTo` de la parte superior: establece un glob (relativo a la raíz del repositorio) que determina a qué archivos se aplican las instrucciones. Aquí, cualquier archivo de prueba TypeScript (por ejemplo, uno que coincida con `**/*.test.ts`) coincidirá. -5. Observa las instrucciones específicas para crear pruebas unitarias para este proyecto. -6. Por último, abre `.github/instructions/drizzle.instructions.md` y desplázate hasta el final. Fíjate en los enlaces a otros archivos de instrucciones (como `unit-tests.instructions.md`) y a archivos existentes del proyecto. Esto te permite dividir conjuntos de instrucciones más grandes en archivos más pequeños y reutilizables, y mostrar a Copilot ejemplos que seguir al generar código. (Las rutas allí son relativas al archivo de instrucciones, no a la raíz del repositorio). - -> [!NOTE] -> La sección **Code formatting requirements** de `copilot-instructions.md` documenta los estándares de desarrollo del proyecto, pero todavía no exige documentación dentro del código. En los pasos siguientes, añadirás reglas para comentarios de documentación TSDoc y encabezados de comentario a nivel de archivo. - -## Crear una rama - -Vas a hacer cambios en el código, así que crea una rama para trabajar. - -1. Desde el terminal de tu codespace, crea una rama nueva y cambia a ella: - - ```bash - git checkout -b update-custom-instructions - ``` - -2. Confirma que Copilot CLI está instalado y autenticado: - - ```bash - copilot --version - ``` - - Si no se encuentra el comando o no has iniciado sesión, vuelve al [Ejercicio 1 - Instalar GitHub Copilot CLI](../1-install-copilot-cli/). - -## Usar Copilot CLI *antes* de actualizar las instrucciones - -Para ver el impacto de las instrucciones personalizadas, empieza generando código con las instrucciones actuales. Más adelante, actualizarás el archivo y ejecutarás un prompt de seguimiento. - -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. - -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Asegúrate de que tu sesión de Copilot CLI se está ejecutando desde la **raíz del repositorio** para que detecte automáticamente `.github/copilot-instructions.md`. -2. En el prompt de Copilot CLI, pídele que genere el helper de editoriales que usará la interfaz de filtrado: - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -3. Copilot CLI explorará el proyecto, propondrá un plan y escribirá el archivo en esta sesión con `--yolo`. Supervisa los cambios en la salida del terminal y luego revísalos en tu editor. -4. Abre el archivo generado `src/lib/publishers.ts` en tu editor. -5. Observa que el helper es una función tipada que recibe un cliente `db` como primer argumento y devuelve un array tipado de editoriales; esto procede de las convenciones de la capa de datos en `.github/instructions/drizzle.instructions.md` (que se aplica a `src/lib/*.ts`). -6. Observa que al código generado **le faltan** comentarios de documentación TSDoc y un encabezado de comentario a nivel de archivo. - -> [!CAUTION] -> Copilot es probabilístico: existe la posibilidad de que añada comentarios de documentación incluso sin que se lo indiques. Si ocurre, no pasa nada; la mejora en la *consistencia* después de actualizar las instrucciones sigue siendo la idea importante. - -## Añadir un nuevo estándar del repositorio - -Como se indicó antes, `.github/copilot-instructions.md` está diseñado para proporcionar información del proyecto a Copilot. Vamos a asegurarnos de que los estándares de desarrollo del repositorio queden documentados para mejorar las sugerencias de código. - -1. Vuelve a abrir `.github/copilot-instructions.md`. -2. Localiza la sección **Code formatting requirements**, que debería estar cerca de la línea 27. Observa cómo documenta los estándares de desarrollo del proyecto, pero todavía no tiene ninguna regla para la documentación dentro del código, y por eso el helper generado no incluía comentarios de documentación. -3. Añade las siguientes líneas de Markdown justo debajo de los estándares existentes para indicar a Copilot que añada encabezados de comentario a nivel de archivo y comentarios de documentación TSDoc: - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. Guarda `copilot-instructions.md`. - -> [!TIP] -> Como viste en la lección anterior, los archivos de instrucciones pueden crearse a nivel de repositorio (`.github/copilot-instructions.md`) para directrices globales, o como archivos `*.instructions.md` para lenguajes, tipos de archivo o tareas concretos. El archivo a nivel de repositorio es el lugar adecuado para estándares generales del proyecto, como la regla de comentarios de documentación que acabas de añadir. - -## Ejecutar de nuevo el prompt y observar el cambio - -Ahora que las instrucciones incluyen una regla para los comentarios de documentación, pídele a Copilot CLI que actualice el archivo de editoriales que acabas de generar. La misma directriz de estándares orientará la reescritura. - -1. Envía `/clear` en tu sesión de Copilot CLI para empezar con una conversación limpia. -2. Envía el siguiente prompt: - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. Deja que termine la edición y vuelve a abrir `src/lib/publishers.ts`. -4. Observa que el archivo ahora empieza con un bloque de comentarios similar a este: - - ```typescript - /** - * Helpers de acceso a datos de editoriales para la plataforma de crowdfunding de Tailspin Toys. - * Proporciona funciones para recuperar información de editoriales desde la base de datos. - */ - ``` - -5. Observa que la función generada ahora incluye un comentario de documentación TSDoc similar a este: - - ```typescript - /** - * Devuelve una lista de todas las editoriales con su id y su nombre. - * - * @param db - El cliente de base de datos de Drizzle. - * @returns Una promesa que se resuelve en un array de objetos de editoriales. - */ - ``` - -6. Mantén este archivo actualizado. Es el primer bloque de datos sobre el que trabajarás en el siguiente ejercicio. - -## Confirmar y enviar este primer bloque de filtrado - -1. En el terminal, verifica los archivos modificados: - - ```bash - git status - ``` - -2. Prepara el cambio de las instrucciones y el helper: - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. Confirma los cambios: - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. Envía la rama: - - ```bash - git push -u origin update-custom-instructions - ``` - -## Resumen y siguientes pasos - -Has explorado cómo Copilot toma el contexto de los archivos de instrucciones de este proyecto y después has usado Copilot CLI para: - -- generar una base del helper de acceso a datos de editoriales para el filtrado con las instrucciones *existentes*; -- añadir un nuevo estándar general del repositorio a `.github/copilot-instructions.md`; -- ejecutar un prompt de seguimiento y ver cómo el código regenerado adopta el nuevo estándar; -- confirmar y enviar tanto la actualización de instrucciones como la base del helper. - -A continuación, aplicarás estas instrucciones mientras implementas trabajo del backlog en el [ejercicio de generación de código][next-lesson]. - -## Recursos - -- [Archivos de instrucciones para la personalización de GitHub Copilot][instruction-files] -- [Buenas prácticas para crear instrucciones personalizadas][instructions-best-practices] -- [5 consejos para escribir mejores instrucciones personalizadas para Copilot][copilot-instructions-five-tips] -- [Awesome Copilot: una colección de archivos de instrucciones y otros recursos][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ diff --git a/docs/es-es/cli/3-custom-instructions.md b/docs/es-es/cli/3-custom-instructions.md new file mode 100644 index 00000000..2ae4357d --- /dev/null +++ b/docs/es-es/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "Ejercicio 3 - Guiar a Copilot con instrucciones personalizadas" +description: "Añade una convención de documentación específica, demuéstrala en código existente y combina la segunda solicitud de incorporación de cambios." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +El contexto ayuda a Copilot a comprender no solo *qué* crear, sino *cómo* espera tu equipo que se escriba el código. Añadirás una convención de documentación específica, observarás su efecto en código real y combinarás las instrucciones y la demostración juntas como PR 2. + +En este ejercicio: + +- explorarás instrucciones generales del repositorio y limitadas por ruta. +- añadirás un estándar de documentación sin implementar el filtrado antes de tiempo. +- demostrarás el estándar en una pequeña función auxiliar o un componente existente. +- validarás y combinarás el hito de instrucciones. + +## Escenario + +El equipo de Tailspin Toys quiere que la documentación útil del código sea una convención repetible, no una petición que alguien deba recordar en cada conversación. Añadirás el estándar a las instrucciones del repositorio y lo demostrarás en código existente, sin cambiar su comportamiento ni empezar el filtrado antes de tiempo. + +## Explorar las instrucciones + +El repositorio ya contiene dos tipos útiles de instrucciones: + +- `.github/copilot-instructions.md` proporciona contexto general del repositorio, como la pila tecnológica, la estructura y las prácticas habituales. +- `.github/instructions/*.instructions.md` proporciona directrices de alcance limitado. Un patrón glob `applyTo` en el frontmatter identifica los archivos a los que se aplican. + +Abre estos archivos en el editor: + +1. Lee `.github/copilot-instructions.md` y localiza los estándares actuales de programación y verificación. +2. Explora `.github/instructions/`, incluidas las directrices de Astro, capa de datos y pruebas. +3. En `unit-tests.instructions.md`, examina el patrón `applyTo` y las convenciones de pruebas. +4. En `drizzle.instructions.md`, examina los patrones de acceso a datos y las referencias a ejemplos. + +Mantén concisas las instrucciones generales, coloca los detalles específicos de archivo en el archivo de instrucciones pertinente y evita copias contradictorias de la misma regla. La [referencia de compatibilidad de instrucciones de GitHub][instruction-support] explica qué formatos admite cada entorno. + +> [!NOTE] +> Las instrucciones influyen en la generación; no garantizan el cumplimiento. Tu revisión comprobará tanto el texto de las instrucciones como su efecto en el código. Si Copilot ya produce buenos comentarios, el objetivo es hacer explícita y repetible la convención, no forzar un fallo para comparar un antes y un después. + +## Partir de la PR 1 combinada + +Confirma que la PR de valoraciones por estrellas está combinada. Desde la terminal del repositorio del participante, inicia el siguiente hito a partir de `main` actualizado: + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +Si el árbol de trabajo no está limpio o falla la actualización, resuelve ese estado antes de continuar. Mantén el modo **Interactive**. + +En la pestaña **Issues** del repositorio, busca **Update our repository coding standards** y copia su URL real. La incidencia proporciona el contexto más amplio: explicar la intención, documentar funciones exportadas de la capa de datos y contratos de componentes y mantener los comentarios actualizados. Este ejercicio aborda una parte acotada de la documentación, no una refactorización de todo el repositorio ni una promesa de cumplir todos los criterios de la incidencia. + +## Añadir la convención de documentación + +Sustituye el marcador por la URL real de la incidencia y envía: + +```plaintext +Lee esta incidencia de estándares de programación como contexto: . Examina las instrucciones generales y de alcance limitado existentes. Añade una convención de documentación específica: explica la intención en lugar de repetir el código, documenta las funciones exportadas de db/ y src/lib/ con TSDoc/JSDoc que cubra propósito, parámetros y valores de retorno, documenta los contratos de Props de los componentes reutilizables de Astro y mantén los comentarios actualizados cuando cambie el código relacionado. + +Coloca cada regla en el archivo de instrucciones existente adecuado y evita duplicaciones o contradicciones. Conserva los estándares de formato y lint existentes; enlaza o resume la convención de documentación en README donde corresponda. Limita este cambio al estándar de documentación, no a una migración de herramientas de formato ni a una reescritura de todo el repositorio. No crees una habilidad o un agente, no implementes el filtrado, no crees commits, no envíes cambios ni abras una PR. Detente para que pueda examinar las instrucciones antes de la demostración. +``` + +Examina las diferencias. La convención debe fomentar comentarios útiles, no exigir una cabecera genérica en todos los archivos ni comentarios que repitan código evidente. Pide correcciones antes de continuar. + +## Demostrar la convención en código real + +Elige una pequeña función auxiliar exportada o un componente reutilizable existente tras examinar el repositorio. No tiene que ser una función auxiliar de editores, y no se exige que `src/lib/publishers.ts` ya exista. + +Envía: + +```plaintext +Con las instrucciones actualizadas, selecciona una pequeña función auxiliar exportada o un componente reutilizable de Astro existente que se beneficie de una documentación más clara. Aplica la convención directamente a ese archivo sin cambiar el comportamiento en ejecución ni añadir filtrado. Explica qué instrucción ha guiado el cambio y detente antes de crear un commit o abrir una PR. +``` + +Abre el archivo real modificado. En una función auxiliar, comprueba que los comentarios describen correctamente sus parámetros, el valor de retorno y cualquier argumento de base de datos inyectado. En un componente, comprueba que su contrato de `Props` está documentado. Confirma que la explicación coincide con el código en lugar de limitarte a buscar un bloque de comentarios. + +> [!TIP] +> Un fragmento ilustrativo en el chat no es la demostración: examina un cambio real del repositorio. Si el código elegido ya cumple la convención, elige otro objetivo pequeño existente donde la mejora esté justificada en lugar de añadir comentarios redundantes. + +## Validar y combinar la PR 2 + +Pide a Copilot que valide los cambios revisados: + +```plaintext +Revisa los cambios de instrucciones y la pequeña demostración de documentación. Confirma que el comportamiento en ejecución no ha cambiado. Examina package.json, ejecuta npm run lint y npm run typecheck:all y ejecuta las pruebas existentes afectadas cuando el cambio de código lo justifique. Informa de los comandos exactos y sus resultados. No instales nada, no crees una habilidad, no crees commits, no envíes cambios ni abras una PR todavía. +``` + +Resuelve los fallos y examina las diferencias finales. Después autoriza el hito: + +```plaintext +Crea un commit solo con las instrucciones de documentación revisadas, la actualización directamente relacionada de README y la pequeña demostración de código. Envía la rama actual y crea una PR a main siguiendo la plantilla de PR del repositorio. Incluye los resultados de verificación y referencia la incidencia de estándares de programación como contribución parcial; no utilices una palabra clave de cierre salvo que se cumplan realmente todos los criterios de la incidencia. No combines ni empieces el filtrado. +``` + +Abre la URL de la PR, examina **Files changed** y revisa CI. Cuando se superen todas las comprobaciones y revisiones obligatorias, combina en GitHub y confirma que la PR 2 está **Merged**. Sal de la sesión de CLI con `/exit`. No inicies el siguiente hito hasta que esta PR esté combinada. + +## Resumen y pasos siguientes + +La convención de documentación y una demostración real ya están en `main`. A continuación, [crearás el filtrado con Plan y Autopilot][next-lesson] en una rama nueva basada en ese estado combinado. + +## Recursos + +- [Añadir instrucciones personalizadas al repositorio][repository-instructions] explica las directrices generales y limitadas por ruta. +- [Awesome Copilot][awesome-copilot] ofrece ejemplos para revisar y adaptar, no para adoptar a ciegas. + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/es-es/cli/3-generating-code.md b/docs/es-es/cli/3-generating-code.md deleted file mode 100644 index eb9e6c4b..00000000 --- a/docs/es-es/cli/3-generating-code.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "Ejercicio 3 - Añadir funcionalidades al proyecto con GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Como ya puedes imaginar, una de las tareas principales que realizarás con GitHub Copilot CLI es añadir funciones, capacidades y código a un proyecto. Vamos a tomar una de las incidencias de tu backlog y pedir a Copilot que nos ayude a implementarla. - -## Escenario - -Ha llegado el momento de completar el filtrado en el proyecto. Ya tienes la incidencia de filtrado en tu backlog y un helper base del ejercicio anterior. Vamos a hacer que Copilot recupere los detalles de la incidencia, tenga en cuenta el trabajo existente y construya la funcionalidad restante. - -En este ejercicio vas a: - -- utilizar el modo de planificación para generar un plan de implementación de la funcionalidad de filtrado. -- generar con Copilot el código necesario para añadir el filtrado al sitio web. - -Al final de este ejercicio, habrás añadido nueva funcionalidad al proyecto. - -## Utilizar el modo de planificación - -Uno de los mejores usos de la IA es la planificación. Muchas veces tendrás una buena idea de lo que quieres construir, pero solo necesitas contrastar algunas ideas con algo. Las herramientas de IA pueden ayudarte a concretar tus ideas haciendo preguntas de seguimiento y analizando distintos riesgos o componentes que falten. Para apoyar este proceso, Copilot CLI ofrece un modo de planificación. Además, el tiempo que dediques a planificar ayudará a Copilot a generar código que se ajuste mejor a los requisitos establecidos. - -Empezarás el proceso de creación de la nueva funcionalidad utilizando el modo de planificación de Copilot CLI. - -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. - -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Introduce el siguiente prompt en Copilot CLI para crear un plan basado en la incidencia de filtrado: - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -2. Copilot puede hacer preguntas de seguimiento mientras desarrolla el plan. Cuando aparezcan, respóndelas según cómo construirías tú la funcionalidad. -3. Una vez generado el plan, revisa el esquema. Deberías ver que recomienda cambios pendientes en la capa de datos y en la interfaz, además de generar pruebas. -4. Copilot CLI te ofrecerá la posibilidad de añadir comentarios adicionales al plan. Puedes mover el cursor hasta la sección indicada y escribir tus sugerencias. Copilot incorporará esas sugerencias a una nueva versión del plan. -5. Cuando estés conforme, selecciona la opción que ofrece Copilot para empezar a trabajar en la nueva funcionalidad. - -> [!NOTE] -> Como Copilot es probabilístico, el texto exacto y las opciones que se muestren variarán. Sin embargo, verás una opción para empezar a construir que dirá algo parecido a esto: -> -> `Yes, and switch to autopilot mode`. -> -> Copilot puede ofrecerte la opción de habilitar el [modo autopilot](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot), como se muestra en el ejemplo anterior. El modo autopilot permite que Copilot CLI trabaje en una tarea sin esperar tu intervención después de cada paso. Una vez que le das la instrucción inicial, Copilot CLI resuelve cada paso de forma autónoma hasta que determina que la tarea está completa. Como estamos trabajando en un entorno aislado, podemos ejecutar autopilot y permitir todas las herramientas. - -6. Copilot se pondrá manos a la obra generando los archivos. - -> [!NOTE] -> Es probable que esta operación tarde varios minutos. Verás a Copilot editar y crear archivos, actualizar y generar pruebas, y ejecutar todas las pruebas para comprobar que todo funciona correctamente. Es un buen momento para reflexionar sobre lo que has explorado hasta ahora o para tomarte algo. - -## Revisar el código - -Todo código generado por IA debe revisarse antes de fusionarse en producción. Vamos a dedicar ahora un momento a explorar los archivos que Copilot ha creado y modificado al implementar la nueva funcionalidad. - -1. Usa Copilot CLI para mostrar el "diff" o los cambios de código con el siguiente comando en Copilot CLI: - - ``` - /diff - ``` - -2. Observa los archivos modificados. Usa las teclas de dirección izquierda y derecha para ver los distintos archivos. Deberías ver actualizaciones en archivos como la página del listado de juegos (donde viven los nuevos controles de filtrado y el filtrado del lado del cliente) y `src/lib/games.ts`, además de pruebas como `games.test.ts`. También es posible que veas cambios en `publishers.ts` si Copilot ajusta tu helper existente para alinearlo con la implementación completa. - -## Resumen y siguientes pasos - -Ya has añadido la funcionalidad de filtrado al sitio web con la ayuda de Copilot CLI. En concreto: - -- has utilizado el modo de planificación para generar un plan de implementación de la funcionalidad de filtrado. -- has generado con Copilot el código necesario para añadir el filtrado al sitio web. - -Por supuesto, el siguiente paso es asegurarte de que funciona. Vamos a [probar tu funcionalidad con el servidor MCP de Playwright][next-lesson] antes de abrir una pull request. - -## Recursos - -- [Usar Copilot CLI][using-copilot-cli] -- [Acerca de Copilot CLI][about-copilot-cli] -- [Gestión del contexto en Copilot CLI][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/es-es/cli/4-build-filtering.md b/docs/es-es/cli/4-build-filtering.md new file mode 100644 index 00000000..7a24f69d --- /dev/null +++ b/docs/es-es/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "Ejercicio 4 - Crear el filtrado con Plan y Autopilot" +description: "Acuerda los requisitos de filtrado, aprueba un plan de implementación, valida el código y guarda un punto de control en la rama de la funcionalidad." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Ahora crea la funcionalidad más amplia: permitir que los usuarios filtren juegos por categoría y editor. Planificarás antes de programar, autorizarás explícitamente **Autopilot**, revisarás y probarás la implementación y guardarás un punto de control. Este ejercicio no crea la habilidad, el agente de QA ni la PR de la funcionalidad. + +En este ejercicio: + +- leerás la incidencia de filtrado y aclararás los requisitos ambiguos en modo Plan. +- aprobarás explícitamente una implementación acotada con Autopilot. +- revisarás las diferencias y los resultados de las cuatro comprobaciones y guardarás un punto de control. + +## Escenario + +El catálogo de Tailspin Toys está creciendo y sus visitantes necesitan acotar los juegos por categoría y editor. La incidencia del backlog describe la funcionalidad, pero hay que acordar detalles como la combinación de categorías antes de programar. Utilizarás el modo Plan para resolver esas decisiones y después autorizarás una implementación acotada con Autopilot. + +## Iniciar el hito de filtrado + +Confirma que las PR 1 y 2 están combinadas. En la terminal del repositorio del participante: + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +Continúa solo con un árbol de trabajo limpio y una actualización correcta desde `main`. Los Ejercicios 4–8 utilizan esta misma rama y copia de trabajo. Los commits de puntos de control posteriores añadirán la habilidad y el perfil de QA; no crees una rama por ejercicio. + +## Recuperar la incidencia real + +Busca **Allow users to filter games by category and publisher** en la pestaña **Issues** del repositorio y copia su URL. No supongas que el nombre de archivo de la plantilla o un número de incidencia identifica la incidencia en tu copia. + +La incidencia actual exige: + +- seleccionar una o varias categorías. +- filtrar por editor y combinarlo con las categorías. +- funciones auxiliares de acceso a datos en `src/lib/` que admitan ambos filtros. +- controles accesibles con navegación por teclado, ARIA adecuado, estados de foco visibles y atributos `data-testid`. +- cobertura unitaria con Vitest de las funciones auxiliares y cobertura E2E con Playwright del comportamiento de filtrado. + +Lee la incidencia actual como fuente de verdad. Conserva su URL y cualquier aclaración que apruebes para la indicación de QA del Ejercicio 7. + +## Planificar antes de programar + +Utiliza Shift+Tab para seleccionar el modo **Plan**, o empieza con `/plan`. Sustituye el marcador de la incidencia y envía: + +```plaintext +Planifica la funcionalidad de filtrado descrita en esta incidencia: . Lee la incidencia, las instrucciones del repositorio, las funciones auxiliares de acceso a datos existentes, la interfaz y las pruebas antes de proponer cambios. Toma la copia de trabajo actual como punto de partida; no supongas que ya se ha creado una función auxiliar de editores. + +Cubre la selección de varias categorías, el filtrado por editor, su combinación, el soporte de acceso a datos, los controles accesibles y la cobertura unitaria/E2E. Pídeme que aclare comportamientos no especificados, como la forma de combinar varias categorías, limpiar los filtros y los resultados vacíos; registra las decisiones con el plan aprobado. Conserva la arquitectura estática de Astro en lugar de introducir una API de servidor innecesaria. + +Planifica la implementación en la rama actual, incluidas las pruebas unitarias y E2E necesarias y la verificación con npm run lint, npm run test:unit, npm run test:e2e y npm run typecheck:all. Examina primero los requisitos previos y a quién pertenece el servidor; informa de los bloqueos en lugar de instalar software o detener procesos ajenos. + +Incluye estos límites de ejecución en el plan: cuando lo apruebe, implementa solo la funcionalidad de filtrado y las pruebas necesarias, ejecuta las comprobaciones y después detente para que pueda revisar. No crees la habilidad quality-checks, un agente de QA ni otros recursos de ejercicios posteriores. No cambies de rama, no crees commits, no envíes cambios ni abras o combines una PR. + +No edites código de la aplicación ni empieces la implementación hasta que apruebe el plan. +``` + +Responde a las preguntas de seguimiento. No añadas después criterios de aceptación ocultos: guarda las respuestas acordadas junto con la URL de la incidencia para que la implementación, las comprobaciones de navegador y QA utilicen los mismos requisitos. + +Revisa que el plan incluya cambios en la capa de datos y la interfaz, pruebas, controles accesibles y la convención de documentación que has combinado. Confirma que incluye explícitamente las cuatro comprobaciones, la parada para revisión y las prohibiciones de crear recursos posteriores del taller, cambiar de rama, crear commits, enviar cambios y realizar operaciones de PR. Pide revisiones antes de aprobar si falta algún límite o criterio o si propone trabajo ajeno a la incidencia. + +## Aprobar Autopilot explícitamente + +Solo cuando el plan incluya el alcance y los límites de ejecución revisados, utiliza la opción de aprobación **Accept plan and build on autopilot**. Si tu versión utiliza otro texto, selecciona explícitamente la opción que cambia a **Autopilot** y comprueba el indicador de modo. La aprobación inicia la ejecución del plan acotado; no confíes en una indicación posterior para añadir límites cuando el trabajo ya haya empezado. + +> [!CAUTION] +> Autopilot controla la continuación del trabajo, no solo los permisos de herramientas. Revisa el cuadro de diálogo de permisos antes de elegir. Los permisos completos permiten acceso a herramientas, rutas y URL; los limitados pueden bloquear acciones que requieren aprobación. Un codespace no da permiso para exponer secretos ni cambiar recursos ajenos. Resuelve deliberadamente el acceso bloqueado en lugar de tratar las comprobaciones omitidas como superadas. + +Supervisa el trabajo y los resultados de los comandos. Autopilot puede detenerse en un límite de continuación o informar de un bloqueo antes de completar el plan. Revisa ese estado antes de autorizar que continúe y mantén el mismo alcance. + +## Volver a Interactive y revisar + +Cuando se detenga la implementación, utiliza Shift+Tab para volver al modo **Interactive** antes de enviar más indicaciones. Autopilot puede permanecer activo tras una tarea; no supongas que ha vuelto automáticamente. + +Introduce `/diff` y examina todos los archivos modificados. Compara la implementación con la incidencia y las aclaraciones aprobadas: + +- ¿Pueden los usuarios seleccionar varias categorías, filtrar por editor y combinarlos según lo acordado? +- ¿Las funciones auxiliares de acceso a datos admiten realmente los filtros, en lugar de cambiar solo la interfaz? +- ¿Los controles tienen etiquetas significativas, soporte de teclado, foco visible e identificadores de prueba estables? +- ¿Las pruebas verifican el comportamiento, incluidos los casos acordados de limpieza y resultados vacíos, sin debilitar las aserciones existentes? +- ¿El código sigue la convención de documentación y conserva la arquitectura estática de la aplicación? + +Revisa las pruebas de ejecución de las cuatro comprobaciones npm. Aún no has creado `quality-checks`, así que estas comprobaciones se ejecutan directamente. La configuración E2E de Playwright compila y sirve una vista previa; antes de ejecutar la batería, detén solo un servidor de desarrollo que hayas iniciado tú para evitar que reutilice contenido obsoleto. Un conflicto de puerto o un navegador ausente es un bloqueo que resolver, no una razón para terminar otro proceso o afirmar que se ha superado una comprobación. + +Solicita correcciones específicas si hacen falta, vuelve a ejecutar las comprobaciones afectadas y asegúrate de que la implementación final está completamente verificada. La observación directa en el navegador llega en el Ejercicio 6; tiene una finalidad distinta de esta verificación automatizada. + +## Guardar el punto de control de implementación + +Cuando las diferencias y los resultados sean satisfactorios, autoriza un punto de control local: + +```plaintext +Revisa las diferencias actuales y los resultados de verificación. Crea un commit de punto de control que contenga solo la implementación de filtrado revisada y sus pruebas. Mantén la rama y la copia de trabajo de filtrado actuales. No envíes cambios, no abras una PR ni crees todavía la habilidad o el agente de QA. +``` + +## Resumen y pasos siguientes + +Has acordado los requisitos de filtrado, revisado la implementación y las pruebas, y guardado un punto de control. Registra la revisión probada y conserva la URL de la incidencia y las aclaraciones aprobadas. Mantén **Interactive** y continúa en esta misma copia de trabajo con el [Ejercicio 5 - Crear y utilizar una habilidad quality-checks][next-lesson]. + +## Recursos + +- [Modo Autopilot y permisos][autopilot] explica la continuación autónoma y cómo volver a Interactive. +- [Referencia de comandos de Copilot CLI][cli-reference] enumera los controles de modo y los comandos actuales. + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/es-es/cli/4-mcp.md b/docs/es-es/cli/4-mcp.md deleted file mode 100644 index c7694b51..00000000 --- a/docs/es-es/cli/4-mcp.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: "Ejercicio 4 - Probar tu funcionalidad con el servidor MCP de Playwright" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Acabas de generar la funcionalidad de filtrado con Copilot CLI. Antes de abrir una pull request, deberías confirmar que funciona en el navegador. En lugar de recorrer la aplicación manualmente, conectarás el **servidor MCP de Playwright** y dejarás que Copilot controle un navegador real para probar la funcionalidad por ti. - -En este ejercicio vas a: - -- comprender qué es Model Context Protocol (MCP) y cómo amplían los servidores MCP las capacidades de Copilot CLI. -- añadir el servidor MCP de Playwright a Copilot CLI. -- pedir a Copilot que lo use para probar manualmente tu funcionalidad de filtrado en un navegador. - -## ¿Qué es Model Context Protocol (MCP)? - -[Model Context Protocol (MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/) proporciona a los agentes de IA una forma de comunicarse con herramientas y servicios externos. Al usar MCP, los agentes de IA pueden comunicarse con herramientas y servicios externos en tiempo real. Esto les permite acceder a información actualizada (mediante recursos) y realizar acciones en tu nombre (mediante herramientas). - -Se accede a estas herramientas y recursos a través de un servidor MCP, que actúa como puente entre el agente de IA y las herramientas y servicios externos. El servidor MCP se encarga de gestionar la comunicación entre el agente de IA y las herramientas externas (como API existentes o herramientas locales como paquetes de NPM). Cada servidor MCP representa un conjunto distinto de herramientas y recursos a los que el agente de IA puede acceder. - -Algunos servidores MCP populares ya existentes son: - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**: este servidor proporciona acceso a un conjunto de API para gestionar tus repositorios de GitHub. Permite al agente de IA realizar acciones como crear repositorios nuevos, actualizar los existentes y gestionar incidencias y pull requests. -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**: este servidor proporciona capacidades de automatización del navegador mediante Playwright. Permite al agente de IA realizar acciones como navegar por páginas web, rellenar formularios y seleccionar botones. - -Hay muchos otros servidores MCP disponibles que proporcionan acceso a distintas herramientas y recursos. GitHub aloja un [registro de MCP](https://github.com/mcp) para mejorar la visibilidad y las contribuciones al ecosistema. - -> [!CAUTION] -> En términos de seguridad, trata los servidores MCP como tratarías cualquier otra dependencia de tu proyecto. Antes de usar un servidor MCP, revisa cuidadosamente su código fuente, verifica el publicador y valora las implicaciones de seguridad. Usa solo servidores MCP en los que confíes y ten cuidado al conceder acceso a recursos u operaciones sensibles. - -> [!NOTE] -> El [servidor GitHub MCP][github-mcp-server] está **integrado** en Copilot CLI: ya está disponible sin ninguna configuración, y así es como Copilot ha estado leyendo y escribiendo en tu repositorio durante todo el taller. En este ejercicio añadirás un *segundo* servidor, Playwright, para darle a Copilot un navegador. - -## Añadir el servidor MCP de Playwright - -La forma más rápida de añadir un servidor es el comando interactivo `/mcp add`. Registrarás el [servidor MCP de Playwright][playwright-mcp-server], que proporciona a Copilot un navegador que puede controlar. - -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. - -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. En tu sesión de Copilot CLI, introduce: - - ```text - /mcp add - ``` - -2. Aparecerá un formulario de configuración. Usa Tab para desplazarte por los campos y complétalo de esta forma: - - - **Server Name**: `playwright` - - **Server Type**: selecciona **Local** (también aparece como **STDIO**) - - **Command**: `npx @playwright/mcp@latest --headless` - - **Tools**: déjalo en `*` para permitir todas las herramientas del servidor - -3. Pulsa Ctrl+S para guardar. El servidor se añade y queda disponible de inmediato; no hace falta reiniciar nada. - -La opción `--headless` indica a Playwright que ejecute el navegador sin una ventana visible, lo que es necesario dentro de un codespace donde no hay un escritorio para mostrarlo. Internamente, esto escribe el servidor en tu archivo `~/.copilot/mcp-config.json`: - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -4. Confirma que el servidor está registrado y activo mostrando la lista de servidores MCP: - - ```text - /mcp show - ``` - -5. Deberías ver `playwright` en la lista junto con el servidor `github` integrado. - -> [!NOTE] -> El proyecto Tailspin Toys ya usa Playwright para sus pruebas end-to-end, así que normalmente el navegador que Playwright necesita ya está instalado. Si Copilot informa más adelante de que falta un navegador, pídele que ejecute `npx playwright install chromium` y vuelve a intentarlo. - -## Iniciar el sitio web - -El servidor MCP de Playwright necesita una aplicación en ejecución sobre la que probar. Inicia el servidor de desarrollo de Astro en un terminal **independiente** para que siga ejecutándose mientras trabajas en Copilot CLI. - -1. Abre un terminal nuevo en tu codespace pulsando Ctrl+\`. -2. Inicia el sitio web: - - ```bash - npm run dev - ``` - -3. Deja este terminal en ejecución. Cuando veas el banner `Astro server: http://localhost:4321`, la aplicación estará lista. - -## Probar la funcionalidad de filtrado - -Vuelve a tu sesión de Copilot CLI y pídele a Copilot que pruebe la funcionalidad. - -El [servidor MCP de Playwright][playwright-mcp-server] le da a Copilot un navegador real que puede controlar. En lugar de que tengas que recorrer manualmente la aplicación para comprobar tu trabajo, el agente puede abrir una página, navegar, aplicar filtros y devolverte el resultado, para luego resumirte lo que ha visto. Es la forma más rápida de confirmar que una funcionalidad se comporta como esperas sin salir de la conversación. - -Internamente, el servidor MCP de Playwright trabaja a partir del [árbol de accesibilidad][playwright-mcp-server] de la página, en lugar de usar capturas de pantalla. Eso significa que el agente razona sobre elementos estructurados y etiquetados (botones, enlaces, elementos de lista) de la misma forma que lo hace la tecnología de asistencia, así que una comprobación funcional rápida también sirve como verificación básica de accesibilidad. - -Con el servidor conectado y la aplicación en ejecución, pídele a Copilot que ejercite la funcionalidad de filtrado que acabas de crear: - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -Copilot iniciará un navegador a través del servidor MCP de Playwright, recorrerá cada paso y te informará de lo que ha encontrado. Lee su resumen comparándolo con los criterios de aceptación de la incidencia. Si algo no parece correcto, haz preguntas de seguimiento o pídele que vuelva a corregir el código antes de abrir una pull request. - -> [!NOTE] -> La aplicación debe estar ejecutándose en `http://localhost:4321` para esta prueba. Si has detenido el servidor de desarrollo, vuelve a iniciarlo antes de enviar el prompt. La primera vez que Copilot use el servidor MCP de Playwright puede que necesite descargar un navegador; si informa de que falta uno, pídele que ejecute `npx playwright install chromium` y vuelve a intentarlo. - -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp - -## Resumen y siguientes pasos - -¡Enhorabuena! Has usado el servidor MCP de Playwright para probar manualmente tu funcionalidad con Copilot CLI. En resumen: - -- has aprendido qué es Model Context Protocol (MCP) y cómo amplían los servidores MCP las capacidades de Copilot CLI. -- has añadido el servidor MCP de Playwright con `/mcp add`. -- has pedido a Copilot que controle un navegador y verifique tu funcionalidad de filtrado antes de publicarla. - -Ahora que has confirmado que la funcionalidad funciona, puedes continuar con el siguiente ejercicio, en el que [abrirás una pull request con la ayuda de una habilidad de agente][next-lesson]. - -## Recursos - -- [¿Qué demonios es MCP y por qué todo el mundo habla de ello?][mcp-blog-post] -- [Servidor MCP de Playwright de Microsoft][playwright-mcp-server] -- [Añadir servidores MCP para Copilot CLI][cli-add-mcp] -- [Servidor MCP de GitHub][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers diff --git a/docs/es-es/cli/5-agent-skills.md b/docs/es-es/cli/5-agent-skills.md index ec274c1e..63907fb6 100644 --- a/docs/es-es/cli/5-agent-skills.md +++ b/docs/es-es/cli/5-agent-skills.md @@ -1,121 +1,99 @@ --- -title: "Ejercicio 5 - Usar habilidades de agente" +title: "Ejercicio 5 - Crear y utilizar una habilidad quality-checks" +description: "Pide a Copilot que cree comprobaciones de calidad reutilizables con scripts de shell incluidos, examina la habilidad y ejecútala en la rama de filtrado." authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -Desarrollar una aplicación suele implicar tareas repetibles, como generar builds, ejecutar pruebas o crear pull requests. Las **habilidades de agente** te permiten dar a Copilot, y a otros agentes de IA, directrices sobre cómo realizar esas tareas. Una habilidad es una carpeta de instrucciones, scripts y recursos que el agente puede cargar bajo demanda. [Agent Skills es un estándar abierto][agent-skills-repo] utilizado por distintos agentes, por lo que la misma habilidad puede funcionar en Copilot Chat en modo agente, Copilot cloud agent, Copilot CLI y la aplicación GitHub Copilot. +La funcionalidad de filtrado está implementada y comprobada con los comandos npm existentes. Ahora reunirás esas comprobaciones en una **habilidad de agente** reutilizable. Mantén la misma sesión y rama de filtrado durante los Ejercicios 4–8; este ejercicio no crea una solicitud de incorporación de cambios. -Las habilidades viven en la carpeta `.github/skills` de un proyecto, o globalmente en `~/.copilot/skills`. Cada habilidad es una carpeta que contiene un archivo `SKILL.md` con frontmatter YAML (un `name` y un `description`) seguido de las instrucciones en Markdown: +En este ejercicio: -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +- volverás al modo **Interactive** antes de crear personalizaciones. +- pedirás a Copilot que cree `quality-checks` y después se detenga para que la examines. +- ejecutarás las cuatro comprobaciones mediante los scripts incluidos y demostrarás que un argumento que indica un único archivo de pruebas selecciona solo ese archivo. +- guardarás un punto de control de la habilidad junto con la funcionalidad de filtrado. -Las habilidades también pueden incluir subcarpetas con scripts, recursos y material de referencia. La estructura completa se describe en la [especificación de agent skills][agent-skills-spec]. +## Escenario -> [!TIP] -> Las habilidades se cargan dinámicamente. El agente decide qué habilidad se aplica a partir del campo `description`; una descripción clara y específica para el escenario marca la diferencia entre una habilidad que se usa y otra que se ignora. +Tailspin Toys necesita las mismas comprobaciones de calidad cada vez que cambia el filtrado. En lugar de explicar los comandos y requisitos previos en cada conversación, el equipo quiere una habilidad reutilizable. La crearás, examinarás sus scripts y verificarás que otra solicitud puede ejecutar las comprobaciones correctamente. -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification +## Instrucciones, scripts y recursos -Vamos a ver cómo una habilidad puede garantizar que las pull requests sigan las especificaciones marcadas por nuestro equipo. +Las habilidades reúnen instrucciones de tareas reutilizables, scripts ejecutables y recursos de apoyo que un agente carga cuando los necesita. Los agentes personalizados definen roles especializados, instrucciones y herramientas disponibles. Son complementarios: un agente personalizado puede ejecutar scripts, incluidos los de una habilidad. -## Escenario +Una habilidad del repositorio reside en `.github/skills//SKILL.md`, con `name` y `description` en el frontmatter e instrucciones en Markdown. Los scripts y otros recursos se encuentran junto a ese archivo. Pedirás a Copilot que genere `.github/skills/quality-checks/SKILL.md` y sus scripts incluidos, en lugar de copiar una solución preparada. La [especificación de Agent Skills][skill-spec] describe el formato. -El equipo tiene una serie de requisitos para las pull requests (PR): +Copilot utiliza la descripción de una habilidad descubierta para decidir cuándo cargarla. No supongas que una habilidad nueva se descubre inmediatamente en una sesión ya abierta; la sección de ejecución incluye una alternativa de lectura explícita. Un formato portable no elimina los requisitos previos del shell o del proyecto. -- mensajes de confirmación claros, con los archivos agrupados de forma lógica. -- todas las pruebas deben superarse antes de crear una PR. -- cada PR debe contener las siguientes secciones: - - una descripción de por qué se hicieron los cambios. - - una visión general de los archivos modificados. - - fragmentos de bloques de código importantes. - - detalles de los cambios realizados agrupados juntos. +## Crear la habilidad -Como el equipo usa Copilot para generar código y PR, quiere asegurarse de que las herramientas de IA sigan estos requisitos. +Vuelve al modo **Interactive** antes de enviar la indicación. Mantén la copia de trabajo y la rama actuales. Si empezaste con una plantilla antigua que ya contiene esta habilidad, examínala y amplíala en lugar de sobrescribir tus personalizaciones. -En este ejercicio vas a: +```plaintext +Crea .github/skills/quality-checks/SKILL.md y cuatro scripts envoltorio para npm run lint, npm run test:unit, npm run test:e2e y npm run typecheck:all. Lee primero package.json, README, la configuración de pruebas y las instrucciones del repositorio. -- explorar una habilidad existente para crear pull requests. -- aprender cómo utiliza el agente de IA las habilidades. -- crear una PR que cumpla las directrices con ayuda de la habilidad. +Detecta este entorno. Crea SOLO scripts Bash .sh para macOS/Linux/WSL O scripts PowerShell .ps1 para Windows nativo; pregunta si no está claro. No crees ambos. Limita los scripts envoltorio a resolver la raíz del repositorio desde su propia ubicación, verificar que allí está el package.json de este proyecto e invocar npm. Si la raíz no es válida, falla con un mensaje claro. Admite cualquier directorio de trabajo y rutas con espacios. Conserva la salida y los códigos de salida de los fallos, incluidos los fallos de comandos nativos en PowerShell. Inserta el separador -- de npm exactamente una vez; quienes invoquen los scripts deben pasar directamente los argumentos de la herramienta, sin otro --. No gestiones puertos ni procesos. -## Ejecutar habilidades +Incluye en SKILL.md un frontmatter con name y description, instrucciones para ejecutar los cuatro scripts envoltorio, requisitos previos, resolución de problemas y ejemplos portables que incluyan un archivo existente de pruebas unitarias. Todos los ejemplos de Bash deben invocar bash explícitamente; nunca eludas la directiva de ejecución de PowerShell. Explica la reutilización de servidores de Playwright: detén solo los servidores que hayas iniciado realmente; en caso contrario, pregunta. -Las habilidades se cargan dinámicamente cuando el agente determina que son necesarias. La decisión de qué habilidades usar depende de la descripción del archivo `SKILL.md`. Por eso, es importante que las descripciones sean claras y definan el caso de uso de la habilidad. - -## Explorar la habilidad de PR +Crea únicamente la habilidad y los scripts necesarios. No ejecutes comprobaciones ni sondeos, no instales nada, no cambies código de la aplicación, no crees commits ni abras una PR. Detente para que pueda revisar los archivos. +``` -Como Tailspin Toys tiene un conjunto de requisitos para crear PR, ha creado una habilidad para ayudar a las herramientas de IA a generar PR que cumplan esas directrices. Vamos a explorar la habilidad para entender qué hará. +## Examinar la habilidad -1. Abre `.github/skills/make-contribution/SKILL.md`. -2. Fíjate en el nombre y la descripción. Observa cómo la descripción destaca el escenario en el que debe usarse, es decir, siempre que se solicite crear una pull request o confirmar código. -3. Lee la habilidad. Observa que define reglas sobre cómo deben crearse las ramas, generarse las confirmaciones y redactarse los contenidos de la pull request. +1. Abre `.github/skills/quality-checks/SKILL.md` y sus scripts incluidos en el editor y examina las diferencias. +2. Comprueba que `name` y `description` describen la habilidad y cuándo se aplica. Lee las instrucciones, no solo los metadatos. +3. Confirma que la secuencia de ejecución invoca realmente los scripts incluidos bajo `.github/skills/quality-checks/` para lint, pruebas unitarias, E2E y comprobación de tipos. +4. Examina en cada script envoltorio la resolución de la raíz relativa al script y la comprobación explícita de que el directorio calculado contiene el `package.json` previsto para esta copia de trabajo. Que un comando termine correctamente porque npm busca en directorios superiores no demuestra que la raíz sea correcta. Comprueba las rutas entre comillas, el reenvío de argumentos, la salida visible y los códigos de salida ante fallos; PowerShell debe propagar los fallos nativos de npm. +5. Comprueba el ejemplo documentado de un único archivo de pruebas unitarias. El script envoltorio inserta el separador `--` de npm, por lo que quienes lo invoquen pasan directamente los argumentos de la herramienta de destino sin otro separador. Mantén las instrucciones reutilizables sin rutas absolutas de la copia de trabajo específicas de una máquina. Pide a Copilot que corrija las carencias antes de ejecutar nada. +6. Limita los scripts a validar la raíz y el manifiesto y a ejecutar las comprobaciones npm existentes. Las decisiones sobre puertos y procesos corresponden a SKILL.md, no a código de gestión de procesos en shell. Confirma que solo se pueden detener servidores que el agente haya iniciado realmente; que coincidan el directorio de trabajo o el nombre del proceso no demuestra a quién pertenece. Los archivos entregados deben contener solo la habilidad, los scripts envoltorio necesarios y cualquier archivo auxiliar compartido que haga falta, sin archivos temporales de sondeo o depuración. -## Usar la habilidad +> [!NOTE] +> Tailspin Toys requiere actualmente Node.js 22.13 o posterior, las dependencias del proyecto y Chromium de Playwright para las comprobaciones E2E. Confirma los requisitos previos en README y `package.json` de tu copia de trabajo. Los requisitos previos ausentes o una directiva de ejecución de PowerShell que bloquee la ejecución necesitan una solución aprobada, no una instalación automática, una elusión de la directiva ni un cambio silencioso a npm directo. -Como se indicó antes, Copilot CLI invoca automáticamente las habilidades. Como resultado, lo único que tienes que hacer es pedirle a Copilot que cree una PR. +## Ejecutar la habilidad -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. +Confirma que el servidor de desarrollo del ejercicio anterior se ha detenido. Playwright compila y sirve una vista previa para E2E, pero su configuración local puede reutilizar un servidor en el puerto `4321`. Un servidor de otra copia de trabajo no proporciona pruebas de verificación válidas para tu funcionalidad. -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. +Si Copilot CLI ofrece `/quality-checks`, selecciónalo para invocar explícitamente la habilidad descubierta e incluye la solicitud siguiente. Si no se ha descubierto, envía la misma solicitud directamente en esta sesión; leer la habilidad es una alternativa admitida en este ejercicio. -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools +```plaintext +Lee .github/skills/quality-checks/SKILL.md y sigue sus instrucciones para validar la funcionalidad de filtrado en esta copia de trabajo. Primero examina el código de cada script envoltorio para verificar que calcula el directorio que contiene el package.json previsto para esta copia de trabajo y falla de forma explícita si la raíz no es válida, en lugar de depender de que npm descubra paquetes en directorios superiores. No muevas, renombres, elimines ni modifiques archivos del repositorio para simular fallos. Ejecuta realmente los scripts incluidos para lint, pruebas unitarias, pruebas de un extremo a otro y comprobaciones de tipos. Ejecuta también el ejemplo documentado de un único archivo de pruebas unitarias, pasando directamente los argumentos de la herramienta de destino porque el script envoltorio se encarga del separador -- de npm. Verifica en los resultados del ejecutor de pruebas que SOLO se ha ejecutado el archivo indicado e informa de su nombre y del número de archivos de prueba ejecutados. Mostrar los argumentos o devolver el código de salida 0 no demuestra por sí solo que la selección sea correcta. -1. Pídele a Copilot que cree una PR con el siguiente prompt: +Informa de cada invocación de script y su resultado, incluidos fallos, comprobaciones omitidas o requisitos previos ausentes. No sustituyas silenciosamente un script inutilizable de la habilidad por comandos npm directos. Identifica la copia de trabajo y el servidor que se prueban, detén solo los servidores que hayas iniciado y pregunta antes de instalar algo o detener otro proceso. No cambies código de la aplicación, no cambies de rama, no crees commits, no envíes cambios ni abras una solicitud de incorporación de cambios. +``` - ``` - Can you please create a pull request for me! - ``` +Examina las llamadas a herramientas y su salida. Los cuatro scripts deben ejecutarse realmente; una descripción de las comprobaciones o una comprobación omitida no equivale a superarlas. Para el ejemplo de un único archivo, compara el nombre de archivo solicitado con los resultados reales por archivo del ejecutor y el número comunicado: solo debe ejecutarse ese archivo. Mostrar los argumentos o devolver el código de salida 0 es insuficiente si también se ejecutaron otros archivos. Un fallo aporta información útil: corrige la habilidad o resuelve el bloqueo de configuración con aprobación y después repite las comprobaciones afectadas. No detengas procesos ajenos ni fuerces la resolución de un conflicto de puerto. -2. Copilot confirmará la solicitud. Al cabo de unos instantes, verás que Copilot indica que está utilizando la habilidad **make-contribution**. +## Guardar un punto de control -3. Después, Copilot seguirá las instrucciones de la habilidad. Empezará ejecutando las pruebas y luego creará una rama, confirmaciones y, finalmente, la PR. -4. Cuando se cree la PR, vuelve a tu repositorio y ábrela. Observa que las secciones siguen las directrices definidas en la habilidad y coinciden con los requisitos establecidos por el equipo. -5. Antes de pasar al siguiente ejercicio, restablece tu espacio de trabajo local en una rama nueva desde `main` para que el trabajo de accesibilidad quede separado de esta PR de filtrado: +Cuando hayas revisado la habilidad y sus resultados, autoriza un punto de control local: - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +```plaintext +Revisa las diferencias actuales y crea un commit de punto de control solo para los archivos de la habilidad quality-checks. Mantén la rama de filtrado existente. No envíes cambios ni crees una solicitud de incorporación de cambios. +``` -## Resumen y siguientes pasos +## Resumen y pasos siguientes -Con la ayuda de una habilidad de agente, has creado una PR nueva que cumple los requisitos documentados. Has hecho lo siguiente: +Has creado, examinado y ejecutado una habilidad quality-checks reutilizable, incluido su ejemplo de prueba de un solo archivo. Los archivos de la habilidad acompañarán al filtrado, al perfil de QA y a las pruebas asociadas en la PR de funcionalidad del Ejercicio 8. Continúa en esta misma copia de trabajo con el [Ejercicio 6 - Validar la funcionalidad con MCP de Playwright][next-lesson]. -- explorar una habilidad existente para crear pull requests. -- aprender cómo utiliza el agente de IA las habilidades. -- crear una PR que cumple las directrices con ayuda de la habilidad. +## Ejemplos adicionales de habilidades -Las habilidades son perfectas para tareas concretas, pero para operaciones más amplias conviene aprovechar los [agentes personalizados][next-lesson], que exploraremos a continuación. +Estos ejemplos de la comunidad son referencias, no tareas adicionales. Revisa sus requisitos previos y su comportamiento antes de adoptarlos: -## Recursos +- [Flujo de contribución: `make-repo-contribution`][contribution-example]. +- [Documentos de requisitos: `prd`][prd-example]. +- [Diagramas y un script de exportación incluido: `drawio`][drawio-example]. +- [Pruebas de navegador: `webapp-testing`][browser-example]. -- [Acerca de las habilidades de agente][about-agent-skills] -- [Especificación de Agent Skills][agent-skills-spec] -- [Repositorio de Agent Skills][agent-skills-repo] -- [Habilidades de agente en awesome-copilot][awesome-copilot-skills] +El ejemplo de contribución original se llama `make-repo-contribution`; las plantillas antiguas de Tailspin utilizaban otro nombre, `make-contribution`. Este taller no depende de ninguna de esas habilidades de contribución. -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/es-es/cli/6-custom-agents.md b/docs/es-es/cli/6-custom-agents.md deleted file mode 100644 index f9cf2562..00000000 --- a/docs/es-es/cli/6-custom-agents.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Ejercicio 6 - Agentes personalizados con GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## ¿Qué son los agentes personalizados? - -Los [agentes personalizados][custom-agents-concept] de GitHub Copilot te permiten crear asistentes de IA especializados y adaptados a tareas o dominios concretos dentro de tu flujo de desarrollo. Al definir agentes mediante archivos Markdown en la carpeta `.github/agents` de tu repositorio, puedes proporcionar a Copilot instrucciones enfocadas, buenas prácticas, patrones de desarrollo y conocimiento específico del dominio para orientarlo y que realice ciertos tipos de trabajo con mayor eficacia. Los equipos pueden codificar su experiencia en agentes reutilizables: un agente de accesibilidad que aplique el cumplimiento de [WCAG][wcag], un agente de seguridad que siga prácticas de desarrollo seguro o un agente de pruebas que mantenga patrones de prueba coherentes. - -Los agentes personalizados se definen mediante archivos Markdown en la carpeta `.github/agents` de tu proyecto, o globalmente en `~/.copilot/agents`. Cada archivo tiene frontmatter YAML con al menos `name` y `description`, seguido de un prompt en Markdown que define el comportamiento, la especialización y las instrucciones del agente. - -### Agentes personalizados frente a habilidades de agente - -Existe cierta superposición lógica entre los agentes personalizados y las [habilidades de agente][agent-skills-concept]. Ambos se definen principalmente mediante archivos Markdown y explican a una IA cómo realizar operaciones. La forma más clara de diferenciarlos es esta: un **agente personalizado** es quien trabaja y las **habilidades** son herramientas. - -Los agentes personalizados tienen su propia ventana de contexto y están pensados para orquestar habilidades, e incluso otros agentes, como parte de su trabajo. En este laboratorio, el agente personalizado de accesibilidad revisa y actualiza el sitio según las directrices de accesibilidad; como parte de ese trabajo podría invocar habilidades como una habilidad de flujo de trabajo de pull requests o una que ejecute y gestione pruebas. - -> [!NOTE] -> No existe una única forma "correcta" de crear un agente personalizado. Como ocurre con todo en IA, conviene probar e iterar para descubrir qué funciona mejor en tus entornos y escenarios. - -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ - -## Escenario - -Muchas aplicaciones web no logran ser accesibles para todos los usuarios, y el sitio web en el que estás trabajando no es una excepción. Usarás un agente personalizado para identificar y corregir carencias de accesibilidad. - -Tailspin Toys se compromete a garantizar que su plataforma de crowdfunding sea accesible para todos los usuarios, independientemente de sus capacidades visuales o preferencias. Comentarios recientes de usuarios han señalado que algunas personas encuentran el tema oscuro actual difícil de leer debido al contraste insuficiente entre el texto y los colores de fondo. Para responder a este problema de accesibilidad, el equipo de diseño ha solicitado implementar un modo de alto contraste que los usuarios puedan activar y desactivar. - -Como la accesibilidad es crítica, quieres asegurarte de que esto se implemente lo antes posible. Vas a utilizar un agente personalizado para generar la funcionalidad. - -En este ejercicio vas a: - -- explorar los agentes personalizados. -- habilitar un agente personalizado y asignarle una tarea con Copilot CLI. - -## Revisar el agente personalizado de accesibilidad - -Ya se ha creado para ti un agente personalizado de accesibilidad. Vamos a revisar su contenido para entender cómo orientará a Copilot. - -1. Abre `.github/agents/accessibility.md`. -2. Fíjate en el frontmatter YAML con los campos `name` y `description`. - -> [!CAUTION] -> El frontmatter con `name` y `description` es obligatorio para los agentes personalizados. - -3. A continuación, revisa las secciones siguientes, que destacan: - - responsabilidades principales al generar código para un sitio web accesible. - - buenas prácticas de accesibilidad. - - ejemplos de código para HTML, CSS y JavaScript. - - una lista de errores y problemas habituales. - -## Usar un agente personalizado en Copilot CLI - -Puedes iniciar un agente personalizado en Copilot CLI con el comando `/agent`. Vamos a realizar una revisión de accesibilidad de nuestro sitio web. - -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. - -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Muestra la lista de agentes escribiendo `/agent` en la ventana de prompt de Copilot CLI y seleccionando Enter. -2. Selecciona **Accessibility agent** en la lista de agentes disponibles. -3. Usa el siguiente prompt para pedir al agente de accesibilidad que realice una revisión y genere correcciones para el elemento del backlog relacionado con accesibilidad: - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -4. Copilot se pondrá a trabajar en la tarea. Empezará recuperando la incidencia, después realizará la revisión, generará las actualizaciones y, por último, creará la PR. También deberías observar que, al crear la PR, utiliza la habilidad centrada en PR del proyecto. - -> [!NOTE] -> Es probable que este proceso tarde unos minutos. Es un buen momento para reflexionar sobre todo lo que has aprendido, tomar algo o adelantarte al siguiente módulo, donde se comentan algunos comandos adicionales disponibles en Copilot CLI. - -## Resumen y siguientes pasos - -Esta lección ha explorado los [agentes personalizados][custom-agents] de GitHub Copilot, asistentes de IA especializados adaptados a tareas y dominios concretos. Con los agentes personalizados puedes codificar la experiencia y los estándares de tu equipo en agentes reutilizables que orienten a Copilot para realizar determinados tipos de trabajo con mayor eficacia. - -Has explorado estos conceptos: - -- cómo se definen los agentes personalizados. -- cómo usar un agente personalizado en Copilot CLI. - -Ahora vamos a explorar [algunos comandos de barra][next-lesson] para aprender algunos trucos adicionales con Copilot CLI. - -## Recursos - -- [Agentes personalizados][custom-agents] -- [Crear agentes personalizados para un repositorio][creating-custom-agents] -- [Agentes personalizados en awesome-copilot][awesome-copilot-agents] -- [Prepararse para usar agentes personalizados en tu organización][org-custom-agents] -- [Prepararse para usar agentes personalizados en tu empresa][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents diff --git a/docs/es-es/cli/6-mcp-playwright.md b/docs/es-es/cli/6-mcp-playwright.md new file mode 100644 index 00000000..dd1eb562 --- /dev/null +++ b/docs/es-es/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "Ejercicio 6 - Validar la funcionalidad con MCP de Playwright" +description: "Conecta un navegador mediante MCP y compara el comportamiento de filtrado observado con la incidencia y el plan aprobado." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +La implementación de filtrado y la habilidad quality-checks ya tienen verificación automatizada. Ahora proporciona a Copilot un navegador y pídele que observe directamente la funcionalidad. Este ejercicio demuestra la interacción mediante **Model Context Protocol (MCP)**, no otra ejecución completa de la batería de pruebas. + +Mantén el modo **Interactive** en la misma copia de trabajo y rama de filtrado. Configurar MCP no inicia un nuevo hito de funcionalidad. + +En este ejercicio: + +- conectarás MCP de Playwright y confirmarás que sus herramientas de navegador están disponibles. +- compararás el comportamiento real del filtrado con la incidencia y los criterios aprobados. +- revisarás las observaciones y detendrás el servidor de desarrollo que hayas iniciado. + +## Escenario + +Las comprobaciones automatizadas han pasado, pero Tailspin Toys también necesita pruebas de lo que experimentan los visitantes. Darás a Copilot herramientas de navegador para probar los filtros y comparar los juegos mostrados con el comportamiento acordado, en lugar de considerar que un control que responde demuestra que el filtrado funciona. + +## Qué aporta MCP + +[MCP][mcp-overview] conecta un agente con herramientas y contexto externos mediante servidores. El servidor MCP de GitHub integrado permite a Copilot trabajar con incidencias y PR. El [servidor MCP de Playwright][playwright-mcp] proporciona herramientas de navegador para abrir páginas, examinar elementos accesibles, navegar e interactuar con controles. + +La instantánea de accesibilidad del navegador ayuda al agente a identificar controles, pero no demuestra un cumplimiento completo de accesibilidad. Compara las acciones y observaciones reales con los requisitos de la incidencia en lugar de aceptar un «parece correcto» genérico. + +> [!CAUTION] +> Trata un servidor MCP como una dependencia del proyecto: revisa quién lo publica, el código fuente, los permisos y cualquier descarga de paquetes antes de activarlo. Las directivas de la organización pueden restringir los servidores que pueden ejecutarse. No incluyas credenciales en configuración versionada ni apruebes herramientas desconocidas solo para terminar el ejercicio. + +## Configurar MCP de Playwright + +1. En la sesión de CLI existente, introduce `/mcp` para examinar los servidores configurados. Reutiliza una configuración de Playwright que funcione en lugar de añadir una duplicada. +2. Si hace falta, introduce `/mcp add` y utiliza Tab para desplazarte por el formulario. +3. Establece **Server Name** en `playwright`, **Server Type** en **STDIO** (o **Local**) y **Command** en `npx @playwright/mcp@latest --headless`. +4. Establece **Tools** en `*` para este servidor de navegador revisado. Esto hace disponibles sus herramientas; no sustituye los controles de permisos de CLI. +5. Tras revisar el paquete y su comando de inicio, pulsa Ctrl+S para guardar. El registro inicia el servidor y puede descargar el paquete; aprueba esta configuración de forma deliberada y responde a las solicitudes del paquete. +6. Introduce `/mcp show playwright` y confirma que el servidor está conectado y sus herramientas de navegador están disponibles. + +El navegador sin interfaz gráfica no necesita una ventana de escritorio, lo que resulta adecuado para Codespaces. El flujo interactivo de adición guarda la configuración en `~/.copilot/mcp-config.json` y hace disponible el servidor sin reiniciar CLI. Es configuración del usuario, no un archivo que incluir en la PR de la funcionalidad. La [guía de configuración de MCP][mcp-setup] documenta los campos y las fuentes de configuración. + +> [!NOTE] +> Las dependencias E2E del proyecto y el navegador de MCP están relacionados, pero pueden requerir configuraciones distintas. Si falta un navegador o una dependencia del sistema, examina el error real y resuelve ese requisito previo específico con aprobación. No instales navegadores automáticamente ni supongas que un servidor conectado demuestra que puede iniciar uno. + +## Iniciar la aplicación correcta + +Abre otra terminal en esta misma copia de trabajo de filtrado. Confirma el directorio y la rama y después inicia la aplicación: + +```bash +pwd +git branch --show-current +npm run dev +``` + +Lee la URL local real en la salida del servidor. En el codespace, el servidor MCP y la aplicación se ejecutan en el mismo entorno, así que utiliza esa URL local, normalmente `http://localhost:4321`, en lugar de suponer que hace falta una URL de navegador reenviada. + +Si el puerto está ocupado o Astro elige otro puerto, identifica a quién pertenece el servidor antes de continuar. No reutilices un servidor desconocido ni lo termines. Utiliza la URL del proceso que acabas de iniciar y mantén esa terminal abierta durante las pruebas. + +## Observar el comportamiento de filtrado + +Sustituye los marcadores por la URL real de la incidencia, las aclaraciones aprobadas en el Ejercicio 4 y la URL de la aplicación: + +```plaintext +Utiliza el servidor MCP de Playwright configurado para validar la funcionalidad de filtrado frente a esta incidencia: . Estas son las aclaraciones aprobadas durante la planificación: . La aplicación de esta copia de trabajo se está ejecutando en . Confirma la copia de trabajo, la rama y el servidor que se prueban antes de confiar en los resultados. + +Abre la página de juegos, observa el estado sin filtros, selecciona una y después varias categorías, aplica un filtro de editor y combina las selecciones de categoría y editor. Prueba la limpieza de filtros y los resultados vacíos según los criterios aprobados. Comprueba las etiquetas de los controles, el funcionamiento con teclado y el foco visible. Compara los resultados mostrados con los filtros seleccionados y los datos de origen; no deduzcas que todo funciona solo porque haya cambiado un control. + +Utiliza acciones reales de las herramientas del navegador e informa de lo observado para cada criterio, marcando claramente los fallos o las pruebas de verificación ausentes. No ejecutes otra batería completa de pruebas solo por este ejercicio de navegador, no cambies código de la aplicación, no crees pruebas o personalizaciones, no cambies de rama, no crees commits, no envíes cambios ni abras una PR. Pregunta antes de instalar algo o detener otro proceso. +``` + +Examina las llamadas a las herramientas del navegador y el informe. ¿Copilot realmente seleccionó varias categorías y las combinó con un editor? ¿Los juegos devueltos coinciden con el comportamiento acordado? ¿El informe distingue el comportamiento observable del navegador de la cobertura de la capa de datos y las pruebas automatizadas? + +Si algo falla, registra el comportamiento observado. Autoriza por separado cualquier corrección específica de la aplicación y repite las comprobaciones de navegador y automatizadas afectadas. No cambies los criterios de aceptación para que coincidan con la implementación ni cuentes pruebas de ejecución antiguas como verificación del código modificado. + +## Detener el servidor propio y continuar + +Detén el servidor de desarrollo con Ctrl+C en la terminal donde lo iniciaste. Mantén disponible la configuración de MCP de Playwright. El Ejercicio 7 coordinará observaciones nuevas en el navegador y comprobaciones E2E automatizadas, que no deben reutilizar un servidor de desarrollo obsoleto ni la aplicación de otra copia de trabajo. + +## Resumen y pasos siguientes + +Mantén **Interactive** antes de crear el perfil de QA. Has observado el comportamiento del navegador sin crear otra PR o rama; a continuación, [crea y utiliza un agente de QA][next-lesson] para combinar requisitos, cobertura, la habilidad y las pruebas de verificación finales. + +## Recursos + +- [Añadir servidores MCP a Copilot CLI][mcp-setup] documenta la configuración y administración. +- [Microsoft Playwright MCP][playwright-mcp] documenta la configuración y las herramientas del navegador. +- [Registro MCP de GitHub][mcp-registry] enumera otros servidores que evaluar. + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/es-es/cli/7-qa-agent.md b/docs/es-es/cli/7-qa-agent.md new file mode 100644 index 00000000..1280e77c --- /dev/null +++ b/docs/es-es/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "Ejercicio 7 - Crear y utilizar un agente de QA" +description: "Crea un perfil de QA que parta de los requisitos y combine cobertura de pruebas, la habilidad quality-checks y observaciones directas del navegador." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Has ejecutado comprobaciones repetibles y explorado el filtrado mediante MCP de Playwright. Ahora crea un **agente personalizado de QA** para reunir los requisitos, la cobertura y las observaciones del navegador. Mantén la sesión, la copia de trabajo y la rama de filtrado; la PR de funcionalidad llegará en el Ejercicio 8. + +En este ejercicio: + +- crearás y examinarás un perfil de QA que parte de los requisitos. +- seleccionarás el perfil y revisarás la cobertura, los resultados de las comprobaciones y las pruebas de verificación del navegador. +- volverás al agente normal y guardarás un punto de control del perfil con las pruebas cuya incorporación esté justificada. + +## Escenario + +Tailspin Toys se prepara para publicar el filtrado. Que las pruebas pasen no basta para saber si se cubren todos los requisitos acordados. El equipo necesita una revisión centrada en comparar la incidencia con la implementación, identificar carencias y explicar si la funcionalidad está lista para revisión. El perfil de QA guiará esa evaluación sin sustituir el criterio humano. + +## Crear el perfil de QA + +Mantén el modo **Interactive**. Un perfil define el rol y las instrucciones de un especialista; una habilidad reúne instrucciones de tareas reutilizables, scripts y recursos. El agente de QA utilizará tu habilidad y las herramientas MCP configuradas en lugar de sustituirlas. + +Envía esta indicación y después examina la definición antes de ejecutarla: + +```plaintext +Crea un agente personalizado de QA reutilizable en .github/agents/qa.agent.md. Primero examina las instrucciones del repositorio, package.json, la configuración de pruebas y .github/skills/quality-checks/SKILL.md. Proporciona al perfil un frontmatter YAML válido con name establecido en QA y una description que explique cuándo utilizarlo. No fijes un modelo ni añadas una lista tools; hereda las herramientas y los permisos disponibles del entorno. Crea solo la definición del agente y después detente para que pueda examinarla antes de ejecutarlo. + +En las instrucciones del agente, exige que toda tarea de QA parta de la incidencia y de los criterios de aceptación aprobados que proporcione el usuario. Trata estos requisitos como fuente de verdad, no la implementación. Pregunta cuando falten requisitos o sean ambiguos. Examina la funcionalidad y las pruebas existentes y relaciona cada criterio con la cobertura automatizada adecuada y el comportamiento observable. + +Exige validación directa en el navegador mediante el servidor MCP de Playwright configurado y la ejecución de lint, pruebas unitarias, pruebas de un extremo a otro y comprobaciones de tipos mediante la habilidad quality-checks existente y sus scripts incluidos. Lee la habilidad explícitamente si no se ha descubierto automáticamente. Informa de la ausencia de habilidades, herramientas MCP, requisitos previos o acceso como bloqueos; no sustituyas silenciosamente el flujo por otro ni etiquetes comprobaciones omitidas como superadas. Identifica la copia de trabajo y el servidor que se prueban, evita reutilizar el servidor de otro worktree, detén solo los servidores que haya iniciado el agente y pregunta antes de cualquier instalación o de detener otro proceso. + +Permite que el agente de QA añada las pruebas mínimas necesarias para carencias reales de cobertura, siguiendo las instrucciones del repositorio; no añadir pruebas es válido cuando la cobertura ya es adecuada. No debilites aserciones, no desactives pruebas fallidas, no cambies los criterios de aceptación para ajustarlos al código ni modifiques código de la aplicación sin mi aprobación. Tras los cambios, repite las comprobaciones afectadas y completa la verificación final de la revisión resultante. Exige un informe conciso que relacione los criterios con las pruebas de verificación y el estado superado/fallido/bloqueado, enumere las pruebas añadidas o explique por qué no hicieron falta, comunique los resultados de las cuatro comprobaciones e identifique los defectos sin resolver. GO exige todas las comprobaciones y pruebas de verificación obligatorias; de lo contrario, informa de NO-GO y su motivo. No cambies de rama, no crees commits, no envíes cambios, no abras ni combines PR y no crees agentes o habilidades adicionales durante QA. +``` + +## Examinar el perfil + +Abre `.github/agents/qa.agent.md` en el editor y examina las diferencias. `description` es obligatorio; este ejercicio también proporciona `QA` como `name` legible. Confirma que no se ha fijado un `model` ni inventado una lista de herramientas. Omitir `tools` hereda las herramientas disponibles; no elude los permisos del entorno. Los perfiles de producción pueden restringir las herramientas deliberadamente. + +Confirma que las instrucciones parten de los requisitos, exigen actividad real del navegador mediante MCP y scripts de la habilidad, permiten solo adiciones de pruebas justificadas e informan de los bloqueos con veracidad. Ni un perfil especializado ni una habilidad requieren una ventana de contexto independiente o la orquestación de otros agentes. + +## Ejecutar QA frente a la incidencia + +La indicación de ejecución es para el agente personalizado **QA** seleccionado, no para el agente predeterminado que lee un perfil. Inicia una conversación nueva de CLI en la misma copia de trabajo para cargar el perfil nuevo sin crear otra rama de funcionalidad. + +1. Conserva la URL de la incidencia de filtrado y las aclaraciones aprobadas. Espera a que termine el agente actual y después introduce `/exit` para volver a la terminal. +2. Confirma que sigues en el directorio del repositorio de filtrado y en la misma rama con `git branch --show-current` y `git status --short`. No cambies de rama ni crees un worktree. +3. Inicia CLI con el perfil del repositorio: + + ```shell + copilot --agent qa + ``` + +4. Verifica que CLI identifica a **QA** como agente seleccionado antes de ejecutarlo. La [referencia de comandos de CLI][cli-reference] documenta `--agent`; escribir o leer el perfil no constituye por sí solo su activación. Si la selección falla o el agente no puede acceder a las herramientas MCP de Playwright configuradas y a la habilidad, detente y resuelve ese bloqueo con la persona que dirige el taller. + +Sustituye ambos marcadores por la URL real de la incidencia de filtrado y las aclaraciones aprobadas en el Ejercicio 4, o por `none` si la incidencia está completa. No dependas de la memoria del agente anterior. + +```plaintext +Verifica la funcionalidad de filtrado frente a esta incidencia: . Estos son los criterios de aceptación adicionales que aprobé durante la planificación: . + +Valida el comportamiento con el servidor MCP de Playwright, examina la cobertura de pruebas, añade pruebas solo para carencias de cobertura y ejecuta la validación mediante la habilidad quality-checks. Informa de las pruebas de verificación, los resultados de las comprobaciones y los bloqueos. No cambies código de la aplicación sin mi aprobación, no crees un commit ni abras una solicitud de incorporación de cambios. +``` + +## Revisar las pruebas de verificación + +Contrasta el informe con la incidencia: cada criterio necesita cobertura automatizada adecuada y comportamiento observable. Examina la actividad real de las herramientas MCP de Playwright, la identidad de la copia de trabajo y del servidor y los resultados de los cuatro scripts de la habilidad. Las comprobaciones de navegador y E2E automatizadas no deben reutilizar un servidor obsoleto ni otra copia de trabajo. + +Revisa las pruebas añadidas: deben cubrir carencias reales sin debilitar las aserciones. No añadir pruebas es correcto cuando la cobertura es adecuada. Un dictamen **NO-GO** por bloqueo o fallo es un resultado válido, no permiso para omitir pruebas de verificación. + +Si QA identifica un defecto de la aplicación, aprueba por separado una corrección específica y repite las comprobaciones y observaciones de navegador afectadas en la revisión resultante. La ausencia de requisitos previos o herramientas necesita una resolución explícita. No trates las pruebas de verificación anteriores como demostración del código modificado. + +## Guardar un punto de control + +Cuando QA haya terminado, conserva su informe con la URL de la incidencia, las aclaraciones aprobadas, la revisión probada, las observaciones de navegador y los resultados de las comprobaciones. Introduce `/exit` y después inicia `copilot` sin `--agent` desde el mismo directorio y rama para volver a una conversación normal. Proporciona ese contexto de nuevo; la conversación nueva no hereda las pruebas de verificación de la conversación de QA. + +Cuando hayas revisado el perfil, los cambios de pruebas y las pruebas de verificación resultantes, envía la solicitud siguiente al agente normal: + +```plaintext +Revisa las diferencias actuales y crea un commit de punto de control para la definición del agente de QA y los cambios de pruebas aprobados. Mantén la rama de filtrado existente. No envíes cambios ni abras una solicitud de incorporación de cambios. +``` + +## Resumen y pasos siguientes + +Has creado y seleccionado un perfil de QA, revisado sus pruebas de verificación y guardado el perfil con las pruebas justificadas. Conserva los hallazgos pendientes; un veredicto fallido o bloqueado no autoriza la combinación. Continúa con el [Ejercicio 8 - Crear y combinar la PR de la funcionalidad][next-lesson] con la funcionalidad de filtrado, la habilidad, el perfil de QA, las pruebas y las pruebas de verificación actuales. + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/es-es/cli/7-slash-commands.md b/docs/es-es/cli/7-slash-commands.md deleted file mode 100644 index b3e1bbe9..00000000 --- a/docs/es-es/cli/7-slash-commands.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "Ejercicio 7 - Comandos de barra en GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Como cualquier buena herramienta de CLI, GitHub Copilot CLI incluye muchos comandos de barra para interactuar con ella. Estos comandos exponen funcionalidad avanzada, información "entre bastidores" u opciones de configuración adicionales. Ya has explorado un par de ellos con `/clear` para borrar el contexto y `/mcp` para inspeccionar los servidores MCP. Vamos a explorar otros muy potentes, entre ellos `/context`, `/model`, `/share` y `/delegate`. - -## Escenario - -Ya has completado los flujos principales de CLI. Ahora vamos a ver algunas capacidades adicionales: compartir sesiones, cambiar de modelo y delegar tareas en [Copilot cloud agent][about-cloud-agent]. - -En este ejercicio usarás: - -- `/share` para crear un GitHub gist y compartir tu sesión con el equipo. -- `/context` para ver el contexto que está usando actualmente Copilot CLI. -- `/model` para explorar la lista de modelos disponibles y seleccionar uno nuevo si así lo deseas. -- `/delegate` para delegar opcionalmente una tarea al agente en la nube. Esto requiere cloud agent, disponible en Copilot Student, Pro, Pro+, Business o Enterprise, es decir, en todos los planes excepto Copilot Free. - -## Compartir una sesión - -Usar cualquier herramienta, incluida una herramienta de IA, es una habilidad. Trabajar en equipo y compartir lo aprendido es la mejor forma de mejorar la experiencia de todos y generar código de mayor calidad. Para ello, Copilot CLI proporciona el comando `/share`. El comando `/share` puede generar un archivo Markdown o un GitHub gist con los detalles de la sesión, incluidos los prompts utilizados y la lógica que siguió Copilot. - -Vamos a crear un GitHub gist que podríamos compartir con nuestro equipo. - -> [!TIP] -> **Inicia una sesión de Copilot CLI** -> -> Antes de empezar los ejercicios siguientes, vuelve a tu codespace y abre un terminal (Ctrl+\` si no hay ninguno abierto). Después, inicia Copilot CLI con `--yolo` y `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar la sesión más reciente de este proyecto en lugar de empezar desde cero, ejecuta `copilot --yolo --enable-all-github-mcp-tools --continue`. Si Copilot CLI ya se está ejecutando desde un ejercicio anterior, envía `/clear` para empezar una conversación limpia. -> -> `--enable-all-github-mcp-tools` habilita las herramientas GitHub MCP de lectura y escritura para la sesión actual, de modo que Copilot pueda leer tu backlog y abrir pull requests durante el flujo del taller. - -> [!CAUTION] -> `--yolo` habilita permisos automáticos completos (`--allow-all-tools`, `--allow-all-paths` y `--allow-all-urls`). Úsalo solo en un entorno aislado, como un Codespace o una máquina virtual, y no lo configures nunca como alias predeterminado para el desarrollo diario. Consulta [Allowing and denying tool use][allow-all-warning] para más información. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. En la ventana de prompt de Copilot CLI, envía el siguiente comando: - - ``` - /share gist - ``` - -2. En apenas unos instantes, Copilot creará un gist y mostrará el enlace. -3. Copia el texto del enlace. -4. En una pestaña nueva del navegador, pega el enlace para explorar el gist. Observa cómo el gist destaca los prompts enviados, las habilidades y los agentes utilizados, el proceso de razonamiento de Copilot e incluso el código y los resultados de los comandos ejecutados localmente. - -Los gists y archivos Markdown generados por `/share` pueden usarse para documentar cómo se generó el código o para compartir con el equipo cómo se llevaron a cabo determinadas acciones que produjeron los resultados deseados con Copilot. - -## Explorar el contexto de Copilot CLI - -Cuando trabajas en tareas grandes o complejas, puedes llegar al límite máximo de la ventana de contexto del modelo. El tamaño exacto de la ventana variará según el modelo que se esté usando y la versión de Copilot CLI. Cuando la ventana de contexto se llena, Copilot CLI la compacta automáticamente, resumiendo la información y eliminando lo que considera irrelevante para la tarea actual. Puedes tanto ver el estado actual del contexto como compactarlo manualmente usando comandos de barra. Vamos a explorar la ventana de contexto. - -1. En la ventana de prompt de Copilot CLI, envía el siguiente comando: - - ``` - /context - ``` - -2. En apenas unos instantes, Copilot CLI generará una representación visual de su contexto actual: - - ![Captura de la ventana de contexto de Copilot CLI](../../_images/cli-7-context-window.png) - -3. Fíjate en el modelo mostrado (que puede ser distinto del de la imagen) y en el porcentaje actual de tokens usados. El resto de la información destaca lo siguiente: - - | Título | Descripción | - | ------------ | ------------------------------------------------------ | - | Sistema/Herramientas | Archivos de instrucciones, contenido de archivos y definiciones de herramientas | - | Mensajes | Historial de la conversación entre tú y Copilot | - | Búfer | Espacio reservado por Copilot CLI para generar respuestas | - | Espacio libre | Espacio libre restante | - -4. Compacta el historial de la conversación enviando el siguiente comando de barra a Copilot CLI: - - ``` - /compact - ``` - -5. Cuando termine, envía de nuevo el siguiente comando para mostrar las estadísticas actuales del contexto: - - ``` - /context - ``` - -6. Observa el cambio en el contexto. Puede que no sea drástico, ya que es probable que la ventana de contexto sea relativamente pequeña en este momento. - -> [!NOTE] -> Copilot CLI compactará automáticamente el contexto cuando se llene. Cuando se acerque al 100 % de capacidad, mostrará el porcentaje justo encima de la ventana de prompt. Normalmente lo compactará de forma asíncrona, lo que te permitirá seguir interactuando con Copilot mientras realiza ese trabajo. Aun así, puede bloquear una operación en curso durante varios segundos mientras lo hace. - -### Buenas prácticas con el contexto - -En la mayoría de las sesiones, Copilot gestionará el contexto de forma eficiente sin que tengas que darle instrucciones específicas. Sin embargo, puede haber ocasiones en las que decidas indicarle manualmente que borre o compacte el historial: - -- Si vas a pasar a otra parte de la aplicación o a una tarea no relacionada, puedes usar `/clear` para empezar de nuevo y evitar confundir a Copilot con contexto antiguo que no tiene relación. -- Si te estás acercando al límite máximo de la ventana de contexto, puedes usar manualmente `/compact` para controlar cuándo ocurre. - -> [!CAUTION] -> De nuevo, la mayor parte del tiempo Copilot gestionará su contexto sin interacción directa por tu parte. Si observas que Copilot está algo confundido por información antigua, o estás a punto de cambiar a una tarea no relacionada, entonces quizá te convenga usar los comandos manuales. - -## Elegir tu modelo - -Los distintos modelos tienen puntos fuertes diferentes y cada desarrollador tiene sus propias preferencias. Copilot CLI te permite listar y seleccionar el modelo que quieras usar. - -1. Muestra la lista de modelos enviando el siguiente comando de barra a Copilot CLI: - - ``` - /model - ``` - -2. Observa la lista de modelos. Junto a cada modelo aparecerán tanto su nombre como el modificador de coste por solicitud. -3. Si quieres, selecciona un modelo nuevo. O bien selecciona Esc para salir de la lista de modelos. - -> [!CAUTION] -> La selección de modelo persiste en Copilot CLI. - -## Delegar en cloud agent (opcional) - -Hay ocasiones en las que quieres seguir trabajando en tu terminal, pero delegar una tarea de mayor duración en Copilot cloud agent. El comando `/delegate` envía la sesión actual de Copilot CLI a GitHub.com, donde cloud agent la retoma, trabaja de forma asíncrona y abre una pull request cuando termina. - -> [!NOTE] -> `/delegate` requiere cloud agent, disponible en Copilot Student, Pro, Pro+, Business o Enterprise, es decir, en todos los planes excepto Copilot Free. Si no tienes acceso, lee esta sección y omite los pasos prácticos. - -1. Borra primero la sesión actual para no delegar el contexto acumulado del taller: - - ``` - /clear - ``` - -2. Envía un prompt pequeño y bien delimitado. Por ejemplo, podrías delegar la paginación de objetivo ampliado de tu backlog: - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. Envía el siguiente comando de barra para delegar la sesión al agente en la nube y confirma el prompt que quieres delegar: - - ``` - /delegate - ``` - -4. Abre [Copilot agents](https://github.com/copilot/agents) en un navegador para supervisar el progreso. -5. No necesitas esperar a que la pull request termine en este recorrido; puedes volver más tarde. Si quieres profundizar en la gestión del trabajo asíncrono con agentes, continúa con el [recorrido de Cloud agent](../../cloud/). - -## Resumen y siguientes pasos - -Usar comandos de barra en Copilot CLI te permite configurarlo, compartir sesiones y obtener información interna sobre cómo está trabajando Copilot. En esta lección has usado o explorado: - -- `/share` para crear un GitHub gist y compartir tu sesión con el equipo. -- `/context` para ver el contexto que está usando actualmente Copilot CLI. -- `/model` para explorar la lista de modelos disponibles y seleccionar uno nuevo si así lo deseas. -- `/delegate` como puente opcional hacia cloud agent. - -Por supuesto, hay más comandos de barra disponibles y mucho más por explorar con Copilot CLI. Vamos a cerrar este recorrido [repasando lo que hemos aprendido][next-lesson] y viendo algunos próximos pasos para seguir aprendiendo. - -## Recursos - -- [Usar Copilot CLI][using-copilot-cli] -- [Acerca de Copilot CLI][about-copilot-cli] -- [Gestión del contexto en Copilot CLI][context-management] -- [Compartir sesiones con Copilot CLI][share-sessions] -- [Seleccionar modelos en Copilot CLI][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm diff --git a/docs/es-es/cli/8-create-pull-request.md b/docs/es-es/cli/8-create-pull-request.md new file mode 100644 index 00000000..4ddba670 --- /dev/null +++ b/docs/es-es/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "Ejercicio 8 - Crear y combinar la PR de la funcionalidad" +description: "Revisa todo el hito de filtrado, reutiliza las pruebas de verificación actuales de QA y combina la tercera solicitud de incorporación de cambios tras CI y la revisión." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Ahora reúne el hito de filtrado en la PR 3. Mantén la rama y la copia de trabajo utilizadas en los Ejercicios 4–7. Contienen la implementación de filtrado, la habilidad quality-checks y sus scripts, el perfil de QA y las pruebas asociadas. + +En este ejercicio: + +- revisarás las diferencias del hito completo y las pruebas de verificación actuales de QA. +- solicitarás una PR de funcionalidad y examinarás sus comprobaciones y comentarios de revisión. +- combinarás explícitamente la PR revisada y actualizarás el `main` local. + +## Escenario + +El trabajo de filtrado está repartido en varios puntos de control, pero los revisores necesitan evaluar una funcionalidad completa. Tailspin Toys quiere una PR que conecte los requisitos, la implementación, las comprobaciones reutilizables y los hallazgos de QA. Prepararás esa entrega y resolverás los bloqueos antes de combinar. + +Esta es una petición normal de PR con alcance limitado que utiliza las convenciones del repositorio. No requiere una habilidad de contribución. + +> [!NOTE] +> Un equipo de producción podría separar una funcionalidad de la infraestructura de calidad reutilizable. Este taller las combina deliberadamente para mostrar el flujo completo en una PR de funcionalidad. Las PR anteriores de valoraciones por estrellas e instrucciones ya deberían estar combinadas en `main`, no aparecer otra vez como trabajo ajeno. + +## Comprobar la preparación y las pruebas de verificación + +1. Revisa el dictamen de QA y la correspondencia entre requisitos y pruebas de verificación. Un **NO-GO**, la ausencia de observaciones de navegador o una comprobación obligatoria omitida es un bloqueo que resolver antes de combinar. +2. Confirma que las cuatro comprobaciones se ejecutaron realmente mediante la habilidad quality-checks: lint, pruebas unitarias, E2E y comprobación de tipos. +3. Revisa la revisión probada y los cambios posteriores a esas comprobaciones. Reutiliza las pruebas de verificación actuales de QA solo mientras el código probado, las pruebas y los scripts de verificación no hayan cambiado. Un commit de punto de control por sí solo no invalida contenidos de archivo idénticos, pero los cambios de código sí. +4. Si cambió la implementación o alguna entrada probada, ejecuta de nuevo las comprobaciones pertinentes de la habilidad y las observaciones de navegador y actualiza las pruebas de verificación. No repitas toda la batería solo por abrir una PR cuando los resultados actuales de QA siguen siendo aplicables. +5. Examina las diferencias de toda la rama, no solo el último punto de control o los cambios sin commit. + +Desde otra terminal en la misma copia de trabajo: + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +La comparación de tres puntos muestra los cambios de esta rama desde su antecesor común con `origin/main`, incluidos los puntos de control anteriores. Verifica que incluye solo el hito de filtrado previsto. Examina también los archivos nuevos; los archivos inesperados sin seguimiento o sin commit deben revisarse antes de prepararlos. + +## Solicitar la PR 3 + +El Ejercicio 7 te devolvió a una sesión **Interactive** normal antes del punto de control. Continúa en esa sesión establecida si el perfil de QA ya no está activo y la copia de trabajo y la rama de filtrado no han cambiado. Mantén disponibles la URL de la incidencia, las aclaraciones aprobadas de planificación y el informe actual de QA, incluida la revisión probada y los resultados de las comprobaciones. + +El perfil de QA prohíbe las acciones de commit y PR durante QA. Si sigue activo, vuelve a una sesión normal antes de solicitar la PR: + +1. Espera a que QA esté inactivo y después introduce `/exit` en su prompt de CLI. Si CLI permanece abierto porque hay otra sesión activa, termina o conserva ese trabajo antes de volver al prompt normal y pulsar Ctrl+D para cerrar esta instancia de CLI. +2. En el prompt del shell, permanece en la misma copia de trabajo y rama de filtrado. Confirma su identidad e inicia una sesión normal nueva sin `--agent qa` ni una opción de reanudación: + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. Confirma que estás en modo **Interactive** y el perfil de QA ya no está activo. No crees otro worktree, no cambies de rama ni reanudes la sesión de QA. + +Sustituye todos los marcadores siguientes por la URL real de la incidencia, las aclaraciones aprobadas y las pruebas de verificación actuales de QA. Proporciónalos explícitamente aunque hayas permanecido en la sesión normal del Ejercicio 7; una conversación nueva no debe depender de la memoria de la sesión de QA. + +```plaintext +Prepara la PR de la funcionalidad de filtrado para esta incidencia: . Estos son los criterios de aceptación adicionales que aprobé durante la planificación: . Estas son las pruebas de verificación actuales de QA: . + +Confirma la copia de trabajo y la rama de filtrado actual. Examina todas las diferencias frente a main, todos los commits de puntos de control del hito, git status, la plantilla de PR del repositorio y las pruebas de verificación de QA proporcionadas. Incluye solo la implementación de filtrado revisada, la habilidad quality-checks y los scripts incluidos, la definición del agente de QA y las pruebas asociadas. + +Reutiliza los resultados de QA mientras sigan describiendo el contenido final de los archivos. Si el código, las pruebas o los scripts de verificación cambiaron después, indícalo y ejecuta las comprobaciones pertinentes mediante la habilidad y la validación de navegador afectada antes de presentarlos como actuales. No etiquetes comprobaciones fallidas, bloqueadas u omitidas como superadas. + +Si hace falta, crea un commit con los cambios revisados restantes del hito, envía esta rama actual y crea una sola PR a main siguiendo las convenciones del repositorio. Incluye la incidencia y los criterios aprobados, un resumen de implementación, las pruebas añadidas o por qué no hicieron falta, las observaciones de navegador, los resultados de las cuatro comprobaciones y las limitaciones restantes. No combines, no crees otra rama, no invoques una habilidad de contribución ni empieces otra funcionalidad. +``` + +## Revisar la PR y CI + +Abre la URL devuelta y examina **Files changed** en toda la PR. Comprueba que los scripts de la habilidad y el perfil de QA están incluidos y que no se han colado credenciales, configuración local de MCP, archivos ajenos, informes generados o instalaciones de dependencias. + +Utiliza la pestaña **Checks** de la PR o ejecuta estos comandos en la terminal de la rama de funcionalidad: + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +Examina `.github/workflows/` de tu repositorio en lugar de suponer que una insignia verde cubre todos los tipos de verificación. El flujo actual **Run tests** de Tailspin ejecuta lint, comprobaciones de tipos, pruebas unitarias de Vitest y pruebas E2E de Playwright contra el sitio estático compilado. No sustituye las observaciones directas del navegador mediante MCP del informe de QA. La compilación Astro y las comprobaciones de enlaces del sitio del taller validan otro repositorio. + +Si una comprobación falla, examina sus registros y resuelve la causa. Una corrección específica debe revisarse y verificarse de nuevo en la revisión actualizada antes de enviar cambios. Si `main` cambia y la resolución de un conflicto modifica la funcionalidad, actualiza también las pruebas de verificación afectadas. Espera cualquier revisión humana obligatoria; la aprobación del propio agente no anula la protección de ramas. + +## Combinar y actualizar el main local + +Cuando la PR cumpla todos los requisitos de revisión y comprobación, elige explícitamente **Merge pull request** en GitHub y confirma la combinación. Verifica que la PR 3 está **Merged**. + +Sal de la sesión de CLI con `/exit`. Con el árbol de trabajo limpio, actualiza la copia local: + +```bash +git status +git switch main +git pull --ff-only +``` + +## Resumen y pasos siguientes + +No hace falta una rama nueva para el siguiente ejercicio. Has combinado exactamente tres PR del taller: valoraciones por estrellas; instrucciones y una demostración; y filtrado con la habilidad de calidad, el perfil de QA y las pruebas. + +Continúa con el [Ejercicio 9 - Explorar comandos de barra y opciones de CLI][next-lesson] para recorrer de forma acotada los controles de CLI, no para realizar otra tarea de implementación. + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/es-es/cli/8-review.md b/docs/es-es/cli/8-review.md deleted file mode 100644 index 48534f24..00000000 --- a/docs/es-es/cli/8-review.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Ejercicio 8 - Repaso y próximos pasos" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -En los últimos ejercicios, has explorado algunos de los casos de uso más habituales de GitHub Copilot CLI, entre ellos: - -- interactuar con GitHub y otros servidores MCP. -- usar archivos de instrucciones para orientar la generación de código. -- implementar habilidades para añadir herramientas al conjunto de herramientas de Copilot CLI. -- invocar agentes personalizados para tareas avanzadas y más complejas. -- usar comandos de barra para gestionar tu sesión y, opcionalmente, volver a conectar con cloud agent mediante `/delegate`. - -Vamos a hablar de algunos comandos de barra, buenas prácticas y próximos pasos. - -## Comandos de barra - -Copilot CLI tiene una serie de comandos de barra disponibles para interactuar con él, incluidos algunos que te permiten configurarlo o ver qué está ocurriendo entre bastidores. Ya has usado `/clear` para iniciar un chat nuevo que borra el contexto actual, y `/mcp` para inspeccionar y gestionar servidores MCP. Algunos adicionales que pueden resultarte útiles son: - -| Comando | Descripción | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | Añadir un directorio a la lista de confianza de Copilot | -| `/clear`, `/new` | Borrar el historial de la conversación y empezar de cero | -| `/compact` | Resumir el historial de la conversación para reducir el uso de la ventana de contexto | -| `/context` | Mostrar el uso de tokens de la ventana de contexto y su visualización | -| `/diff` | Revisar los cambios realizados en el directorio actual | -| `/model` | Seleccionar el modelo de IA que se va a usar (Claude Sonnet, GPT-5, etc.) | -| `/plan ` | Crear un plan de implementación antes de programar | -| `/review ` | Ejecutar el agente de revisión de código para analizar los cambios | -| `/delegate` | Delegar la tarea en Copilot cloud agent para procesamiento asíncrono | -| `/session` | Mostrar la información de la sesión y el resumen del espacio de trabajo | -| `/share` | Compartir la sesión en un archivo Markdown o un GitHub gist | -| `/skills` | Gestionar habilidades para ampliar las capacidades | -| `/usage` | Mostrar métricas y estadísticas de uso de la sesión | - -> [!TIP] -> Usa `/help` para ver la lista completa de comandos disponibles y de atajos de teclado. - -## Buenas prácticas - -Cuando usas una herramienta de IA, la infraestructura subyacente determina en gran medida la calidad de lo que obtienes. Unos archivos de instrucciones sólidos, agentes personalizados y habilidades de agente robustas forman parte de ello, y en este taller has explorado cada uno de esos elementos. [awesome-copilot][awesome-copilot] es una buena fuente de plantillas, y el propio Copilot puede generarlas como punto de partida. - -El contexto sigue importando tanto como la infraestructura. Describir claramente *qué* quieres que se construya, *por qué* y *cómo* cambia de forma significativa el resultado. Si una información puede ayudar a Copilot, compártela. - -## Próximos pasos - -La mejor forma de mejorar tus habilidades con cualquier herramienta es seguir usándola. Úsala para código de producción, para proyectos personales, para esa pequeña aplicación en la que llevas años pensando pero que nunca llegabas a construir. Comparte lo que aprendas con tu equipo y aprende también de él. Y, como siempre, explora la documentación. - -Si quieres explorar más del ecosistema de GitHub Copilot, consulta el [recorrido de VS Code](../../vscode/) o el [recorrido de Cloud agent](../../cloud/). - -## Recursos - -- [Acerca de Copilot CLI][about-copilot-cli] -- [Usar Copilot CLI][using-copilot-cli] -- [Repositorio Awesome Copilot][awesome-copilot] -- [Guía de instrucciones personalizadas][repo-instructions] -- [Documentación de las habilidades de agente][agent-skills] -- [Documentación de agentes personalizados][custom-agents] -- [Especificación de MCP][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ diff --git a/docs/es-es/cli/9-slash-commands.md b/docs/es-es/cli/9-slash-commands.md new file mode 100644 index 00000000..c14bb187 --- /dev/null +++ b/docs/es-es/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "Ejercicio 9 - Explorar comandos de barra y opciones de CLI" +description: "Examina el contexto y los controles de modelos y sesiones, revisa los destinos para compartir y explora opciones de CLI sin iniciar otra funcionalidad." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Los tres hitos de PR están completos. Ahora explora los controles de CLI que te ayudan a comprender y gestionar una sesión. Este ejercicio no implementa otra funcionalidad, no delega trabajo ni abre otra PR. + +En este ejercicio: + +- examinarás los controles de contexto, uso, modelo y modo. +- compararás las opciones de línea de comandos con la ayuda de la versión instalada. +- exportarás una sesión localmente y la revisarás antes de compartir nada. + +## Escenario + +Una vez publicada la funcionalidad, quieres comprender los controles de CLI que utilizarás a diario. Examinarás una sesión y sus opciones para compartir sin iniciar otra tarea, para evitar que gestionar el contexto o exportar una conversación autorice trabajo o revele información del proyecto por accidente. + +Desde la copia de trabajo actualizada del participante, inicia `copilot` en modo **Interactive**. Utiliza `/help` y la [referencia de comandos][cli-reference] para confirmar los comandos que admite tu versión instalada; la documentación actual puede describir controles más recientes que tu instalación. + +## Examinar el contexto y la información de sesión + +1. Envía una solicitud acotada de solo lectura: + + ```plaintext + Resume los archivos de instrucciones del repositorio, la habilidad quality-checks y el perfil de QA. Explica cómo ayudan a verificar el filtrado. No modifiques archivos, no ejecutes comprobaciones, no delegues trabajo, no crees commits ni abras una PR. + ``` + +2. Introduce `/context` para examinar el uso de la ventana de contexto. Observa cómo los mensajes, las instrucciones y las definiciones de herramientas consumen contexto. +3. Introduce `/compact` y después `/context` de nuevo. La compactación resume el historial para reducir su tamaño; una sesión corta puede mostrar pocos cambios. +4. Introduce `/session` para examinar la sesión actual y `/usage` para consultar la información de uso. + +La compactación no sustituye la aportación de requisitos. Al cambiar de tarea o agente, proporciona explícitamente la URL de la incidencia, los criterios aprobados, la identidad de la copia de trabajo y las pruebas de verificación pertinentes. + +`/clear` inicia una conversación nueva; no deshace archivos ni cambia de rama de Git. `/resume` abre el selector de sesiones para volver a un trabajo anterior. Explora el selector y pulsa Esc para salir sin reanudar otra tarea. No borres la única copia de los criterios de aceptación ni supongas que reanudar una conversación significa que su verificación anterior sigue vigente. + +## Examinar modelos y modos + +Introduce `/model` para examinar los modelos disponibles para tu cuenta, incluido **Auto** donde se ofrezca. Lee los detalles de selección y la información de uso; la disponibilidad y los precios de los modelos pueden cambiar. Pulsa Esc para salir del selector sin cambiar de modelo. Si lo cambias, confirma la selección mostrada y el alcance que aplica tu versión de CLI. + +Utiliza Shift+Tab para examinar el indicador de modo al alternar entre **Interactive**, **Plan** y **Autopilot**, y vuelve después a **Interactive** sin enviar una indicación de implementación. Recuerda la diferencia: + +- Plan sirve para acordar el trabajo antes de programar. +- Autopilot continúa una tarea aprobada y acotada. +- Interactive proporciona puntos deliberados de revisión y decisión. +- Los permisos controlan por separado qué acciones de herramientas están permitidas. + +## Examinar opciones de línea de comandos + +En otra terminal, ejecuta: + +```bash +copilot --help +``` + +Compara estas opciones documentadas con la ayuda de tu versión instalada: + +| Opción | Finalidad | +| --- | --- | +| `--model MODEL` | Elegir el modelo para una invocación; confirma primero su disponibilidad | +| `--agent AGENT` | Seleccionar un agente personalizado para una invocación | +| `-p PROMPT` | Ejecutar una indicación de forma programática y salir cuando termine | +| `--output-format json` | Emitir salida JSONL estructurada, un objeto JSON por línea | +| `--resume` | Reanudar una sesión existente | +| `--enable-all-github-mcp-tools` | Exponer el conjunto completo de herramientas MCP de GitHub integradas | + +Son controles que comprender, no otra tarea que iniciar. El modo programático puede ejecutar acciones reales de herramientas; un formato de salida JSON no convierte una solicitud en solo lectura. La selección del agente sigue el flujo verificado del [Ejercicio 7][qa-lesson], no es una razón para sustituir la activación del agente personalizado por una petición al agente predeterminado para que lea el perfil. Los permisos y el acceso siguen siendo necesarios. + +## Revisar antes de compartir + +`/share` puede enviar el contenido de la sesión a distintos destinos. La [referencia de comandos de CLI][cli-reference] documenta `/share file [session|research] [PATH]` para exportar Markdown y `/share gist [session|research]` para publicar un gist. Sin subcomando, el comportamiento documentado actualmente crea un enlace de GitHub para compartir cuando hay una sesión iniciada y sincronizada, y recurre a una exportación Markdown en caso contrario. No ejecutes el comando sin argumentos suponiendo que solo muestra una vista previa. + +Para este taller, selecciona explícitamente una exportación local de la sesión y un nombre de archivo en lugar de publicar: + +```text +/share file session cli-session-review.md +``` + +Abre el archivo exportado en el editor y examina lo que contiene realmente. Revisa indicaciones, respuestas, salida de herramientas, rutas de archivo, datos del repositorio y cualquier credencial o información personal. No supongas que la exportación contiene todos los pasos internos ni que ha eliminado automáticamente el contenido sensible. + +> [!CAUTION] +> Un gist o un enlace compartido supone divulgar información fuera del entorno. Un gist secreto no proporciona control de acceso privado: cualquiera que tenga su URL puede verlo. Confirma el destino, los destinatarios, los permisos y la directiva de tu organización antes de compartir. Si hace falta ocultar información, comparte solo el archivo revisado y depurado mediante un canal aprobado; no publiques después la sesión original. + +Mantén esta exportación fuera de la PR de funcionalidad y del historial del repositorio. Tras examinarla, elimina el archivo que acabas de generar o muévelo a la ubicación local de notas aprobada. No elimines archivos ajenos. + +La delegación en la nube puede crear trabajo remoto y una PR adicional, así que no ejecutes `/delegate` aquí. El [taller del agente en la nube][cloud-workshop] cubre ese flujo independiente. + +## Resumen y pasos siguientes + +Has examinado el contexto, el uso, los controles de modelos y modos, las opciones de línea de comandos y los destinos para compartir sin iniciar otra funcionalidad. Continúa con el [Ejercicio 10 - Repaso y próximos pasos][next-lesson] para revisar el flujo y los recursos que has creado. + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/es-es/cli/README.md b/docs/es-es/cli/README.md index aca3c5c9..88ad8e2d 100644 --- a/docs/es-es/cli/README.md +++ b/docs/es-es/cli/README.md @@ -3,12 +3,12 @@ slug: es-es/cli title: "GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- **[GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)** incorpora GitHub Copilot a tu terminal como asistente de programación con agentes. Explora bases de código, genera código, ejecuta comandos y se conecta a herramientas externas, todo desde la línea de comandos, para que puedas mantener el flujo sin cambiar a un editor gráfico. -A lo largo de estos ejercicios instalarás y autenticarás Copilot CLI, y después le darás contexto del proyecto con instrucciones personalizadas antes de usar el modo de planificación para generar una funcionalidad de forma deliberada. Conectarás el servidor MCP de Playwright para probar esa funcionalidad en un navegador real y, a continuación, ampliarás Copilot con habilidades de agente reutilizables y agentes personalizados. Por último, explorarás los comandos de barra para gestionar el contexto, los modelos y el uso compartido, y terminarás con un repaso de lo que has creado. +Tras la configuración de los Ejercicios 0–1, completarás nueve módulos principales en los Ejercicios 2–10. Empieza con una mejora rápida de valoraciones por estrellas, establece instrucciones de documentación y crea el filtrado con los modos **Plan** y **Autopilot**. Después crea una habilidad quality-checks reutilizable, valida el comportamiento con MCP de Playwright, crea un agente de QA y entrega la funcionalidad. Termina explorando los controles de CLI y repasando lo que has creado. ## Ejercicios @@ -16,13 +16,21 @@ A lo largo de estos ejercicios instalarás y autenticarás Copilot CLI, y despu |----------|-------|-------------| | [0. Requisitos previos][ex0] | Configuración | Crea tu repositorio y tu codespace | | [1. Instalación de Copilot CLI][ex1] | Instalación | Instala y autentica Copilot CLI | -| [2. Instrucciones personalizadas][ex2] | Contexto | Añade una instrucción y comprueba cómo la sigue Copilot CLI | -| [3. Generación de código][ex3] | Generación de código | Usa el modo de planificación y genera funcionalidades | -| [4. Pruebas con Playwright MCP][ex4] | Herramientas externas | Añade el servidor MCP de Playwright y prueba tu funcionalidad en un navegador | -| [5. Habilidades de agente][ex5] | Habilidades | Mejora Copilot con habilidades especializadas | -| [6. Agentes personalizados][ex6] | Agentes | Revisa y usa agentes personalizados | -| [7. Comandos de barra][ex7] | Funciones de CLI | Explora el contexto, los modelos, el uso compartido y la delegación opcional al agente en la nube | -| [8. Repaso][ex8] | Resumen | Repasa los conceptos clave y los próximos pasos | +| [2. Añadir valoraciones por estrellas: una mejora rápida][ex2] | Primer cambio | Muestra las valoraciones existentes, valida y combina la PR 1 | +| [3. Guiar a Copilot con instrucciones personalizadas][ex3] | Contexto | Añade una convención de documentación, demuéstrala y combina la PR 2 | +| [4. Crear el filtrado con Plan y Autopilot][ex4] | Implementación | Revisa un plan, aprueba Autopilot, prueba y guarda un punto de control | +| [5. Crear y utilizar una habilidad quality-checks][ex5] | Habilidades | Genera, examina y ejecuta comprobaciones con scripts de shell incluidos | +| [6. Validar la funcionalidad con MCP de Playwright][ex6] | Herramientas de navegador | Observa el comportamiento del filtrado en un navegador real | +| [7. Crear y utilizar un agente de QA][ex7] | Agentes | Audita requisitos y cobertura y reúne las pruebas de verificación finales | +| [8. Crear y combinar la PR de la funcionalidad][ex8] | Entrega | Revisa el filtrado y las personalizaciones reutilizables juntos en la PR 3 | +| [9. Explorar comandos de barra y opciones de CLI][ex9] | Controles de CLI | Examina contexto, modelos, sesiones y destinos para compartir | +| [10. Repaso y próximos pasos][ex10] | Resumen | Repasa los recursos comunes y los tres hitos de PR | + +## Ramas y solicitudes de incorporación de cambios + +Combinarás tres solicitudes de incorporación de cambios: valoraciones por estrellas; instrucciones y una pequeña demostración; y filtrado con la habilidad quality-checks, el perfil de QA y las pruebas asociadas. Combina cada una de las dos primeras PR antes de iniciar el siguiente hito desde `main` actualizado. + +Los Ejercicios 4–8 comparten una rama de funcionalidad y una copia de trabajo. Guarda commits de puntos de control durante el proceso; crear la habilidad, configurar MCP y seleccionar QA no inicia nuevas ramas de funcionalidad. El Ejercicio 9 explora los controles sin iniciar otra funcionalidad o PR. ## Requisitos previos @@ -46,10 +54,12 @@ Antes de asistir a este taller, asegúrate de tener: [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ diff --git a/docs/ja-jp/README.md b/docs/ja-jp/README.md index 3ecea3e1..3524829f 100644 --- a/docs/ja-jp/README.md +++ b/docs/ja-jp/README.md @@ -3,7 +3,7 @@ slug: ja-jp title: "GitHub Copilot のエージェントを実践で学ぶ" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- GitHub Copilot に最近追加された機能は、ソフトウェア開発ライフサイクル (SDLC) 全体を通して開発者を支援する強力なツールです。GitHub の Issue や pull request を使った作業、外部サービスとの連携、そしてもちろんコードの作成も含まれます。このラボでは、実際のユースケースを通して機能を試し、ツールを最大限に活用するためのヒントを紹介します。 @@ -23,7 +23,7 @@ GitHub Copilot は、どの環境で作業していても利用できます。 ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI** は、ターミナルで動作するエージェント型アシスタントです。インストールして MCP サーバーに接続し、プラン モードでコードを生成できます。さらに、独自のスキル、カスタム エージェント、スラッシュ コマンドをすべてコマンド ラインから構築できます。 +**GitHub Copilot CLI** は、ターミナルで動作するエージェント型アシスタントです。セットアップ後は9つのコアモジュールに取り組みます。まず星評価を追加する小さな変更をリリースし、指示を整備して、フィルター機能を計画・構築します。続いて quality-checks スキルの作成、Playwright MCP による検証、QA エージェントの作成を行い、機能をマージします。最後に CLI の操作方法と振り返りを扱います。この流れには3つの pull request のマイルストーンがあります。 ### 🤖 [Copilot App](app/) diff --git a/docs/ja-jp/cli/0-prerequisites.md b/docs/ja-jp/cli/0-prerequisites.md index eeda24e4..1a142313 100644 --- a/docs/ja-jp/cli/0-prerequisites.md +++ b/docs/ja-jp/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "演習 0: 前提条件" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Copilot CLI の演習を始める前に、必要な準備を整えます。Tailspin Toys リポジトリの自分用コピーを作成し、[codespace][codespaces] を立ち上げます。次の演習では、その統合ターミナルを使って Copilot CLI をインストールし、実行します。 +この演習では、次のことを行います。 + +- Tailspin Toys テンプレートから自分のリポジトリを作成します。 +- Codespace を開き、CLI のセットアップに進める状態か確認します。 + ## ラボ用リポジトリを設定する これから作成するコード用にリポジトリのコピーを作成するため、[template][template-repository] からインスタンスを作成します。新しいインスタンスにはラボに必要なすべてのファイルが含まれており、演習を進める間はこのリポジトリを使用します。 +テンプレートの新しいコピーを使用してください。リポジトリの指示、アプリケーションコード、テスト、CI は含まれていますが、カスタムエージェントやスキルは同梱されていません。これらの資産は自分で作成します。以前のコピーに戻る場合は、既存のカスタマイズを確認してから変更し、自分の作業を上書きしないでください。 + 1. 新しいブラウザー ウィンドウで、このラボの GitHub リポジトリ `https://github.com/github-samples/tailspin-toys` に移動します。 2. ラボ用リポジトリ ページの **Use this template** ボタンを選択して、自分用のリポジトリ コピーを作成します。次に **Create a new repository** を選択します。 @@ -27,6 +34,8 @@ Copilot CLI の演習を始める前に、必要な準備を整えます。Tails > > テンプレートからリポジトリを作成すると、GitHub issue のバックログが自動的に作成されます。ワークショップ全体を通してこれらの issue を使って作業するため、自分で起票する必要はありません。 +Issue を初期作成するワークフローの完了を待ち、**Issues** タブで **Allow users to filter games by category and publisher** と **Update our repository coding standards** を確認します。演習では、推測した Issue 番号ではなく、実際のタイトルと URL を使ってください。バックログがない場合は、ワークフローの結果を確認してから進みます。 + ## Codespace を作成する 次は、codespace を使ってラボの演習を進めます。 @@ -50,8 +59,8 @@ Codespace の作成には数分かかりますが、すべてのサービスを > [!NOTE] > このワークショップは、codespace またはローカルの [dev container][dev-containers] 内で実行する前提で作られています。どちらでも、必要な前提条件がすべてインストールされた環境を用意できるため、スムーズに進められます。ローカルで実行したい場合は、クローンしたリポジトリを VS Code で開き、表示されたら **Reopen in Container** を選択してください。VS Code が、codespace と同じ dev container を構築します。 -[codespaces]: https://github.com/features/codespaces -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers +Codespace の準備ができたら、[演習 1][next-lesson]でターミナルを開き、Copilot CLI をインストールする前にリポジトリ、ランタイム、認証を確認します。 + ## まとめ おめでとうございます。ラボ用リポジトリのコピーを作成できました。さらに、Copilot CLI を使い始めるときに使用する codespace の作成も開始しました。 @@ -69,3 +78,5 @@ Copilot CLI をインストールし、GitHub アカウントで認証しまし [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [codespaces-quickstart]: https://docs.github.com/codespaces/getting-started/quickstart [next-lesson]: ../1-install-copilot-cli/ +[codespaces]: https://github.com/features/codespaces +[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers diff --git a/docs/ja-jp/cli/1-install-copilot-cli.md b/docs/ja-jp/cli/1-install-copilot-cli.md index ce05003b..0e63ec98 100644 --- a/docs/ja-jp/cli/1-install-copilot-cli.md +++ b/docs/ja-jp/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "演習 1 - GitHub Copilot CLI をインストールする" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [GitHub Copilot CLI][about-copilot-cli] は、ターミナルで動作する強力なエージェント型コーディング アシスタントです。コードベースの探索、コード生成、コマンド実行、外部ツールとの連携をすべてコマンド ラインから行えます。タスクを任せたり、変更を依頼したりしながら、集中を保って作業できます。最初のステップは、想像どおりツールをインストールすることです。幸い、すでによく知っているツールを使って実行できます。 @@ -21,10 +21,25 @@ lastUpdated: 2026-06-30 Copilot CLI をインストールする前に、codespace でターミナル ウィンドウを開く必要があります。 -1. まだ開いていない場合は、codespace に戻ります。 +1. Codespace に戻り、セットアップの完了を待ちます。 2. Ctrl+\` を押してターミナル ウィンドウを開きます。 3. VS Code ウィンドウの下部にターミナル パネルが表示されます。 +## 学習用環境を確認する + +Codespace のターミナルで、ワークショップ教材のリポジトリではなく、自分の Tailspin Toys リポジトリにいることを確認します。`README.md` と `package.json` を読み、セットアップとチェックのコマンドを確認してください。現在の Tailspin Toys には Node.js 22.13 以降、プロジェクトの依存関係、E2E テスト用の Playwright Chromium が必要です。 + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +GitHub CLI（`gh`）は PR と CI の確認に役立ちます。認証されていない場合は、`gh auth login` を実行してブラウザーの案内に従います。このリポジトリでブランチをプッシュし、PR を作成・マージできるアカウントであることを確認してください。組織のポリシーによっては、別のレビュアーが必要です。コードの変更を始める前に、リポジトリのセットアップ手順に従って不足している前提条件を解消し、インストール内容を確認してから承認します。 + +CLI は起動したチェックアウトで動作します。会話を始めても、独立したワークツリーが自動的に作成されるわけではありません。このワークショップでは PR マイルストーンごとに1つのブランチを使います。先に星評価と指示の実証をマージし、演習4～8では同じフィルター機能のブランチを維持します。 + ## Copilot CLI をインストールする Copilot CLI は [npm][install-npm]、[WinGet][install-winget]、[Homebrew][install-homebrew] でインストールできます。GitHub Codespaces には Node.js があらかじめインストールされているため、この演習では npm を使って Copilot CLI をインストールします。 @@ -35,7 +50,7 @@ Copilot CLI は [npm][install-npm]、[WinGet][install-winget]、[Homebrew][insta node --version ``` - バージョン 22 以上（例: `v22.x.x`）が表示されるはずです。 + CLI 自体の要件が異なる場合でも、Tailspin Toys にはバージョン 22.13 以上が必要です。バージョンが古い場合は、学習用リポジトリのセットアップ手順に従ってください。 2. npm を使って codespace に Copilot CLI をグローバル インストールします。 @@ -51,8 +66,8 @@ Copilot CLI は [npm][install-npm]、[WinGet][install-winget]、[Homebrew][insta バージョン番号（例: `v1.0.XX`）が表示されるはずです。 -> [!TIP] -> 権限エラーが発生した場合は、一部のシステムで `sudo npm install -g @github/copilot` の使用が必要になることがあります。ただし、GitHub Codespaces では通常必要ありません。 +> [!NOTE] +> 権限エラーでインストールに失敗した場合は、不慣れなコマンドを管理者権限で再実行せず、npm の設定を確認するか、ワークショップの講師に相談してください。 ## GitHub で認証する @@ -85,22 +100,39 @@ Copilot CLI は [npm][install-npm]、[WinGet][install-winget]、[Homebrew][insta 2. このワークショップでは、このリポジトリで継続して作業するため、**Yes, and remember this folder for future sessions** を選択します。 3. Copilot に簡単な質問をして、正しく動作していることを確認します。 - ``` - What files are in this project? + ```plaintext + このプロジェクトにはどのようなファイルがありますか。 ``` 4. Copilot がリポジトリを探索し、プロジェクト構造の概要を返すはずです。 5. `/help` コマンドを試して、利用可能な slash command を確認します。 - ``` + ```text /help ``` -6. ターミナルで次のコマンドを入力して Copilot CLI を終了します。後続の演習で再び Copilot CLI に戻ります。 +6. Copilot のプロンプトで次のコマンドを入力して、このセッションを終了します。最初の変更には新しいセッションを使います。 + ```text + /exit ``` - exit - ``` + +## モードと権限を理解する + +Copilot CLI は起動したディレクトリと Git ブランチで作業します。ディレクトリを信頼するとリポジトリのコンテキストを利用できるようになりますが、すべてのツール操作の承認とは異なります。ファイル変更、シェルコマンド、GitHub 操作の権限要求を確認してください。 + +コードの演習は、学習用リポジトリのルートから次のコマンドで開始します。 + +```bash +copilot --enable-all-github-mcp-tools +``` + +GitHub MCP サーバーは組み込まれています。このフラグで Issue や PR の作業に使うすべてのツールを公開しますが、認証、リポジトリの権限、ツールの承認は引き続き必要です。このフラグだけでコミットや PR を承認するわけではありません。 + +Shift+Tab で通常の **Interactive**、**Plan**、**Autopilot** モードを切り替えます。リクエストを送る前にモード表示を確認してください。最初の変更では Interactive を維持し、フィルター機能は計画してから構築します。カスタマイズの作成とレビューの前には、明示的に Interactive に戻します。 + +> [!CAUTION] +> モードと権限の設定は別です。Autopilot は自律的に作業を続け、`--allow-all` とその別名 `--yolo` はすべてのツール、パス、URL の権限を付与します。このワークショップでは、毎回のセッションを無制限の権限で始める必要はありません。Codespace 内でも、アクセスを許可する前に範囲を確認してください。 ## まとめと次のステップ @@ -111,7 +143,7 @@ Copilot CLI は [npm][install-npm]、[WinGet][install-winget]、[Homebrew][insta - Copilot CLI が作業できるようにディレクトリを信頼する。 - インストールが正しく動作していることを確認する。 -Copilot CLI をインストールできたので、次は Copilot にプロジェクトのコンテキストを与えます。[演習 2 - Copilot CLI のカスタム命令][next-lesson] に進んでください。 +Copilot CLI をインストールできたので、[演習 2 - 星評価を追加して小さな成果を得る][next-lesson]で、レビューしやすい小さな変更を行います。 ## リソース @@ -120,7 +152,7 @@ Copilot CLI をインストールできたので、次は Copilot にプロジ - [Copilot CLI を使う][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/ja-jp/cli/10-review.md b/docs/ja-jp/cli/10-review.md new file mode 100644 index 00000000..f0d5b368 --- /dev/null +++ b/docs/ja-jp/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "演習 10 - 振り返りと次のステップ" +description: "共通の開発ワークフロー、再利用可能な資産、CLI の3つの pull request マイルストーンを振り返ります。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Copilot CLI を使い、小さな変更から、再利用可能な検証を伴う計画的な機能開発へと進みました。演習0～1のセットアップで環境を整え、演習2～10の9つのコアモジュールで一連の開発ワークフローを学びました。 + +## 3つの PR マイルストーンを振り返る + +| マイルストーン | マージした成果 | レビューの習慣 | +| --- | --- | --- | +| PR 1: 星評価 | 既存の `starRating` をゲームカードに表示し、`null` の場合は `No rating yet` を表示 | 変更の範囲を保ち、両方のケースを検証する | +| PR 2: カスタム指示 | 範囲を絞ったドキュメント規約と実際のコードによる小さな実証 | チャット内の例だけでなく、指示が実際のコードを改善しているか確認する | +| PR 3: フィルター機能と検証 | フィルター機能、quality-checks スキル、QA プロファイル、関連テスト | マージ前にすべてのチェックポイント、現在の QA の証拠、CI をレビューする | + +最初の2つの PR は、それぞれマージしてから更新済みの `main` で次のマイルストーンを始めました。演習4～8では1つのブランチとチェックアウトを共有しました。チェックポイントコミットで進捗を保存し、モジュールごとに PR を作成することはありませんでした。操作方法の演習でも、別の機能や PR は開始しませんでした。 + +## 共通の資産を振り返る + +ターミナルのインターフェイスを通じて、[Copilot App ワークショップ][app-workshop]と同じ中核的な成果を得ました。 + +- **リポジトリの指示**はプロジェクトのコンテキストと基準を説明し、パス別の指示は対象ファイルに関する詳細を追加します。 +- **フィルター機能の実装とテスト**は、Issue と計画時に承認した追加の取り決めを満たします。 +- **quality-checks スキル**は、再利用可能な指示と、プロジェクトの4つのチェックを実行する実際のシェルスクリプトをまとめます。 +- **Playwright MCP の設定**は、直接観察するためのブラウザーツールを提供します。この CLI の流れでは、機能の PR ではなくユーザー設定に保存されます。 +- **QA カスタムエージェント**は、要件から始めてカバレッジを確認し、スキルとブラウザーツールを使い、正確な結果を報告する再利用可能な役割を定義します。 +- **PR と検証の証拠**は、レビュー済みの変更を、テスト結果、ブラウザー観察、制限事項、CI に結び付けます。 + +スキルは単なるコマンド一覧ではなく、プロファイルも単なるファイル名ではありません。生成された資産を確認し、実際の実行を確かめ、カスタムエージェントを選択してからその報告を利用しました。 + +## 検証の目的を区別する + +計画では実装前に要件を明確にしました。Autopilot は範囲を限定した計画を実行し、Interactive に戻ることで、カスタマイズ作成前の意識的なレビューの機会を取り戻しました。 + +実装時にはスキルが存在する前から既存の npm チェックを使いました。スキルの演習では、同梱のスクリプトと引数の転送が動作することを確認しました。MCP ではスイート全体を繰り返すのではなく、ブラウザーを直接操作しました。QA では条件、カバレッジ、ブラウザーの証拠、スキル経由の4つすべてのチェックを組み合わせました。PR では現在も有効な QA 結果を再利用し、CI が提出したリビジョンをチェックしました。 + +失敗と阻害要因も有用な結果です。ブラウザーツールの不足、テストのスキップ、古いサーバー、未解決の要件は **NO-GO** を意味し、基準を下げる許可ではありません。テストの追加は実際の不足に基づいて判断します。既存のカバレッジが十分なら、テストを追加しない判断が適切です。 + +## これからも続ける習慣 + +- Issue、変更の理由、明確な境界を Copilot に伝えます。 +- 自律的な作業を承認する前に計画をレビューします。 +- 生成した指示、スキル、プロファイルは、実行前に確認します。 +- 結果がどのチェックアウト、ブランチ、サーバー、リビジョンを示しているか把握します。 +- 妥当な最小限の修正を行い、変更後は証拠を更新します。 +- インストール、破壊的な操作、共有、PR のマージは明示的に承認します。 + +## 学習を続ける + +[Copilot App ワークショップ][app-workshop]では、グラフィカルなインターフェイスで共通の成果に到達し、キャンバスのマイルストーンも追加します。[VS Code ワークショップ][vscode-workshop]と[Cloud エージェントワークショップ][cloud-workshop]では、エージェントと作業するほかの方法を学べます。 + +[Awesome Copilot][awesome-copilot]で、指示、スキル、カスタムエージェントの例を探してください。[演習5のスキル例][skill-examples]には、コントリビューションのワークフロー、要件文書、図、ブラウザーテストがあります。コミュニティのコンテンツを採用する前に、前提条件と動作を確認します。 + +日々の参照には、[CLI コマンドリファレンス][cli-reference]、[エージェントスキルのドキュメント][agent-skills]、[カスタムエージェントのドキュメント][custom-agents]を利用してください。範囲を限定したタスクで試行を続け、確認済みの資料だけを承認された経路で共有します。 + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#ほかのスキルの例 +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/ja-jp/cli/2-add-star-rating.md b/docs/ja-jp/cli/2-add-star-rating.md new file mode 100644 index 00000000..e2fbd97a --- /dev/null +++ b/docs/ja-jp/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "演習 2 - 星評価を追加して小さな成果を得る" +description: "既存のゲーム評価を表示し、変更をレビュー・検証して、最初の pull request をマージします。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +理解して検証できる小さな変更から始めます。Tailspin Toys は各ゲームの `starRating` をすでに保存し、詳細ページに表示しています。この既存の値をゲームカードにも表示し、未評価のゲームにはわかりやすいメッセージを表示します。 + +この演習では、次のことを行います。 + +- Interactive の CLI セッションで、範囲を絞った変更を依頼する。 +- 差分を確認し、評価済みと未評価のカードを検証する。 +- コミットし、PR 1 を作成、レビュー、マージする。 + +## シナリオ + +訪問者はゲームの詳細ページで評価を確認できますが、カタログを見ながら比較できません。Tailspin Toys は、ゲームカードに既存の評価を表示し、未評価の状態も明確に示したいと考えています。この小さな変更で、より大きな機能に取り組む前に、作業の依頼、レビュー、リリースを練習します。 + +## 最初のマイルストーンを開始する + +学習用リポジトリのルートで、作業ツリーに未コミットの変更がないことを確認し、`main` を更新してブランチを作成します。`git status` に予期しない変更が表示されたら、切り替える前に解消してください。変更を破棄してはいけません。 + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +確認されたらリポジトリを信頼します。**Interactive** モードであることを確認し、`/model` で利用可能なモデルを調べるか、**Auto** を選択します。ツールの承認要求が表示されたら確認してください。 + +## 変更を依頼する + +次のプロンプトを送信します。 + +```plaintext +ゲームカードに各ゲームの星評価を表示してください。Game 型には starRating フィールドがすでにあります。5点満点の数値で、未評価のゲームでは null です。src/components/GameCard.astro の各カードに表示し、starRating が null の場合は代わりに "No rating yet" を表示してください。変更は小さく保ち、カードのレイアウト構造は変更しないでください。 + +リポジトリの指示を確認して従ってください。既存のデータモデルを使い、評価 API、新しいスキーマ、無関係な機能は追加しないでください。評価済みと未評価のケースに適したテストを追加または更新してください。まだコミット、プッシュ、pull request の作成はしないでください。 +``` + +Copilot は編集前に既存の型とコンポーネントを確認するはずです。最終回答だけでなく、ツールの実行内容も読んでください。自信のある要約だけでは、実装が正しい証拠にはなりません。 + +## レビューして検証する + +1. `/diff` を入力し、変更されたすべてのファイルをエディターまたは差分表示で確認します。 +2. カードが既存の `starRating` を使い、5点満点の値を表示し、`null` の場合は `No rating yet` を表示することを確認します。真偽値への変換だけで判定すると、数値のゼロを未評価と誤認する場合があります。 +3. カードのレイアウトを維持し、星の記号や色だけに頼らず、意味のあるテキストラベルで評価を伝えていることを確認します。 +4. 既存のチェックを使って変更を検証するよう Copilot に依頼します。 + + ```plaintext + package.json とテスト設定を確認し、このカードの変更に適した lint、型チェック、既存の単体テストまたは E2E テストを実行してください。数値の評価と null の代替表示を両方検証し、カバレッジの不足や実行できなかったチェックも含め、正確なコマンドと結果を報告してください。インストール、ブランチの変更、コミット、プッシュ、PR の作成はしないでください。 + ``` + +5. コマンド出力とテストの変更を確認します。リリース前に失敗を解消し、不足する前提条件をインストールする前に確認してください。 + +ブラウザーでカードを観察するには、同じチェックアウトで2つ目のターミナルを開き、次を実行します。 + +```bash +npm run dev +``` + +Codespace の **Ports** パネルで転送されたポートを開きます。ホームページで評価済みのカードを確認してください。現在のシードデータに未評価の例がなければ、`null` を扱う自動テストのフィクスチャを用意するよう求めてください。未評価のカードを観察したと主張してはいけません。E2E チェックの前、または演習を終える前に、開発サーバーのターミナルで Ctrl+C を押して停止します。Playwright の自動テストで別のチェックアウトのサーバーを再利用してはいけません。 + +## PR 1 を作成してマージする + +変更をレビューし、チェックが成功したら、このマイルストーンを別途承認します。 + +```plaintext +現在の差分とチェック結果をレビューしてください。レビュー済みの星評価の変更とテストだけをコミットし、現在のブランチをプッシュして、main を対象とする pull request を作成してください。リポジトリに PR テンプレートがあれば使ってください。変更の概要と実際の検証結果を含めてください。PR のマージや別のタスクの開始はしないでください。 +``` + +返された PR の URL を開きます。エージェントの要約だけでなく、**Files changed** とチェック結果を確認してください。CI を解釈する際は、Tailspin リポジトリのワークフロー定義を確認します。CI は自分で行うブラウザー観察の代わりにはなりません。失敗に対処し、変更したコードを再検証します。 + +PR がリポジトリのレビューとチェックの要件を満たしたら、**Merge pull request** を選択し、GitHub でマージを確定します。ブランチ保護によって別のレビュアーが必要な場合は、その承認を待ちます。PR が **Merged** であることを確認してから進んでください。 + +`/exit` で Copilot セッションを終了します。次の演習では、指示用のブランチを作成する前にローカルの `main` を更新します。未マージの機能ブランチから始めてはいけません。 + +## まとめと次のステップ + +範囲を限定したプロンプト、コードのレビュー、検証の証拠、PR のマージという最初のサイクルを完了しました。次は[カスタム指示で Copilot を導き][next-lesson]、2つ目の小さな PR でドキュメント規約を実証します。 + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/ja-jp/cli/2-custom-instructions.md b/docs/ja-jp/cli/2-custom-instructions.md deleted file mode 100644 index 43406601..00000000 --- a/docs/ja-jp/cli/2-custom-instructions.md +++ /dev/null @@ -1,239 +0,0 @@ ---- -title: "演習 2 - カスタム命令 (Copilot CLI)" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[← 前のレッスン: Copilot CLI のインストール][previous-lesson] · [次のレッスン: CLI でコードを生成する →][next-lesson] - -生成 AI を使って作業するときは、コンテキストが重要です。特定のやり方で進める必要があるタスクや、Copilot に知っておいてほしい背景情報がある場合は、そのコンテキストを確実に渡すことが大切です。Copilot を補助するためのツールはいくつかあり、このワークショップ全体で確認していきます。最初に取り上げるのは [instruction file][instruction-files] です。instruction file は通常、コードそのものをどのように構成すべきかに重点を置きます。これにより、どのようなコードが必要かだけでなく、どのように構成すべきかも Copilot に理解させられます。 - -この演習では、次のことを行います。 - -- リポジトリの custom instruction と、パス単位で適用される instruction file を通じて、プロジェクト固有のコンテキスト、コーディング ガイドライン、ドキュメント標準がどのように Copilot に渡るかを確認する。 -- *現在の* instruction のまま、フィルタリングの最初のデータ スライス（publishers helper）を生成する。 -- `.github/copilot-instructions.md` に、リポジトリ全体に適用される新しい標準を追加する。 -- フォローアップのプロンプトを実行し、再生成されたコードが新しい標準を取り入れる様子を確認する。 -- instruction の更新と helper を commit し、次の演習でその続きに取り組めるようにする。 - -> [!CAUTION] -> 生成されたコードは、設定した標準から外れることがあります。Copilot は非決定的です。目的は、instruction を更新したあとに振る舞いの傾向がどう変わるかを確認することであり、出力を 1 文字単位で一致させることではありません。 - -## Instruction files - -### シナリオ - -優れた開発チームと同様に、Tailspin Toys にも開発プラクティスに関するガイドラインと要件があります。たとえば次のような内容です。 - -- データ レイヤーには常に unit test が必要です。 -- UI はダーク モードで、モダンな印象にする必要があります。 -- ドキュメントは TSDoc の doc comment としてコード内に追加する必要があります。 -- 各ファイルの先頭には、そのファイルの役割を説明するコメント ブロックを追加する必要があります。 - -Instruction file を使うことで、これらのプラクティスに沿ってタスクを実行するために必要な情報を Copilot に確実に渡せます。 - -### Custom instructions - -Custom instruction を使うと、コンテキストや設定を Copilot に渡せるため、コーディング スタイルや要件をより正確に理解させられます。これは非常に強力な機能であり、より関連性の高い提案やコード スニペットを Copilot から引き出すのに役立ちます。好みのコーディング規約、使用するライブラリ、含めたいコメントの種類まで指定できます。instruction はリポジトリ全体に対して作成することも、タスク レベルのコンテキストとして特定のファイル種別向けに作成することもできます。 - -instruction file には 2 種類あります。 - -- `.github/copilot-instructions.md` は、リポジトリへの**すべて**のリクエストで Copilot に送られる単一の instruction file です。このファイルにはプロジェクト レベルの情報、つまり Copilot に送るほとんどの chat や CLI リクエストに関連するコンテキストを含める必要があります。たとえば、使用している技術スタック、作成中のものの概要、ベスト プラクティス、その他のグローバル ガイダンスなどです。 -- `.github/instructions/*.instructions.md` ファイルは、特定のタスクやファイル種別向けに作成できます。TypeScript や Astro のような特定の言語向けガイドラインや、UI component 作成、unit test 追加などのタスク向けガイドラインを提供するために使えます。 - -> [!NOTE] -> IDE で作業している場合、instruction file は Copilot Chat でのコード生成にのみ使用されます。コード補完や next-edit suggestion には使われません。 -> -> Copilot Chat、Copilot CLI、Copilot cloud agent は、コード生成時にリポジトリ レベルの instruction file と `*.instructions.md` ファイル（`applyTo` front matter 付き）の両方を使用します。 -> -> さらに、Copilot は [ほかの標準を使った instruction file][custom-instructions-support] もサポートしており、AGENTS.md や CLAUDE.md ファイルも利用できます。 - -### Instruction file を管理するためのベスト プラクティス - -instruction file の作成に関する詳しい説明は、このワークショップの範囲外です。ただし、サンプル プロジェクトに含まれている例は、代表的なアプローチを示しています。大まかには次のとおりです。 - -- `copilot-instructions.md` の instruction は、何を作っているかの説明、プロジェクト構造、グローバルなコーディング標準など、プロジェクト レベルのガイダンスに集中させます。 -- `*.instructions.md` ファイルは、ファイル種別（unit test、Astro component、データ レイヤー）や特定のタスク向けに、具体的な instruction を提供するために使います。 -- 自然言語を使います。ガイダンスは明確に保ちます。コードの望ましい形と望ましくない形の両方の例を示します。 - -instruction file の作り方に唯一の正解があるわけではなく、AI の使い方にも唯一の正解はありません。試行錯誤しながら、自分のプロジェクトに最適な方法を見つけてください。 - -> [!TIP] -> GitHub Copilot を使うすべてのプロジェクトには、充実した instruction file のセットがあるべきです。このプロジェクトの instruction file を見ていくと、[UI 更新][ui-instructions] や [Astro][astro-instructions] など、多くの種類のタスク向けのファイルがあることに気づくかもしれません。 -> -> Copilot は instruction file の生成も支援できます。各 surface で公開方法は異なります（たとえば VS Code の **Configure Chat → Generate Agent Instructions** や、Copilot CLI の `/init` など）。現在使用している surface のレッスンで、関係がある場面に案内があります。 -> -> テンプレートや出発点を探していますか。instruction file、custom agent、そのほかのリソースが集まったリポジトリ [awesome-copilot][awesome-copilot] を確認してください。 - -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support -## このプロジェクトの custom instruction file を確認する - -このリポジトリに含まれている instruction file をひととおり読んでみましょう。中核となる `copilot-instructions.md` が 1 つあり、さまざまなタスク向けの `*.instructions.md` ファイル群があります。エディターまたは GitHub の Web UI で開いて確認します。 - -1. `.github/copilot-instructions.md` を開きます。 -2. ファイルを確認し、プロジェクトの簡潔な説明に加えて、**Agent notes**、**Code standards**、**Scripts**、**Repository Structure** などのセクションに注目します。**Code standards** の中にある **GitHub Actions Workflows** に関するガイダンスにも注目してください。これらは Copilot とのあらゆるやり取りに適用されます。 -3. `.github/instructions` フォルダーを開いて中を見てみます。Astro ファイル、Drizzle データ レイヤー、test などに関する instruction があることを確認してください。 -4. `.github/instructions/unit-tests.instructions.md` を開きます。先頭にある `applyTo` フィールドに注目してください。ここには、どのファイルに instruction を適用するかを決める glob パターン（repo root からの相対パス）が設定されています。この例では、任意の TypeScript test ファイル（たとえば `**/*.test.ts` に一致するもの）が対象になります。 -5. このプロジェクトの unit test 作成に特化した instruction を確認します。 -6. 最後に `.github/instructions/drizzle.instructions.md` を開き、一番下までスクロールします。ほかの instruction file（`unit-tests.instructions.md` など）や、プロジェクト内の既存ファイルへのリンクがあることに注目してください。これにより、大きな instruction セットを小さく再利用しやすい単位に分割し、コード生成時に Copilot が従うべき例を示せます。（そこに書かれているパスは repo root ではなく instruction file からの相対パスです。） - -> [!NOTE] -> `copilot-instructions.md` の **Code formatting requirements** セクションには、このプロジェクトのコーディング標準が記載されていますが、コード内ドキュメントはまだ必須ではありません。次の手順で、TSDoc の doc comment とファイル コメント ヘッダーのルールを追加します。 -## ブランチを作成する - -コード変更を行うため、作業用ブランチを作成します。 - -1. codespace のターミナルで、新しいブランチを作成して切り替えます。 - - ```bash - git checkout -b update-custom-instructions - ``` - -2. Copilot CLI がインストール済みで、認証されていることを確認します。 - - ```bash - copilot --version - ``` - - コマンドが見つからない場合や、まだログインしていない場合は、[演習 1 - GitHub Copilot CLI のインストール](../1-install-copilot-cli/) に戻ってください。 - -## instruction を更新する*前に* Copilot CLI を使う - -custom instruction の効果を見るため、まずは現在の instruction を使ってコードを生成します。その後でファイルを更新し、フォローアップのプロンプトを実行します。 - -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 - -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. `.github/copilot-instructions.md` を自動的に読み取れるよう、Copilot CLI セッションが**repository root** から実行されていることを確認します。 -2. Copilot CLI のプロンプトで、フィルタリング UI が利用する publishers helper を生成するよう依頼します。 - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -3. Copilot CLI はプロジェクトを探索し、計画を提案し、この `--yolo` セッションでファイルを書き込みます。ターミナル出力の変化を確認し、その後エディターでレビューします。 -4. 生成された `src/lib/publishers.ts` をエディターで開きます。 -5. helper が型付き関数として生成され、第一引数に `db` client を受け取り、publishers の型付き配列を返していることを確認してください。これは `.github/instructions/drizzle.instructions.md` にあるデータ レイヤーの規約（`src/lib/*.ts` に適用される）によるものです。 -6. 生成されたコードに、TSDoc の doc comment とファイル レベルのコメント ヘッダーが**含まれていない**ことを確認します。 - -> [!CAUTION] -> Copilot は確率的に動作するため、指示しなくても doc comment を追加する可能性があります。その場合でも問題ありません。instruction 更新後に一貫性が向上することが、この演習での重要なポイントです。 - -## 新しいリポジトリ標準を追加する - -先ほど説明したように、`.github/copilot-instructions.md` は Copilot にプロジェクト レベルの情報を提供するためのファイルです。リポジトリのコーディング標準を文書化し、コード提案の質を高めましょう。 - -1. `.github/copilot-instructions.md` をもう一度開きます。 -2. **Code formatting requirements** セクションを探します。27 行目付近にあるはずです。ここにプロジェクトのコーディング標準が記載されている一方で、コード内ドキュメントに関するルールがまだないことに注目してください。そのため、生成された helper には doc comment がありませんでした。 -3. 既存の標準のすぐ下に、次の markdown 行を追加して、ファイル コメント ヘッダーと TSDoc の doc comment を追加するよう Copilot に指示します。 - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. `copilot-instructions.md` を保存します。 - -> [!TIP] -> 前のレッスンで見たとおり、instruction file はグローバル ガイダンス向けのリポジトリ レベル（`.github/copilot-instructions.md`）にも、特定の言語、ファイル種別、タスク向けの `*.instructions.md` としても作成できます。いま追加した doc comment ルールのような、プロジェクト全体に適用する標準を置く場所としては、リポジトリ レベルのファイルが適切です。 -## プロンプトを再実行して変化を確認する - -instruction に doc comment ルールを追加したので、先ほど生成した publishers ファイルを更新するよう Copilot CLI に依頼します。同じ標準ディレクティブが、書き換えの方向性を導きます。 - -1. Copilot CLI セッションで `/clear` を送信し、新しい会話を始めます。 -2. 次のプロンプトを送信します。 - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. 編集が完了したら、`src/lib/publishers.ts` をもう一度開きます。 -4. ファイルの先頭に、次のようなコメント ブロックが追加されていることを確認します。 - - ```typescript - /** - * Publisher data-access helpers for the Tailspin Toys Crowd Funding platform. - * Provides functions to retrieve publisher information from the database. - */ - ``` - -5. 生成された関数に、次のような TSDoc の doc comment が含まれていることを確認します。 - - ```typescript - /** - * Returns a list of all publishers with their id and name. - * - * @param db - The Drizzle database client. - * @returns A promise that resolves to an array of publisher objects. - */ - ``` - -6. この更新済みファイルはそのまま残してください。次の演習で、この最初のデータ スライスを土台として使います。 - -## フィルタリングの最初のスライスを commit して push する - -1. ターミナルで、変更されたファイルを確認します。 - - ```bash - git status - ``` - -2. instruction の更新と helper を stage します。 - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. 変更を commit します。 - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. ブランチを push します。 - - ```bash - git push -u origin update-custom-instructions - ``` - -## まとめと次のステップ - -このプロジェクトの instruction file から Copilot がどのようにコンテキストを取得するかを確認し、そのうえで Copilot CLI を使って次のことを行いました。 - -- *既存の* instruction を使って、フィルタリング用の publishers data-access helper の土台を生成する。 -- `.github/copilot-instructions.md` に、リポジトリ全体の新しい標準を追加する。 -- フォローアップのプロンプトを実行し、再生成されたコードが新しい標準を取り入れる様子を確認する。 -- instruction の更新と helper の土台の両方を commit して push する。 - -次は、[コード生成の演習][next-lesson] で、これらの instruction を適用しながらバックログの作業を実装します。 - -## リソース - -- [GitHub Copilot のカスタマイズ用 instruction file][instruction-files] -- [custom instruction 作成のベスト プラクティス][instructions-best-practices] -- [Copilot 向けの custom instruction をより良く書くための 5 つのヒント][copilot-instructions-five-tips] -- [Awesome Copilot — instruction file などのリソース集][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ diff --git a/docs/ja-jp/cli/3-custom-instructions.md b/docs/ja-jp/cli/3-custom-instructions.md new file mode 100644 index 00000000..4fa0e5e0 --- /dev/null +++ b/docs/ja-jp/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "演習 3 - カスタム指示で Copilot を導く" +description: "範囲を絞ったドキュメント規約を追加し、既存コードで実証して、2つ目の pull request をマージします。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +コンテキストは、*何を*作るかだけでなく、チームが*どのように*コードを書くことを期待しているかを Copilot が理解する助けになります。範囲を絞ったドキュメント規約を追加し、実際のコードへの効果を確認して、指示と実証をまとめて PR 2 としてマージします。 + +この演習では、次のことを行います。 + +- リポジトリ全体とパス別の指示を確認する。 +- フィルター機能を先に実装せず、ドキュメント規約を追加する。 +- 小さな既存のヘルパーやコンポーネントで規約を実証する。 +- 指示のマイルストーンを検証してマージする。 + +## シナリオ + +Tailspin Toys のチームは、有用なコードドキュメントを、毎回誰かが依頼しなければならないものではなく、繰り返し適用できる規約にしたいと考えています。リポジトリの指示に規約を追加し、動作を変更したりフィルター機能に先行着手したりせず、既存のコードで実証します。 + +## 指示を確認する + +リポジトリには、すでに2種類の有用な指示があります。 + +- `.github/copilot-instructions.md` は、技術スタック、構成、共通の慣行など、リポジトリ全体のコンテキストを提供します。 +- `.github/instructions/*.instructions.md` は対象を限定した指針を提供します。フロントマターの `applyTo` glob で、指示を適用するファイルを指定します。 + +エディターで次のファイルを開きます。 + +1. `.github/copilot-instructions.md` を読み、現在のコーディング規約と検証基準を確認します。 +2. `.github/instructions/` で、Astro、データ層、テストの指針を確認します。 +3. `unit-tests.instructions.md` で、`applyTo` パターンとテスト規約を確認します。 +4. `drizzle.instructions.md` で、データアクセスのパターンとサンプルへの参照を確認します。 + +リポジトリ全体の指示は簡潔にし、ファイル固有の詳細は適切な対象範囲のファイルに置き、同じルールの矛盾したコピーを避けます。[GitHub の指示サポートリファレンス][instruction-support]には、各ハーネスでサポートされる指示形式が説明されています。 + +> [!NOTE] +> 指示は生成に影響しますが、遵守を保証するものではありません。レビューでは、指示の文面とコードへの効果を両方確認します。Copilot がすでに良いコメントを生成しているなら、この演習の目的は規約を明示して再現可能にすることです。変更前後の失敗を無理に作ることではありません。 + +## マージ済みの PR 1 から始める + +星評価の PR がマージ済みであることを確認します。学習用リポジトリのターミナルで、更新済みの `main` から次のマイルストーンを始めます。 + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +作業ツリーに未コミットの変更がある場合や pull に失敗した場合は、その状態を解消してから進みます。**Interactive** モードを維持してください。 + +リポジトリの **Issues** タブで **Update our repository coding standards** を探し、実際の URL をコピーします。この Issue は、意図の説明、エクスポートされたデータ層関数とコンポーネントの契約の文書化、コメントの最新化という広いコンテキストを提供します。この演習で扱うのは範囲を限定したドキュメントの一部であり、リポジトリ全体のリファクタリングや、Issue の全条件を完了する約束ではありません。 + +## ドキュメント規約を追加する + +プレースホルダーを実際の Issue の URL に置き換えて送信します。 + +```plaintext +コンテキストとして、このコーディング規約の Issue を読んでください: 。既存のリポジトリ全体と対象範囲別の指示を確認してください。範囲を絞ったドキュメント規約を追加してください。コードを言い換えるのではなく意図を説明し、db/ と src/lib/ のエクスポートされた関数には TSDoc/JSDoc で目的、パラメーター、戻り値を記述し、再利用可能な Astro コンポーネントの Props 契約を文書化し、関連コードの変更時にはコメントを最新に保つようにしてください。 + +各ルールを適切な既存の指示ファイルに配置し、重複や矛盾を避けてください。既存のフォーマットと lint の基準を維持し、必要に応じて README にドキュメント規約へのリンクまたは要約を追加してください。変更はドキュメント規約に限定し、フォーマットツールの移行やリポジトリ全体の書き直しは行わないでください。スキルやエージェントの作成、フィルター機能の実装、コミット、プッシュ、PR の作成はしないでください。実証の前に指示を確認できるよう、そこで停止してください。 +``` + +差分を確認します。規約は有用なコメントを促すものであり、全ファイルへの定型ヘッダーや、自明なコードを繰り返すだけのコメントを要求するものではありません。修正が必要なら、先に依頼してから進みます。 + +## 実際のコードで規約を実証する + +リポジトリを確認して、小さな既存のエクスポートされたヘルパーや再利用可能なコンポーネントを選びます。パブリッシャーのヘルパーである必要はなく、`src/lib/publishers.ts` がすでに存在することも前提ではありません。 + +次を送信します。 + +```plaintext +更新した指示を使い、より明確なドキュメントが役立つ小さな既存のエクスポートされたヘルパー、または再利用可能な Astro コンポーネントを1つ選んでください。実行時の動作を変えたりフィルター機能を追加したりせず、そのファイルに規約を直接適用してください。どの指示が変更を導いたか説明し、コミットや PR の作成前に停止してください。 +``` + +実際に変更されたファイルを開きます。ヘルパーの場合は、パラメーター、戻り値、注入されるデータベース引数がコメントに正確に記述されているか確認します。コンポーネントの場合は、`Props` 契約が文書化されているか確認します。コメントブロックの有無だけでなく、説明がコードと一致していることを確認してください。 + +> [!TIP] +> チャット内の説明用スニペットは実証ではありません。実際のリポジトリの変更を確認してください。選んだコードがすでに規約を満たしている場合は、冗長なコメントを追加せず、改善が妥当な別の小さな既存箇所を選びます。 + +## PR 2 を検証してマージする + +レビュー済みの変更を検証するよう Copilot に依頼します。 + +```plaintext +指示の変更と小さなドキュメントの実証をレビューしてください。実行時の動作が変わっていないことを確認してください。package.json を確認し、npm run lint と npm run typecheck:all を実行してください。コードの変更に照らして必要なら、影響する既存のテストも実行してください。正確なコマンドと結果を報告してください。まだインストール、スキルの作成、コミット、プッシュ、PR の作成はしないでください。 +``` + +失敗を解消して最終差分を確認します。その後、マイルストーンを承認します。 + +```plaintext +レビュー済みのドキュメントの指示、直接関連する README の更新、小さなコードの実証だけをコミットしてください。現在のブランチをプッシュし、リポジトリの PR テンプレートに従って main を対象とする PR を作成してください。検証結果を含め、コーディング規約の Issue への部分的な貢献であることを明記してください。Issue の全条件を実際に満たしていない限り、Issue を閉じるキーワードは使わないでください。マージやフィルター機能の開始はしないでください。 +``` + +PR の URL を開き、**Files changed** と CI を確認します。必要なチェックとレビューがすべて通ったら、GitHub でマージし、PR 2 が **Merged** であることを確認します。`/exit` で CLI セッションを終了します。この PR がマージされるまで、次のマイルストーンを始めてはいけません。 + +## まとめと次のステップ + +ドキュメント規約と実際の実証が `main` に入りました。次は、そのマージ済みの状態から作成した新しいブランチで、[Plan と Autopilot を使ってフィルター機能を構築します][next-lesson]。 + +## リソース + +- [リポジトリのカスタム指示を追加する][repository-instructions]では、リポジトリ全体とパス別の指針を説明しています。 +- [Awesome Copilot][awesome-copilot]の例は、無条件に採用せず、確認して調整するために利用してください。 + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/ja-jp/cli/3-generating-code.md b/docs/ja-jp/cli/3-generating-code.md deleted file mode 100644 index 061fa324..00000000 --- a/docs/ja-jp/cli/3-generating-code.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "演習 3 - GitHub Copilot CLI でプロジェクト機能を追加する" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -想像のとおり、GitHub Copilot CLI で実行する中心的な作業は、プロジェクトに機能やコードを追加することです。バックログの issue を 1 つ取り上げ、実装を Copilot に手伝ってもらいましょう。 - -## シナリオ - -プロジェクトのフィルタリング機能を完成させるタイミングになりました。バックログにはフィルタリングに関する issue がすでにあり、前の演習でその土台となる helper も追加しています。Copilot に issue の詳細を取得してもらい、既存の作業を考慮しながら、残りの機能を実装してもらいます。 - -この演習では、次のことを行います。 - -- プラン モードを使って、フィルタリング機能を実装する計画を生成する。 -- Copilot を使って、Web サイトにフィルタリングを追加するためのコードを生成する。 - -この演習を終えるころには、プロジェクトに新しい機能が追加されています。 - -## プラン モードを活用する - -AI の優れた使い方の 1 つが計画づくりです。何を作りたいかの大まかなイメージはあっても、アイデアを整理したり、抜けや落とし穴を洗い出したりしたい場面はよくあります。AI ツールは、追跡質問を投げかけたり、異なる問題点や不足している要素を一緒に検討したりすることで、考えを明確にする助けになります。このプロセスを支えるために、Copilot CLI にはプラン モードが用意されています。さらに、計画にかけた時間は、設定された要件により適したコードを Copilot が生成する助けにもなります。 - -まずは、Copilot CLI のプラン モードを活用して新機能の作成プロセスを始めます。 - -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 - -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. 次のプロンプトを Copilot CLI に入力し、フィルタリング issue に基づく計画を作成します。 - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -2. 計画を作成する過程で、Copilot から追跡質問が表示されることがあります。表示された場合は、自分ならどのように機能を実装するかに基づいて答えてください。 -3. 計画が生成されたら、その設計図をレビューします。データ レイヤーや UI の残りの変更に加え、test の生成も推奨されていることに気づくはずです。 -4. Copilot CLI は、計画に対して追加のフィードバックを提供する機会を提示します。カーソルを案内された位置まで下げ、提案を入力すると、Copilot がそれを取り込んだ新しいバージョンの計画を作成します。 -5. 内容に満足したら、Copilot が提示する選択肢を選び、新機能の実装作業を開始します。 - -> [!NOTE] -> Copilot は確率的に動作するため、表示されるテキストや選択肢は完全には一致しません。ただし、実装の開始に進む選択肢が表示され、その文言は次のようなものになります。 -> -> `Yes, and switch to autopilot mode`. -> -> 上の例のように、Copilot から [autopilot mode](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot) を有効にする選択肢が提示される場合があります。autopilot mode を使うと、各ステップのたびに入力を待たずに、Copilot CLI がタスクを進められます。最初の指示を与えると、タスクが完了したと判断するまで Copilot CLI が各ステップを自律的に実行します。このワークショップでは隔離された環境で動作しているため、autopilot を有効にし、すべてのツールを許可しても問題ありません。 - -6. Copilot がファイルの生成作業を開始します。 - -> [!NOTE] -> この操作には数分かかることがあります。Copilot がファイルを編集 / 作成し、test を更新 / 生成し、すべて成功することを確認するために test を実行する様子が表示されます。ここまでに確認した内容を振り返ったり、飲み物を楽しんだりするのにちょうどよい時間です。 - -## コードをレビューする - -AI が生成したコードは、本番環境にマージする前に必ずレビューする必要があります。ここで少し時間を取り、Copilot が新機能の実装で作成 / 変更したファイルを確認しましょう。 - -1. Copilot CLI で次のコマンドを使い、「diff」またはコード変更を表示します。 - - ``` - /diff - ``` - -2. 変更されたファイルを確認します。左右の矢印キーで別のファイルに切り替えられます。新しい filter control とクライアント側フィルタリングが実装された games 一覧ページや `src/lib/games.ts`、さらに `games.test.ts` などの test が更新されているはずです。Copilot が既存の helper を完全な実装に合わせて調整した場合は、`publishers.ts` に変更が加わることもあります。 - -## まとめと次のステップ - -Copilot CLI の助けを借りて、Web サイトにフィルタリング機能を追加できました。具体的には次のことを行いました。 - -- プラン モードを使って、フィルタリング機能を実装する計画を生成する。 -- Copilot を使って、Web サイトにフィルタリングを追加するためのコードを生成する。 - -もちろん、次にやるべきことは、それが正しく動作することを確認することです。pull request を開く前に、[Playwright MCP サーバーで機能をテスト][next-lesson] しましょう。 - -## リソース - -- [Copilot CLI を使う][using-copilot-cli] -- [Copilot CLI について][about-copilot-cli] -- [Copilot CLI のコンテキスト管理][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/ja-jp/cli/4-build-filtering.md b/docs/ja-jp/cli/4-build-filtering.md new file mode 100644 index 00000000..a5ef978f --- /dev/null +++ b/docs/ja-jp/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "演習 4 - Plan と Autopilot でフィルター機能を構築する" +description: "フィルターの要件に合意し、実装計画を承認してコードを検証し、機能ブランチにチェックポイントを保存します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +次は、カテゴリとパブリッシャーでゲームを絞り込める、より大きな機能を構築します。コーディングの前に計画し、**Autopilot** を明示的に承認してから実装をレビュー・テストし、チェックポイントを保存します。この演習では、スキル、QA エージェント、機能の PR は作成しません。 + +この演習では、次のことを行います。 + +- フィルター機能の Issue を読み、Plan モードで不明確な要件について合意します。 +- Autopilot による範囲を限定した実装を明示的に承認します。 +- 差分と4つすべてのチェック結果をレビューし、チェックポイントを保存します。 + +## シナリオ + +Tailspin Toys のカタログが充実し、訪問者がカテゴリとパブリッシャーでゲームを絞り込める機能が必要になりました。バックログの Issue に機能は記載されていますが、カテゴリの組み合わせ方などはコーディング前に合意が必要です。Plan モードで決定事項を整理してから、Autopilot による範囲を限定した実装を承認します。 + +## フィルター機能のマイルストーンを開始する + +PR 1 と PR 2 がマージ済みであることを確認します。学習用リポジトリのターミナルで、次を実行します。 + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +作業ツリーに未コミットの変更がなく、`main` からの更新が成功した場合にのみ進みます。演習4～8では、同じブランチとチェックアウトを使用します。後のチェックポイントコミットでスキルと QA プロファイルを追加します。演習ごとにブランチを作成してはいけません。 + +## 実際の Issue を取得する + +リポジトリの **Issues** タブで **Allow users to filter games by category and publisher** を探し、URL をコピーします。テンプレートのファイル名や Issue 番号が、自分のコピーの Issue を特定できるとは限りません。 + +現在の Issue では、次のことが求められています。 + +- 1つ以上のカテゴリを選択する。 +- パブリッシャーで絞り込み、カテゴリと組み合わせる。 +- 両方のフィルターをサポートするデータアクセス用ヘルパーを `src/lib/` に用意する。 +- キーボードナビゲーション、適切な ARIA、見えるフォーカス状態、`data-testid` 属性を持つ、アクセシブルな操作部品を用意する。 +- ヘルパーには Vitest の単体テスト、フィルターの動作には Playwright の E2E テストによるカバレッジを用意する。 + +実際の Issue を正しい要件の情報源として読んでください。演習7の QA プロンプトで使えるよう、URL と承認した追加の取り決めを保存します。 + +## コーディングの前に計画する + +Shift+Tab で **Plan** モードを選ぶか、`/plan` で開始します。Issue のプレースホルダーを置き換えて送信します。 + +```plaintext +次の Issue に記載されたフィルター機能を計画してください: 。変更を提案する前に、Issue、リポジトリの指示、既存のデータアクセス用ヘルパー、UI、テストを読んでください。現在のチェックアウトを基準とし、パブリッシャーのヘルパーがすでに作成されていると仮定しないでください。 + +複数カテゴリの選択、パブリッシャーのフィルター、それらの組み合わせ、データアクセスの対応、アクセシブルな操作部品、単体テストと E2E のカバレッジを扱ってください。複数カテゴリの組み合わせ方、フィルターの解除、結果が空の場合など、未指定の動作は確認を求め、決定事項を承認済みの計画とともに記録してください。不要なサーバー API を導入せず、静的な Astro のアーキテクチャを維持してください。 + +現在のブランチでの実装を計画し、必要な単体テストと E2E テスト、npm run lint、npm run test:unit、npm run test:e2e、npm run typecheck:all による検証を含めてください。先に前提条件とサーバーの所有者を確認し、ソフトウェアのインストールや無関係なプロセスの停止はせず、阻害要因を報告してください。 + +計画に次の実行境界を含めてください。私が承認した後は、フィルター機能と必要なテストだけを実装し、チェックを実行してから、レビューできるように停止してください。quality-checks スキル、QA エージェント、後のワークショップで扱うほかの資産は作成しないでください。ブランチの変更、コミット、プッシュ、PR の作成やマージはしないでください。 + +私が計画を承認するまで、アプリケーションコードの編集や実装の開始はしないでください。 +``` + +追加の質問に回答します。後から隠れた受け入れ条件を追加してはいけません。実装、ブラウザーチェック、QA ですべて同じ要件を使えるよう、合意した回答を Issue の URL とともに保存します。 + +計画で、データ層と UI の変更、テスト、アクセシブルな操作部品、マージしたドキュメント規約を確認します。4つすべてのチェック、レビューのための停止条件、後のワークショップの資産・ブランチ変更・コミット・プッシュ・PR 操作の禁止が明記されていることを確認してください。制限や条件が欠けている場合、または Issue の範囲外の作業を提案している場合は、承認前に修正を依頼します。 + +## Autopilot を明示的に承認する + +計画にレビュー済みの範囲と実行境界が含まれていることを確認してから、計画の承認オプション **Accept plan and build on autopilot** を使います。使用中のバージョンで文言が異なる場合は、**Autopilot** に切り替えるオプションを明示的に選択し、モード表示を確認します。承認すると、範囲を限定した計画の実行が始まります。作業開始後のプロンプトで制限を追加することを前提にしてはいけません。 + +> [!CAUTION] +> Autopilot はツールの権限だけでなく、作業の継続を制御します。選択前に権限ダイアログを確認してください。完全な権限ではツール、パス、URL にアクセスできます。制限付きの権限では、承認が必要な操作が阻止される場合があります。Codespace の使用は、シークレットの公開や無関係なリソースの変更の許可ではありません。スキップしたチェックを成功扱いにせず、阻止されたアクセスを意識して解決してください。 + +作業とコマンドの結果を監視します。Autopilot は、計画を完了する前に継続回数の上限で一時停止したり、阻害要因を報告したりする場合があります。同じ範囲を維持し、その状態を確認してから継続を承認します。 + +## Interactive に戻ってレビューする + +実装が停止したら、追加のプロンプトを送る前に Shift+Tab で **Interactive** モードに戻します。タスク後も Autopilot が有効な場合があります。自動的に戻ったと仮定してはいけません。 + +`/diff` を入力し、変更されたすべてのファイルを確認します。実装を Issue と承認した追加の取り決めに照らし合わせます。 + +- 合意どおりに複数カテゴリを選択し、パブリッシャーで絞り込み、それらを組み合わせられますか。 +- データアクセス用ヘルパーは、UI を変えるだけでなく、実際にフィルターをサポートしていますか。 +- 操作部品には意味のあるラベル、キーボード対応、見えるフォーカス、安定したテスト識別子がありますか。 +- 既存のアサーションを弱めずに、合意した解除操作や空の結果も含めて、テストで動作を検証していますか。 +- コードはドキュメント規約に従い、静的アプリのアーキテクチャを維持していますか。 + +4つすべての npm チェックの証拠をレビューします。`quality-checks` はまだ作成していないため、チェックは直接実行します。Playwright の E2E 設定はビルドしてプレビューを配信します。古い内容を再利用しないよう、スイートの実行前に自分で起動した開発サーバーだけを停止してください。ポート競合やブラウザーの不足は解消すべき阻害要因であり、別のプロセスを停止したり成功を主張したりする理由ではありません。 + +必要に応じて範囲を絞った修正を依頼し、影響するチェックを再実行して、最終実装の検証をすべて完了します。ブラウザーでの直接観察は演習6で扱います。今回の自動検証とは目的が異なります。 + +## 実装のチェックポイントを保存する + +差分と結果に問題がなければ、ローカルのチェックポイントを承認します。 + +```plaintext +現在の差分と検証結果をレビューしてください。レビュー済みのフィルター機能の実装とテストだけを含むチェックポイントコミットを作成してください。現在のフィルター機能のブランチとチェックアウトを維持してください。まだプッシュ、PR の作成、スキルや QA エージェントの作成はしないでください。 +``` + +## まとめと次のステップ + +フィルター機能の要件に合意し、実装とテストをレビューして、チェックポイントを保存しました。テストしたリビジョンを記録し、Issue の URL と承認した追加の取り決めを保持します。**Interactive** を維持し、この同じチェックアウトで[演習 5 - quality-checks スキルを作成して使用する][next-lesson]に進みます。 + +## リソース + +- [Autopilot モードと権限][autopilot]では、自律的な継続と Interactive に戻る方法を説明しています。 +- [Copilot CLI コマンドリファレンス][cli-reference]には、現在のモード操作とコマンドが掲載されています。 + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ja-jp/cli/4-mcp.md b/docs/ja-jp/cli/4-mcp.md deleted file mode 100644 index 9b3541fa..00000000 --- a/docs/ja-jp/cli/4-mcp.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "演習 4 - Playwright MCP サーバーで機能をテストする" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Copilot CLI でフィルタリング機能を生成したので、pull request を開く前に、ブラウザーで正しく動作することを確認する必要があります。自分でアプリを操作して確認する代わりに、**Playwright MCP server** を接続し、Copilot に実際のブラウザーを操作させて機能をテストしてもらいます。 - -この演習では、次のことを行います。 - -- Model Context Protocol（MCP）とは何か、そして MCP server がどのように Copilot CLI を拡張するかを理解する。 -- Playwright MCP server を Copilot CLI に追加する。 -- ブラウザーでフィルタリング機能を手動テストするよう Copilot に依頼する。 - -## Model Context Protocol (MCP) とは - -[Model Context Protocol (MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/) は、AI agent が外部ツールやサービスと通信するための方法を提供します。MCP を使用すると、AI agent は外部ツールやサービスとリアルタイムでやり取りできます。これにより、最新情報にアクセスし（resources を利用）、代わりに操作を実行できます（tools を利用）。 - -これらの tool や resource には、MCP server を通じてアクセスします。MCP server は AI agent と外部ツールやサービスの間をつなぐブリッジとして機能します。MCP server は、AI agent と外部ツール（既存の API や NPM package のようなローカル ツールなど）の通信を管理します。各 MCP server は、AI agent がアクセスできる別々の tool と resource のセットを表します。 - -すでに広く使われている MCP server として、次のようなものがあります。 - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**: GitHub リポジトリを管理するための API セットにアクセスできます。新しいリポジトリの作成、既存リポジトリの更新、issue や pull request の管理などを AI agent が実行できます。 -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**: Playwright を使ったブラウザー自動化機能を提供します。Web ページへの移動、フォーム入力、ボタン選択などを AI agent が実行できます。 - -ほかにも、さまざまな tool や resource へのアクセスを提供する MCP server が多数あります。GitHub は、エコシステムの発見性とコントリビューションを高めるために [MCP registry](https://github.com/mcp) を公開しています。 - -> [!CAUTION] -> セキュリティの観点では、MCP server はプロジェクト内のほかの依存関係と同じように扱ってください。MCP server を使用する前に、ソース コードを慎重に確認し、公開元を検証し、セキュリティ上の影響を検討してください。信頼できる MCP server のみを使用し、機密性の高い resource や操作へのアクセスを与える際は慎重に判断してください。 - -> [!NOTE] -> [GitHub MCP server][github-mcp-server] は Copilot CLI に**組み込まれています**。そのため、追加設定なしで利用でき、ワークショップ全体を通して Copilot がリポジトリを読み書きできていたのはこの server によるものです。この演習では、Copilot にブラウザーを与えるために 2 つ目の server として Playwright を追加します。 - -## Playwright MCP server を追加する - -server を追加する最も手早い方法は、対話式の `/mcp add` コマンドです。ここでは、Copilot が制御できるブラウザーを提供する [Playwright MCP server][playwright-mcp-server] を登録します。 - -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 - -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI セッションで、次を入力します。 - - ```text - /mcp add - ``` - -2. 設定フォームが表示されます。Tab でフィールド間を移動し、次のように入力します。 - - - **Server Name**: `playwright` - - **Server Type**: **Local**（**STDIO** とも表示されます）を選択する - - **Command**: `npx @playwright/mcp@latest --headless` - - **Tools**: server のすべての tool を許可するため、`*` のままにする - -3. Ctrl+S を押して保存します。server は追加され、再起動なしですぐに利用できます。 - -`--headless` フラグを付けると、Playwright は表示ウィンドウなしでブラウザーを実行します。デスクトップ表示のない codespace 内ではこれが必要です。内部的には、server が `~/.copilot/mcp-config.json` に書き込まれます。 - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -4. MCP server の一覧を表示して、server が登録済みでアクティブであることを確認します。 - - ```text - /mcp show - ``` - -5. 組み込みの `github` server と並んで `playwright` が表示されるはずです。 - -> [!NOTE] -> Tailspin Toys プロジェクトでは、エンドツーエンド test にすでに Playwright を使用しています。そのため、Playwright が必要とするブラウザーは通常すでにインストールされています。後で Copilot からブラウザーが見つからないと報告された場合は、`npx playwright install chromium` を実行してから再試行してください。 - -## Web サイトを起動する - -Playwright MCP server がテストを実行するには、対象となるアプリが起動している必要があります。Copilot CLI で作業している間も実行し続けられるよう、**別の**ターミナルで Astro の dev server を起動します。 - -1. Ctrl+\` を選択して、codespace で新しいターミナルを開きます。 -2. Web サイトを起動します。 - - ```bash - npm run dev - ``` - -3. このターミナルはそのまま動かしておきます。`Astro server: http://localhost:4321` の表示が出たら、アプリの準備は完了です。 - -## フィルタリング機能をテストする - -Copilot CLI セッションに戻り、Copilot に機能をテストするよう依頼します。 - -[Playwright MCP server][playwright-mcp-server] は、Copilot に実際のブラウザーを操作させます。自分でアプリを操作して確認する代わりに、agent がページを開き、移動し、filter を適用し、その結果を読み取って要約できます。会話を離れずに、機能が期待どおりに動作することを確認する最も速い方法です。 - -内部的には、Playwright MCP server はスクリーンショットではなく、ページの [accessibility tree][playwright-mcp-server] を基に動作します。つまり、agent はボタン、リンク、リスト項目などの構造化されラベル付けされた要素を、支援技術と同じように扱います。そのため、簡単な機能確認が、軽いアクセシビリティの健全性チェックも兼ねることになります。 - -server を接続し、アプリを起動したら、次のように Copilot に依頼して、先ほど実装したフィルタリング機能を試してもらいます。 - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -Copilot は Playwright MCP server 経由でブラウザーを起動し、各ステップを実行して、確認結果を報告します。その要約を issue の受け入れ条件と照らし合わせて読み、違和感があれば、追跡質問をしたり、pull request を開く前にコード修正を依頼したりしてください。 - -> [!NOTE] -> このテストでは、アプリが `http://localhost:4321` で動作している必要があります。dev server を停止していた場合は、プロンプトを送る前に再起動してください。Copilot が初めて Playwright MCP server を使う際には、ブラウザーのダウンロードが必要になることがあります。ブラウザーが見つからないと報告された場合は、`npx playwright install chromium` を実行して再試行してください。 - -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -## まとめと次のステップ - -おめでとうございます。Playwright MCP server を使って、Copilot CLI で機能を手動テストできました。要点を振り返ると、次のことを行いました。 - -- Model Context Protocol（MCP）とは何か、そして MCP server がどのように Copilot CLI を拡張するかを学ぶ。 -- `/mcp add` で Playwright MCP server を追加する。 -- Copilot にブラウザー操作を任せ、出荷前にフィルタリング機能を検証する。 - -機能が正しく動作することを確認できたので、次の演習に進み、[agent skill の助けを借りて pull request を開く][next-lesson] ことができます。 - -## リソース - -- [MCP とは何か、なぜいま注目されているのか][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [Copilot CLI に MCP server を追加する][cli-add-mcp] -- [GitHub MCP Server][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers diff --git a/docs/ja-jp/cli/5-agent-skills.md b/docs/ja-jp/cli/5-agent-skills.md index 60f0cca0..8db5e501 100644 --- a/docs/ja-jp/cli/5-agent-skills.md +++ b/docs/ja-jp/cli/5-agent-skills.md @@ -1,119 +1,99 @@ --- -title: "演習 5 - エージェント スキルを使う" +title: "演習 5 - quality-checks スキルを作成して使用する" +description: "再利用可能なシェルスクリプト付き品質チェックスキルを Copilot に作成させ、内容を確認してフィルター機能のブランチで実行します。" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -アプリ開発では、build の生成、test の実行、pull request の作成といった繰り返し可能なタスクがよく発生します。**Agent skill** を使うと、Copilot やほかの AI agent に対して、それらのタスクをどのように実行すべきかを示すガイダンスを与えられます。skill は、agent が必要に応じて読み込める instruction、script、resource のフォルダーです。[Agent Skills は open standard][agent-skills-repo] であり、さまざまな agent が利用しています。そのため、同じ skill を Copilot Chat の agent mode、Copilot cloud agent、Copilot CLI、GitHub Copilot app の間で共有できます。 +フィルター機能を実装し、既存の npm コマンドでチェックしました。次は、これらのチェックを再利用可能な**エージェントスキル**にまとめます。演習4～8では同じフィルター機能のセッションとブランチを維持してください。この演習では pull request を作成しません。 -skill はプロジェクトの `.github/skills` フォルダー、またはグローバルな `~/.copilot/skills` に配置します。各 skill はフォルダー単位で、YAML frontmatter（`name` と `description`）を持つ `SKILL.md` ファイルと、その後に続く markdown の instruction で構成されます。 +この演習では、次のことを行います。 -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +- カスタマイズを作成する前に **Interactive** モードに戻る。 +- Copilot に `quality-checks` を作成させ、確認のために停止させる。 +- 同梱のスクリプトを通じて4つすべてのチェックを実行し、単一のテストファイルを指定する引数が、そのファイルだけを選択することを実証する。 +- フィルター機能と同じブランチにスキルのチェックポイントを保存する。 -skill には、script、asset、参照資料を含むサブフォルダーを追加することもできます。全体の構造は [agent skills specification][agent-skills-spec] で説明されています。 +## シナリオ -> [!TIP] -> skill は動的に読み込まれます。どの skill が適用されるかは、agent が `description` フィールドを基に判断します。明確でシナリオに即した説明にすることが、使われる skill と無視される skill を分けます。 +Tailspin Toys では、フィルター機能を変更するたびに同じ品質チェックが必要です。毎回の会話でコマンドと前提条件を説明する代わりに、チームは再利用可能なスキルを求めています。スキルを作成してスクリプトを確認し、別のリクエストでもチェックを正しく実行できるか検証します。 -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification -team の pull request が、定められた仕様に確実に従うよう skill を使う方法を見ていきましょう。 +## 指示、スクリプト、リソース -## シナリオ +スキルは、再利用可能なタスクの指示、実行可能なスクリプト、補助リソースをまとめたもので、エージェントが必要に応じて読み込みます。カスタムエージェントは、専門的な役割、指示、利用可能なツールを定義します。これらは補完関係にあります。カスタムエージェントは、スキルに同梱されたものを含め、スクリプトを実行できます。 -チームでは pull request（PR）に対して、次の要件を定めています。 +リポジトリのスキルは `.github/skills//SKILL.md` に配置し、`name` と `description` のフロントマターと Markdown の指示を持ちます。スクリプトやほかのリソースは、その隣に置きます。完成済みの答えをコピーせず、Copilot に `.github/skills/quality-checks/SKILL.md` と同梱のスクリプトを生成するよう依頼します。[Agent Skills 仕様][skill-spec]に形式が説明されています。 -- 明確な commit message にし、ファイルは論理的にグループ化する。 -- PR を作成する前に、すべての test が通過している必要がある。 -- 各 PR には次のセクションを含める必要がある。 - - 変更を行った理由の説明。 - - 変更したファイルの概要。 - - 重要なコード ブロックの抜粋。 - - 行った変更の詳細をまとめた説明。 +Copilot は検出したスキルの説明を使い、いつ読み込むかを判断します。すでに開いているセッションで新しいスキルがすぐ検出されるとは限りません。実行の節では、明示的に読み込む代替手順も示します。形式に移植性があっても、シェルやプロジェクトの前提条件は必要です。 -チームでは、Copilot を使ってコードや PR を生成しているため、AI ツールがこれらの要件に従うことを確実にしたいと考えています。 +## スキルを作成する -この演習では、次のことを行います。 +プロンプトを送る前に **Interactive** モードに戻します。現在のチェックアウトとブランチを維持してください。古いテンプレートから始めてこのスキルがすでにある場合は、カスタマイズを上書きせず、確認して拡張します。 -- pull request 作成用に既存の skill を確認する。 -- AI agent がどのように skill を利用するかを学ぶ。 -- skill の助けを借りて、ガイドラインに沿った PR を作成する。 +```plaintext +.github/skills/quality-checks/SKILL.md と、npm run lint、npm run test:unit、npm run test:e2e、npm run typecheck:all を呼び出す4本のスクリプトを作成してください。まず package.json、README、テスト設定、リポジトリの指示を読んでください。 -## skill を実行する +現在の環境を判別してください。macOS/Linux/WSL なら Bash の .sh スクリプト、ネイティブ Windows なら PowerShell の .ps1 スクリプトだけを作成し、不明な場合は質問してください。両方を作成しないでください。ラッパーの役割は、自分自身の配置場所からリポジトリのルートを解決し、そこにこのプロジェクトの package.json があることを検証して npm を呼び出すことに限定してください。不正なルートでは明確なエラーで失敗させてください。どの作業ディレクトリからでも、空白を含むパスでも動作するようにしてください。出力と失敗時の終了コードを維持し、PowerShell のネイティブコマンドの失敗も扱ってください。npm の区切り文字 -- は1回だけ挿入し、呼び出し側は余分な -- を付けずにツールの引数を直接渡すようにしてください。ポートやプロセスは管理しないでください。 -skill は、agent が必要だと判断したときに動的に読み込まれます。どの skill を使うかの判断は、`SKILL.md` ファイル内の description によって決まります。そのため、skill の用途を明確に定義した説明を書くことが重要です。 +SKILL.md に name と description のフロントマター、4本のラッパーを実行する指示、前提条件、トラブルシューティング、既存の単体テストファイル1つを使う例を含む移植可能な呼び出し例を記載してください。Bash の例はすべて bash を明示的に呼び出し、PowerShell の実行ポリシーは決して回避しないでください。Playwright のサーバー再利用について説明してください。停止してよいのは自分で実際に起動したサーバーだけとし、それ以外の場合は質問するようにしてください。 -## PR skill を確認する +スキルと必要なスクリプトだけを作成してください。チェックや調査用の試行、インストール、アプリケーションコードの変更、コミット、PR の作成はしないでください。内容を確認できるよう、そこで停止してください。 +``` -Tailspin Toys には PR 作成に関する要件があるため、AI ツールがこれらのガイドラインに従った PR を生成できるように skill が用意されています。どのような動作をするか理解するために、その skill を確認しましょう。 +## スキルを確認する -1. `.github/skills/make-contribution/SKILL.md` を開きます。 -2. name と description を確認します。description では、pull request の作成や commit の作成を求められたときに使うべき scenario が示されていることに注目してください。 -3. skill 全体を読みます。branch の作成方法、commit の作り方、pull request の内容に関するルールが定義されていることを確認します。 +1. エディターで `.github/skills/quality-checks/SKILL.md` と同梱のスクリプトを開き、差分を確認します。 +2. `name` と `description` がスキルの内容と適用する場面を説明しているか確認します。メタデータだけでなく、指示も読んでください。 +3. 実行手順が、lint、単体テスト、E2E、型チェックのために `.github/skills/quality-checks/` 以下の同梱スクリプトを実際に呼び出すことを確認します。 +4. 各ラッパーについて、スクリプトの場所を基準にしたルートの解決と、導き出したディレクトリにこのチェックアウトで使う対象の `package.json` があることを明示的に確認する処理を調べます。npm が祖先ディレクトリを探索してコマンドが成功しても、ルートが正しい証拠にはなりません。パスの引用符、引数の転送、出力の表示、失敗時の終了処理を確認してください。PowerShell はネイティブ npm コマンドの失敗を伝播する必要があります。 +5. 記載された単体テストの1ファイルだけを実行する例を確認します。npm の区切り文字 `--` はラッパーが挿入するため、呼び出し側は別の区切り文字を付けず、対象ツールの引数を直接渡します。再利用する指示には、マシン固有のチェックアウトの絶対パスを含めないでください。何かを実行する前に、不足を修正するよう Copilot に依頼してください。 +6. スクリプトは、ルートとマニフェストの検証、および既存の npm チェックの実行に限定します。ポートやプロセスに関する判断は、シェルのプロセス管理コードではなく SKILL.md に置きます。停止できるのはエージェントが実際に起動したサーバーだけであることを確認してください。作業ディレクトリやプロセス名の一致だけでは、所有者であると判断できません。成果物にはスキル、必須のラッパー、必要な共有ヘルパーだけを含め、一時的な調査用ファイルやデバッグ用ファイルを残さないようにします。 -## skill を使う +> [!NOTE] +> 現在の Tailspin Toys には Node.js 22.13 以降、プロジェクトの依存関係、E2E チェック用の Playwright Chromium が必要です。チェックアウトの README と `package.json` で前提条件を確認してください。前提条件の不足や PowerShell の実行ポリシーによる制限は、承認を得て解消する必要があります。自動インストール、ポリシーの回避、断りなく npm の直接実行に切り替える方法で対処してはいけません。 -先ほど触れたとおり、skill は Copilot CLI によって自動的に呼び出されます。そのため、必要なのは Copilot に PR を作成するよう依頼することだけです。 +## スキルを実行する -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 +前の演習の開発サーバーが停止していることを確認します。Playwright は E2E 用にビルドしてプレビューを配信しますが、ローカルの設定ではポート `4321` のサーバーを再利用できます。別のチェックアウトのサーバーは、この機能の有効な証拠にはなりません。 -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 +Copilot CLI に `/quality-checks` が表示される場合は、選択して検出済みのスキルを明示的に呼び出し、以下のリクエストを含めます。検出されていない場合は、このセッションで同じリクエストを直接送信します。この演習では、スキルを読み込む方法を代替手順として使用できます。 -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. 次のプロンプトを使って、Copilot に PR を作成するよう依頼します。 +```plaintext +.github/skills/quality-checks/SKILL.md を読み、その指示に従ってこのチェックアウトのフィルター機能を検証してください。まず各ラッパーのコードを調べ、npm による祖先ディレクトリのパッケージ探索に依存せず、このチェックアウトで使う対象の package.json を含むディレクトリを導き出し、不正なルートでは明確に失敗する処理があることを確認してください。失敗を再現するために、リポジトリのファイルを移動、名前変更、削除、変更しないでください。lint、単体テスト、エンドツーエンドテスト、型チェック用の同梱スクリプトを実際に実行してください。記載された単体テストの1ファイルだけを実行する例も実行してください。npm の区切り文字 -- はラッパーが挿入するため、対象ツールの引数を直接渡してください。テストランナーの結果から指定したファイルだけが実行されたことを確認し、そのファイル名と実行されたテストファイル数を報告してください。引数の表示や終了コード 0 だけでは、正しく選択された証拠にはなりません。 - ``` - Can you please create a pull request for me! - ``` +各スクリプトの呼び出しと結果を、失敗、スキップしたチェック、不足する前提条件も含めて報告してください。使用できないスキルのスクリプトを、断りなく npm コマンドの直接実行で置き換えないでください。テスト対象のチェックアウトとサーバーを特定し、自分で起動したサーバーだけを停止してください。インストールや別のプロセスの停止前には確認してください。アプリケーションコードやブランチの変更、コミット、プッシュ、pull request の作成はしないでください。 +``` -2. Copilot がリクエストを受け付けます。しばらくすると、Copilot が **make-contribution** skill を利用していることが表示されます。 +ツールの呼び出しと出力を確認します。4つすべてのスクリプトを実際に実行する必要があります。チェックの説明やスキップされたチェックは成功ではありません。単一ファイルの例では、指定したファイル名をランナーの実際のファイル別結果と報告された件数に照らし合わせ、そのファイルだけが実行されたことを確認します。ほかのファイルも実行された場合は、引数の表示や終了コード 0 では不十分です。失敗は有用な証拠です。スキルを修正するか、承認を得てセットアップの阻害要因を解消し、影響するチェックを再実行します。無関係なプロセスを停止したり、ポート競合を強引に解消したりしてはいけません。 -3. その後、Copilot は skill の instruction に従います。まず test を実行し、その後 branch、commit、最終的には PR を作成します。 -4. PR が作成されたら、リポジトリに戻って PR を開きます。セクションが skill で定められたガイドラインに従い、チームの要件に一致していることを確認してください。 -5. 次の演習に進む前に、このフィルタリング PR とアクセシビリティ作業を分けておけるよう、ローカル workspace を `main` から新しい branch にリセットします。 +## チェックポイントを保存する - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +スキルと結果をレビューしたら、ローカルのチェックポイントを承認します。 + +```plaintext +現在の差分をレビューし、quality-checks スキルのファイルだけのチェックポイントコミットを作成してください。既存のフィルター機能のブランチを維持してください。プッシュや pull request の作成はしないでください。 +``` ## まとめと次のステップ -agent skill の助けを借りて、文書化された要件に沿う新しい PR を作成できました。次のことを行いました。 +再利用可能な quality-checks スキルを作成して確認し、単一ファイルのテスト例も含めて実行しました。スキルのファイルは、演習8の機能 PR に、フィルター機能、QA プロファイル、関連テストと一緒に含めます。この同じチェックアウトで[演習 6 - Playwright MCP で機能を検証する][next-lesson]に進みます。 -- pull request 作成用に既存の skill を確認する。 -- AI agent がどのように skill を利用するかを学ぶ。 -- skill の助けを借りて、ガイドラインに沿った PR を作成する。 +## ほかのスキルの例 -skill はタスク向けに最適ですが、より高度な作業には [カスタム エージェント][next-lesson] を活用したくなります。次はそれを確認しましょう。 +これらのコミュニティの例は参考資料であり、追加のタスクではありません。採用する前に前提条件と動作を確認してください。 -## リソース +- [コントリビューションのワークフロー: `make-repo-contribution`][contribution-example]。 +- [要件文書: `prd`][prd-example]。 +- [図と同梱のエクスポートスクリプト: `drawio`][drawio-example]。 +- [ブラウザーテスト: `webapp-testing`][browser-example]。 -- [Agent Skills について][about-agent-skills] -- [Agent Skills 仕様][agent-skills-spec] -- [Agent Skills リポジトリ][agent-skills-repo] -- [awesome-copilot の Agent Skills][awesome-copilot-skills] +上流のコントリビューション例の名前は `make-repo-contribution` です。古い Tailspin テンプレートでは、異なる名前の `make-contribution` を使用していました。このワークショップは、どちらのコントリビューション用スキルにも依存しません。 -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/ja-jp/cli/6-custom-agents.md b/docs/ja-jp/cli/6-custom-agents.md deleted file mode 100644 index 0398cbe5..00000000 --- a/docs/ja-jp/cli/6-custom-agents.md +++ /dev/null @@ -1,112 +0,0 @@ ---- -title: "演習 6 - GitHub Copilot CLI のカスタム エージェント" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## custom agent とは - -GitHub Copilot の [カスタム エージェント][custom-agents-concept] を使うと、開発ワークフロー内の特定のタスクや領域に合わせた専門的な AI アシスタントを作成できます。リポジトリの `.github/agents` フォルダー内にある markdown ファイルで agent を定義することで、focused instruction、best practice、コーディング パターン、ドメイン固有の知識を Copilot に与え、特定の種類の作業をより効果的に進められるようにできます。チームは自分たちの専門知識を再利用可能な agent として定義できます。たとえば、[WCAG][wcag] への準拠を徹底するアクセシビリティ agent、secure coding practice に従うセキュリティ agent、一定の test pattern を保つ testing agent などです。 - -custom agent は、プロジェクトの `.github/agents` フォルダー、またはグローバルな `~/.copilot/agents` にある markdown ファイルで定義します。各ファイルには、少なくとも `name` と `description` を含む YAML frontmatter があり、その後に agent の振る舞い、専門性、instruction を定義する markdown プロンプトが続きます。 - -### custom agent と agent skill の比較 - -custom agent と [agent skill][agent-skills-concept] には、概念的に重なる部分があります。どちらも主に markdown ファイルで定義され、AI にどのように作業すべきかを伝えます。最も分かりやすい区別は、**custom agent** は作業者で、**skill** はツールだということです。 - -custom agent には独自の context window があり、作業を進める中で skill（さらにはほかの agent）をオーケストレーションすることを前提に設計されています。このラボでは、アクセシビリティ custom agent がガイドラインに照らしてサイトをレビューし、更新します。その過程で、pull request ワークフロー用の skill や、test の実行と管理を行う skill などを呼び出すことがあります。 - -> [!NOTE] -> custom agent の書き方に、唯一の「正しい」方法はありません。AI 全般に言えることですが、自分の環境やシナリオに合う形を見つけるために、テストと反復を行ってください。 - -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ -## シナリオ - -多くの Web アプリケーションは、すべてのユーザーにとって十分にアクセシブルとは言えず、現在作業している Web サイトも例外ではありません。アクセシビリティ上の不足を特定して解消するために、custom agent を使用します。 - -Tailspin Toys は、自社のクラウドファンディング プラットフォームを、視覚能力や好みにかかわらずすべてのユーザーが利用しやすいものにしたいと考えています。最近のユーザー フィードバックでは、現在の dark theme はテキストと背景色のコントラストが不十分で読みにくいという指摘がありました。このアクセシビリティ上の懸念に対応するため、デザイン チームは、ユーザーがオン / オフを切り替えられる high-contrast mode の実装を求めています。 - -アクセシビリティは重要であるため、できるだけ早く実装したいと考えています。そこで、機能生成のために custom agent を活用します。 -この演習では、次のことを行います。 - -- custom agent を確認する。 -- custom agent を有効にし、Copilot CLI を使ってタスクを割り当てる。 - -## アクセシビリティ custom agent を確認する - -アクセシビリティ用の custom agent は、すでに用意されています。Copilot をどのように導くのか理解するために、その内容を確認しましょう。 - -1. `.github/agents/accessibility.md` を開きます。 -2. `name` フィールドと `description` フィールドを持つ YAML frontmatter を確認します。 - -> [!CAUTION] -> `name` と `description` を含む frontmatter は、custom agent に必須です。 - -3. 続いて、次の内容が示されている各セクションを読みます。 - - アクセシブルな Web サイトのコードを生成するときの中核的な責務。 - - アクセシビリティのベスト プラクティス。 - - HTML、CSS、JavaScript のコード例。 - - よくある落とし穴やミスの一覧。 -## Copilot CLI で custom agent を使う - -Copilot CLI では、`/agent` コマンドを使って custom agent を開始できます。では、Web サイトに対してアクセシビリティの確認を実行しましょう。 - -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 - -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI のプロンプト ウィンドウで `/agent` と入力し、Enter を押して agent の一覧を表示します。 -2. 利用可能な agent の一覧から **Accessibility agent** を選択します。 -3. 次のプロンプトを使い、アクセシビリティ agent に対してアクセシビリティ関連のバックログ項目をレビューし、修正を生成するよう依頼します。 - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -4. Copilot がタスクの実行を開始します。まず issue を取得し、その後レビュー、更新の生成、最後に PR の作成へと進みます。PR を作成するときに、このプロジェクトの PR 用 skill を利用していることにも気づくはずです。 - -> [!NOTE] -> この処理には数分かかることがあります。ここまでに学んだ内容を振り返ったり、飲み物を楽しんだり、Copilot CLI で利用できる追加コマンドを扱う次のモジュールを先に読んだりするのによい時間です。 - -## まとめと次のステップ - -このレッスンでは、GitHub Copilot の [カスタム エージェント][custom-agents] を確認しました。custom agent は、特定のタスクや領域に合わせた専門的な AI アシスタントです。custom agent を使うと、チームの専門知識や標準を再利用可能な agent に落とし込み、Copilot が特定の種類の作業をより効果的に行えるよう導けます。 - -このレッスンで確認した内容は次のとおりです。 - -- custom agent がどのように定義されるか。 -- Copilot CLI で custom agent を使う方法。 - -次は、[いくつかの slash command][next-lesson] を確認し、Copilot CLI の追加テクニックを学びましょう。 - -## リソース - -- [カスタム エージェント][custom-agents] -- [リポジトリ用カスタム エージェントの作成][creating-custom-agents] -- [awesome-copilot のカスタム エージェント][awesome-copilot-agents] -- [organization で custom agent を使う準備][org-custom-agents] -- [enterprise で custom agent を使う準備][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents diff --git a/docs/ja-jp/cli/6-mcp-playwright.md b/docs/ja-jp/cli/6-mcp-playwright.md new file mode 100644 index 00000000..18707bc0 --- /dev/null +++ b/docs/ja-jp/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "演習 6 - Playwright MCP で機能を検証する" +description: "MCP でブラウザーに接続し、観察したフィルターの動作を Issue と承認済みの計画に照らし合わせます。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +フィルター機能の実装と quality-checks スキルは、すでに自動検証を済ませています。次は Copilot にブラウザーを提供し、機能を直接観察するよう依頼します。この演習は **Model Context Protocol（MCP）** による操作の実証であり、テストスイート全体の再実行ではありません。 + +同じフィルター機能のチェックアウトとブランチで **Interactive** モードを維持してください。MCP の設定で新しい機能マイルストーンを開始することはありません。 + +この演習では、次のことを行います。 + +- Playwright MCP を接続し、ブラウザーツールが利用可能か確認します。 +- 実際のフィルター動作を Issue と承認済みの条件に照らして確認します。 +- 観察結果をレビューし、自分が起動した開発サーバーを停止します。 + +## シナリオ + +自動チェックは成功しましたが、Tailspin Toys には訪問者の体験についての証拠も必要です。Copilot にブラウザーツールを提供してフィルターを操作し、表示されたゲームを合意した動作と比較します。操作に反応するだけで、フィルターが正しく動く証拠とは見なしません。 + +## MCP が追加する機能 + +[MCP][mcp-overview] は、サーバーを通じてエージェントを外部ツールやコンテキストに接続します。組み込みの GitHub MCP サーバーでは Issue と PR を扱えます。[Playwright MCP サーバー][playwright-mcp]は、ページを開く、アクセシブルな要素を確認する、移動する、操作部品を操作するといったブラウザーツールを提供します。 + +ブラウザーのアクセシビリティスナップショットは、エージェントが操作部品を特定する助けになりますが、アクセシビリティへの完全な準拠を証明するものではありません。単なる「問題なさそう」という報告を受け入れず、実際の操作と観察結果を Issue の要件と比較してください。 + +> [!CAUTION] +> MCP サーバーはプロジェクトの依存関係と同様に扱い、有効にする前に提供元、ソース、権限、パッケージのダウンロードを確認してください。組織のポリシーによって、実行できるサーバーが制限される場合があります。コミットする設定に認証情報を入れたり、演習を終えるためだけに未知のツールを承認したりしてはいけません。 + +## Playwright MCP を設定する + +1. 既存の CLI セッションで `/mcp` を入力して設定済みサーバーを確認します。動作する Playwright の設定があれば、重複して追加せず再利用します。 +2. 必要に応じて `/mcp add` を入力し、Tab でフォーム内を移動します。 +3. **Server Name** を `playwright`、**Server Type** を **STDIO**（または **Local**）、**Command** を `npx @playwright/mcp@latest --headless` に設定します。 +4. 確認済みのこのブラウザーサーバーでは、**Tools** を `*` に設定します。これでツールが利用可能になりますが、CLI の権限制御を置き換えるものではありません。 +5. パッケージと起動コマンドを確認してから、Ctrl+S を押して保存します。登録するとサーバーが起動し、パッケージがダウンロードされる場合があります。このセットアップを意識して承認し、パッケージの確認プロンプトに対応してください。 +6. `/mcp show playwright` を入力し、サーバーが接続済みで、ブラウザーツールを利用できることを確認します。 + +ヘッドレスブラウザーにはデスクトップウィンドウが不要なため、Codespaces に適しています。対話形式の追加手順は設定を `~/.copilot/mcp-config.json` に保存し、CLI の再起動なしでサーバーを利用可能にします。これはユーザー設定であり、機能の PR に含めるファイルではありません。[MCP セットアップガイド][mcp-setup]には、各フィールドと設定の取得元が説明されています。 + +> [!NOTE] +> プロジェクトの E2E 依存関係と MCP ブラウザーは関連していますが、異なるセットアップが必要な場合があります。ブラウザーやシステム依存関係が不足している場合は、実際のエラーを確認し、承認を得て該当する前提条件を解消してください。ブラウザーを自動でインストールしたり、サーバーが接続済みならブラウザーも起動できると判断したりしてはいけません。 + +## 正しいアプリを起動する + +同じフィルター機能のチェックアウトで別のターミナルを開きます。ディレクトリとブランチを確認し、アプリを起動します。 + +```bash +pwd +git branch --show-current +npm run dev +``` + +サーバー出力から実際のローカル URL を確認します。Codespace では MCP サーバーとアプリが同じ環境で実行されるため、ブラウザー向けの転送 URL が必要だと決めつけず、通常は `http://localhost:4321` となるローカル URL を使います。 + +ポートが使用中の場合や Astro が別のポートを選んだ場合は、サーバーの所有者を確認してから進みます。所有者不明のサーバーを再利用したり停止したりしてはいけません。自分で起動したプロセスの URL を使い、テスト中はそのターミナルを開いておきます。 + +## フィルターの動作を観察する + +プレースホルダーを、実際の Issue の URL、演習4で承認した追加の取り決め、アプリの URL に置き換えます。 + +```plaintext +設定済みの Playwright MCP サーバーを使い、次の Issue に照らしてフィルター機能を検証してください: 。計画時に承認した追加の取り決めは次のとおりです: <合意した追加の取り決めを貼り付けるか、なければ none と記入>。このチェックアウトのアプリは で実行されています。結果を利用する前に、テスト対象のチェックアウト、ブランチ、サーバーを確認してください。 + +ゲームページを開き、フィルター未適用の状態を記録し、1つのカテゴリ、次に複数のカテゴリを選択してください。パブリッシャーのフィルターを適用し、カテゴリとパブリッシャーの選択を組み合わせてください。承認済みの条件に従って、フィルターの解除と結果が空になる場合の動作を確認してください。操作部品のラベル、キーボード操作、見えるフォーカスを確認してください。表示された結果を選択したフィルターと元のデータに照らし合わせ、操作部品が変わっただけで成功と判断しないでください。 + +実際のブラウザーツールを操作し、各条件について観察した内容を報告してください。失敗と証拠の不足は明示してください。このブラウザー演習のためだけにテストスイート全体を再実行したり、アプリケーションコードを変更したり、テストやカスタマイズを作成したり、ブランチを変更したり、コミット、プッシュ、PR の作成をしたりしないでください。インストールや別のプロセスの停止前には確認してください。 +``` + +ブラウザーツールの呼び出しと報告を確認します。Copilot は実際に複数カテゴリを選び、パブリッシャーと組み合わせたでしょうか。返されたゲームは合意した動作と一致しているでしょうか。報告では、ブラウザーで観察できる動作と、データ層や自動テストのカバレッジを区別しているでしょうか。 + +失敗があれば、観察した動作を記録します。範囲を絞ったアプリケーションの修正は別途承認し、影響するブラウザーチェックと自動チェックを再実行します。実装に合わせて受け入れ条件を変更したり、古い証拠を変更後のコードの検証として扱ったりしてはいけません。 + +## 自分のサーバーを停止して次に進む + +開発サーバーを起動したターミナルで Ctrl+C を押して停止します。Playwright MCP の設定は利用可能なままにします。演習7では、新しいブラウザー観察と自動 E2E チェックを調整して実行します。その際、古い開発サーバーや別のチェックアウトのアプリを再利用してはいけません。 + +## まとめと次のステップ + +QA プロファイルを作成する前も **Interactive** を維持します。別の PR やブランチを作らずにブラウザーの動作を観察できました。次は[QA エージェントを作成して使用し][next-lesson]、要件、カバレッジ、スキル、最終的な証拠をまとめます。 + +## リソース + +- [Copilot CLI に MCP サーバーを追加する][mcp-setup]では、セットアップと管理を説明しています。 +- [Microsoft Playwright MCP][playwright-mcp]では、ブラウザーの設定とツールを説明しています。 +- [GitHub MCP レジストリ][mcp-registry]には、検討できるほかのサーバーが掲載されています。 + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/ja-jp/cli/7-qa-agent.md b/docs/ja-jp/cli/7-qa-agent.md new file mode 100644 index 00000000..7789ae15 --- /dev/null +++ b/docs/ja-jp/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "演習 7 - QA エージェントを作成して使用する" +description: "テストのカバレッジ、quality-checks スキル、ブラウザーで直接得た証拠を組み合わせる、要件を起点とした QA プロファイルを作成します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +繰り返し実行できるチェックを実行し、Playwright MCP でフィルター機能を確認しました。次は**QA カスタムエージェント**を作成し、要件、カバレッジ、ブラウザーの証拠をまとめます。フィルター機能のセッション、チェックアウト、ブランチを維持してください。機能の PR は演習8で扱います。 + +この演習では、次のことを行います。 + +- 要件を起点とする QA プロファイルを作成して確認します。 +- プロファイルを選択し、カバレッジ、チェック結果、ブラウザーの証拠をレビューします。 +- 通常のエージェントに戻り、プロファイルと必要なテストのチェックポイントを保存します。 + +## シナリオ + +Tailspin Toys はフィルター機能のリリースを準備しています。テストの成功だけでは、合意したすべての要件がカバーされているとはいえません。チームには、Issue と実装を比較し、不足を特定して、レビューの準備ができているか説明する重点的な確認が必要です。QA プロファイルは、人間の判断を置き換えることなく、この評価を方向付けます。 + +## QA プロファイルを作成する + +**Interactive** モードを維持します。プロファイルは専門家の役割と指示を定義し、スキルは再利用可能なタスクの指示、スクリプト、リソースをまとめます。QA エージェントは、自分で作成したスキルと設定済みの MCP ツールを置き換えるのではなく、利用します。 + +次のプロンプトを送り、実行前に定義を確認します。 + +```plaintext +.github/agents/qa.agent.md に再利用可能な QA カスタムエージェントを作成してください。まずリポジトリの指示、package.json、テスト設定、.github/skills/quality-checks/SKILL.md を確認してください。プロファイルには有効な YAML フロントマターを付け、name を QA とし、description で使う場面を説明してください。モデルを固定したり tools リストを追加したりせず、ハーネスで利用可能なツールと権限を継承してください。エージェント定義だけを作成し、実行前に内容を確認できるよう停止してください。 + +エージェントの指示では、すべての QA タスクを Issue とユーザーが提供した承認済みの受け入れ条件から始めることを必須にしてください。実装ではなく、これらの要件を正しい基準として扱ってください。要件が不足しているか曖昧な場合は質問してください。機能と既存のテストを確認し、各条件を適切な自動テストのカバレッジと観察可能な動作に対応付けてください。 + +設定済みの Playwright MCP サーバーによるブラウザーの直接検証と、既存の quality-checks スキルおよび同梱スクリプトによる lint、単体テスト、エンドツーエンドテスト、型チェックの実行を必須にしてください。スキルが自動検出されていなければ明示的に読んでください。スキル、MCP ツール、前提条件、アクセスが不足している場合は、実行が阻害されていると報告してください。断りなく別のワークフローに置き換えたり、スキップしたチェックを成功扱いにしたりしないでください。テスト対象のチェックアウトとサーバーを特定し、別のワークツリーのサーバーを再利用せず、エージェントが起動したサーバーだけを停止してください。インストールや別のプロセスの停止前には確認してください。 + +QA エージェントは、リポジトリの指示に従い、実際にカバレッジが不足している箇所に必要最小限のテストを追加できるようにしてください。カバレッジがすでに十分なら、追加のテストがないことも妥当です。アサーションを弱めたり、失敗するテストを無効にしたり、コードに合わせて受け入れ条件を変えたり、私の承認なしにアプリケーションコードを変更したりしないでください。変更後は影響するチェックを再実行し、変更後のリビジョンの最終検証を完了してください。各条件を証拠と成功・失敗・阻害の状態に対応付け、追加したテストまたは追加不要だった理由、4つすべてのチェック結果、未解決の不具合を示す簡潔な報告を必須にしてください。GO には必要なチェックと証拠がすべてそろっている必要があり、そうでなければ理由とともに NO-GO を報告してください。QA 中はブランチの変更、コミット、プッシュ、PR の作成やマージ、追加のエージェントやスキルの作成はしないでください。 +``` + +## プロファイルを確認する + +エディターで `.github/agents/qa.agent.md` を開き、差分を確認します。`description` は必須です。この演習では、わかりやすい `name` として `QA` も指定します。固定された `model` や、勝手に作られたツール一覧がないことを確認します。`tools` を省略すると利用可能なツールを継承しますが、ハーネスの権限を回避するわけではありません。本番用のプロファイルでは、意図的にツールを制限できます。 + +指示が要件から始まり、実際の MCP ブラウザー操作とスキルのスクリプトを要求し、妥当なテスト追加だけを許可し、阻害要因を正直に報告することを確認します。専門家のプロファイルもスキルも、別のコンテキストウィンドウやほかのエージェントのオーケストレーションを必要としません。 + +## Issue に対して QA を実行する + +実行プロンプトは、プロファイルを読む既定のエージェントではなく、選択した **QA** カスタムエージェントに送るものです。別の機能ブランチを作成せず、同じチェックアウトで新しい CLI の会話を開始して新しいプロファイルを読み込みます。 + +1. フィルター機能の Issue の URL と承認した追加の取り決めを保持します。現在のエージェントの完了を待ち、`/exit` を入力してターミナルに戻ります。 +2. `git branch --show-current` と `git status --short` で、フィルター機能のリポジトリのディレクトリと同じブランチにいることを確認します。ブランチの切り替えやワークツリーの作成はしないでください。 +3. リポジトリのプロファイルを指定して CLI を起動します。 + + ```shell + copilot --agent qa + ``` + +4. 実行前に、CLI が選択済みのエージェントとして **QA** を表示していることを確認します。[CLI コマンドリファレンス][cli-reference]には `--agent` が説明されています。プロファイルを書いたり読んだりするだけでは有効化されません。選択に失敗した場合や、エージェントが設定済みの Playwright MCP ツールとスキルにアクセスできない場合は、一時停止して講師と阻害要因を解消してください。 + +両方のプレースホルダーを、実際のフィルター機能の Issue の URL と、演習4で承認した追加の取り決めに置き換えます。Issue だけで要件が十分な場合は `none` を使います。前のエージェントの記憶に依存してはいけません。 + +```plaintext +次の Issue に照らしてフィルター機能を検証してください: 。計画時に承認した追加の受け入れ条件は次のとおりです: <合意した追加の取り決めを貼り付けるか、なければ none と記入>。 + +Playwright MCP サーバーで動作を検証し、テストのカバレッジを確認して、不足するカバレッジに対してだけテストを追加し、quality-checks スキルを通じて検証を実行してください。証拠、チェック結果、阻害要因を報告してください。私の承認なしにアプリケーションコードを変更しないでください。コミットや pull request を作成しないでください。 +``` + +## 証拠をレビューする + +レポートを Issue に照らし合わせます。各条件には、適切な自動テストのカバレッジと観察可能な動作が必要です。実際の Playwright MCP ツールの操作、チェックアウトとサーバーの識別情報、4つすべてのスキルスクリプトの結果を確認してください。ブラウザーチェックと自動 E2E で、古いサーバーや別のチェックアウトを再利用してはいけません。 + +追加されたテストをレビューします。アサーションを弱めず、実際の不足を埋める必要があります。カバレッジが十分なら、新しいテストがないことが適切です。阻害や失敗による **NO-GO** の判定は有効な結果であり、証拠を省く許可ではありません。 + +QA がアプリケーションの不具合を見つけた場合は、範囲を絞った修正を別途承認し、変更後のリビジョンで影響するチェックとブラウザー観察を再実行します。不足する前提条件やツールには、明示的な対処が必要です。古い証拠を変更後のコードの証明として扱ってはいけません。 + +## チェックポイントを保存する + +QA が完了したら、Issue の URL、承認した追加の取り決め、テストしたリビジョン、ブラウザー観察、チェック結果を含むレポートを保持します。`/exit` を入力し、同じディレクトリとブランチから `--agent` を付けずに `copilot` を起動して通常の会話に戻ります。これらのコンテキストを再度渡してください。新しい会話は QA の会話の証拠を引き継ぎません。 + +プロファイル、テストの変更、得られた証拠をレビューしたら、通常のエージェントに次のリクエストを送信します。 + +```plaintext +現在の差分をレビューし、QA エージェント定義と承認済みのテスト変更のチェックポイントコミットを作成してください。既存のフィルター機能のブランチを維持してください。プッシュや pull request の作成はしないでください。 +``` + +## まとめと次のステップ + +QA プロファイルを作成して選択し、証拠をレビューして、プロファイルと必要なテストを保存しました。未解決の指摘は引き継いでください。失敗や阻害の判定はマージの承認ではありません。フィルター機能、スキル、QA プロファイル、テスト、現在の検証の証拠をそろえて、[演習 8 - 機能の PR を作成してマージする][next-lesson]に進みます。 + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ja-jp/cli/7-slash-commands.md b/docs/ja-jp/cli/7-slash-commands.md deleted file mode 100644 index b884222d..00000000 --- a/docs/ja-jp/cli/7-slash-commands.md +++ /dev/null @@ -1,178 +0,0 @@ ---- -title: "演習 7 - GitHub Copilot CLI のスラッシュ コマンド" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -優れた CLI ツールと同様に、GitHub Copilot CLI には多くの slash command が用意されています。これらのコマンドは、高度な機能、「内部で何が起きているか」に関する情報、追加の設定オプションを提供します。すでに `/clear` でコンテキストのクリアを、`/mcp` で MCP server の確認を行いました。ここでは、`/context`、`/model`、`/share`、`/delegate` など、ほかの強力なコマンドを確認します。 - -## シナリオ - -中核となる CLI フローは完了しました。ここからは追加機能として、セッションの共有、モデルの切り替え、[Copilot cloud agent][about-cloud-agent] へのタスク委任を見ていきます。 - -この演習では次を使用します。 - -- `/share` で GitHub gist を作成し、チームとセッションを共有する。 -- `/context` で、Copilot CLI が現在使用しているコンテキストを確認する。 -- `/model` で利用可能なモデルの一覧を確認し、必要に応じて別のモデルを選択する。 -- `/delegate` で、必要に応じてタスクを cloud agent に引き渡す。これには cloud agent が必要で、Copilot Student、Pro、Pro+、Business、Enterprise で利用できます。つまり Copilot Free を除くすべてのプランで利用可能です。 - -## セッションを共有する - -AI ツールを含め、どのツールでも使いこなすにはスキルが必要です。チームで協力し、学びを共有し合うことが、全員の体験を改善し、より質の高いコードを生み出す最善の方法です。そのために、Copilot CLI には `/share` コマンドがあります。`/share` コマンドは、使用した prompt や Copilot がたどったロジックを含むセッションの詳細を、markdown ファイルまたは GitHub gist として生成できます。 - -チームと共有できる GitHub gist を作成してみましょう。 - -> [!TIP] -> **Copilot CLI セッションを開始する** -> -> 以下の演習を始める前に、codespace に戻ってターミナルを開きます（まだ開いていない場合は Ctrl+\`）。次に、`--yolo` と `--enable-all-github-mcp-tools` を付けて Copilot CLI を起動します。 -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 新しく開始する代わりに、このプロジェクトの直近のセッションを引き継ぐには `copilot --yolo --enable-all-github-mcp-tools --continue` を実行します。前の演習から Copilot CLI がすでに実行中であれば、`/clear` を送ってクリーンな会話を開始してください。 -> -> `--enable-all-github-mcp-tools` を付けると、現在のセッションで GitHub MCP の読み取り / 書き込みツールが有効になります。これにより、ワークショップの流れの中で Copilot がバックログを読み取り、pull request を開けるようになります。 - -> [!CAUTION] -> `--yolo` は完全な自動権限（`--allow-all-tools`、`--allow-all-paths`、`--allow-all-urls`）を有効にします。Codespace や VM のような分離された環境でのみ使用し、日常的な開発の既定値として alias しないでください。詳しくは [Allowing and denying tool use][allow-all-warning] を参照してください。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI のプロンプト ウィンドウで、次のコマンドを送信します。 - - ``` - /share gist - ``` - -2. 少し待つと、Copilot が gist を作成し、リンクを表示します。 -3. リンクの文字列をコピーします。 -4. 新しいブラウザー タブでそのリンクを貼り付け、gist を確認します。送信した prompt、使用した skill と agent、Copilot の思考過程、さらにローカルで実行したコマンドのコードと結果まで記録されていることに注目してください。 - -`/share` が生成する gist と markdown ファイルは、コードがどのように生成されたかを文書化したり、望ましい結果を得るためにどのような操作を行ったかをチームと共有したりする用途に使えます。 - -## Copilot CLI のコンテキストを確認する - -より大きなタスクや複雑なタスクに取り組むと、モデルの最大 context window に近づくことがあります。window の正確なサイズは、使用しているモデルや Copilot CLI のバージョンによって異なります。context window が上限に達すると、Copilot CLI は自動的に compact を実行し、情報を要約して、現在のタスクに不要と判断した内容を取り除きます。slash command を使えば、現在のコンテキストの状態を確認することも、手動で compact することもできます。では、context window を見てみましょう。 - -1. Copilot CLI のプロンプト ウィンドウで、次のコマンドを送信します。 - - ``` - /context - ``` - -2. 少し待つと、Copilot CLI が現在のコンテキストを視覚的に表現した表示を生成します。 - - ![Copilot CLI の context window のスクリーンショット](../../_images/cli-7-context-window.png) - -3. 表示されているモデル名（画像と異なる場合があります）と、現在使用されている token の割合を確認します。その他の情報では、次の内容が示されています。 - - | Title | Description | - | ------------ | ------------------------------------------------------ | - | System/Tools | instruction file、ファイル内容、tool 定義 | - | Messages | 自分と Copilot の会話履歴 | - | Buffer | Copilot CLI が応答生成のために確保している予約領域 | - | Free space | 残りの空き領域 | - -4. 次の slash command を Copilot CLI に送信し、会話履歴を compact します。 - - ``` - /compact - ``` - -5. 完了したら、次のコマンドを送信して現在のコンテキスト統計をもう一度表示します。 - - ``` - /context - ``` - -6. コンテキストの変化を確認します。現時点では context window がまだ比較的小さいため、大きな変化は見られないかもしれません。 - -> [!NOTE] -> Copilot CLI は、コンテキストがいっぱいになると自動的に compact を実行します。容量が 100% に近づくと、その割合がプロンプト ウィンドウの上に表示されます。通常は非同期に compact を実行するため、処理中でも Copilot との対話を続けられます。ただし、処理中の操作が数秒間ブロックされる場合があります。 - -### コンテキストに関するベスト プラクティス - -ほとんどのセッションでは、Copilot 自身が効率的にコンテキストを管理するため、特別な指示は必要ありません。ただし、状況によっては履歴を手動でクリアまたは compact したいことがあります。 - -- アプリケーションの別の部分や、無関係なタスクに切り替える場合は、古い無関係なコンテキストで Copilot を混乱させないよう `/clear` を使って新しい会話を始められます。 -- 最大 context window に近づいている場合は、`/compact` を手動で実行して、そのタイミングを制御できます。 - -> [!CAUTION] -> 繰り返しになりますが、ほとんどの場合は Copilot が直接操作なしでコンテキストを管理します。古い情報のせいで少し混乱しているように見えるときや、これから無関係なタスクに切り替えるときに、手動コマンドの利用を検討してください。 - -## モデルを選択する - -モデルにはそれぞれ異なる強みがあり、開発者によって好みも異なります。Copilot CLI では、使用したいモデルの一覧表示と選択ができます。 - -1. 次の slash command を Copilot CLI に送信し、モデル一覧を表示します。 - - ``` - /model - ``` - -2. モデルの一覧を確認します。各モデルには、名前とリクエスト単位のコスト修正値が表示されます。 -3. 必要であれば新しいモデルを選択します。終了したい場合は Esc を押します。 - -> [!CAUTION] -> Copilot CLI では、モデル選択が保持されます。 - -## cloud agent に委任する（任意） - -ターミナルで作業を続けながら、時間のかかるタスクは Copilot cloud agent に任せたい場面があります。`/delegate` コマンドを使うと、現在の Copilot CLI セッションを GitHub.com に送信できます。cloud agent がそのセッションを引き継ぎ、非同期で作業し、完了すると pull request を開きます。 - -> [!NOTE] -> `/delegate` には cloud agent が必要です。これは Copilot Student、Pro、Pro+、Business、Enterprise で利用でき、Copilot Free では利用できません。アクセスできない場合は、このセクションを読んでからハンズオン手順はスキップしてください。 - -1. ワークショップ全体のコンテキストがまとめて委任されないよう、まず現在のセッションをクリアします。 - - ``` - /clear - ``` - -2. 小さく、スコープが明確な prompt を送信します。たとえば、バックログにある stretch goal のページネーションを委任できます。 - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. 次の slash command を送信して、セッションを cloud agent に引き渡します。続いて、委任したい prompt を確認します。 - - ``` - /delegate - ``` - -4. ブラウザーで [Copilot agents](https://github.com/copilot/agents) を開き、進捗を確認します。 -5. この harness では、pull request が完了するまで待つ必要はありません。後で戻って確認できます。非同期 agent 作業の管理をより深く知りたい場合は、[Cloud agent ハーネス][cloud-harness-link] に進んでください。 - -## まとめと次のステップ - -Copilot CLI の slash command を使うと、設定の変更、セッションの共有、Copilot の内部状態に関する情報の取得ができます。このレッスンでは、次の機能を使ったり確認したりしました。 - -- `/share` で GitHub gist を作成し、チームとセッションを共有する。 -- `/context` で、Copilot CLI が現在使用しているコンテキストを確認する。 -- `/model` で利用可能なモデルの一覧を確認し、必要に応じて別のモデルを選択する。 -- `/delegate` が cloud agent への任意の橋渡しになることを学ぶ。 - -利用できる slash command はもちろんこれ以外にもあり、Copilot CLI にはまだ多くの機能があります。最後に、[ここまでに学んだことを振り返り][next-lesson]、学習を続けるための次のステップを確認して締めくくりましょう。 - -## リソース - -- [Copilot CLI を使う][using-copilot-cli] -- [Copilot CLI について][about-copilot-cli] -- [Copilot CLI のコンテキスト管理][context-management] -- [Copilot CLI でセッションを共有する][share-sessions] -- [Copilot CLI でモデルを選択する][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm - -[cloud-harness-link]: ../../cloud/ diff --git a/docs/ja-jp/cli/8-create-pull-request.md b/docs/ja-jp/cli/8-create-pull-request.md new file mode 100644 index 00000000..04e95d0e --- /dev/null +++ b/docs/ja-jp/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "演習 8 - 機能の PR を作成してマージする" +description: "フィルター機能のマイルストーン全体をレビューし、現在の QA の証拠を再利用して、CI とレビュー後に3つ目の pull request をマージします。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +フィルター機能のマイルストーンを PR 3 にまとめます。演習4～7で使ったブランチとチェックアウトを維持してください。フィルター機能の実装、quality-checks スキルとスクリプト、QA プロファイル、関連テストが含まれています。 + +この演習では、次のことを行います。 + +- マイルストーン全体の差分と現在の QA の証拠をレビューします。 +- 機能の PR を1つ依頼し、チェックとレビューのフィードバックを確認します。 +- レビュー済みの PR を明示的にマージし、ローカルの `main` を更新します。 + +## シナリオ + +フィルター機能の作業は複数のチェックポイントに分かれていますが、レビュアーは1つの完成した機能として評価する必要があります。Tailspin Toys は、要件、実装、再利用可能なチェック、QA の指摘を結び付けた PR を求めています。レビューへの引き継ぎを準備し、マージ前に阻害要因を解消します。 + +これは、リポジトリの規約に従う通常の範囲限定の PR リクエストです。コントリビューション用スキルは必要ありません。 + +> [!NOTE] +> 実際のチームでは、機能と再利用可能な品質管理の基盤を分ける場合があります。このワークショップでは、1つの機能 PR で一連の流れを示すため、意図的にまとめています。以前の星評価と指示の PR はすでに `main` にマージされているはずです。無関係な作業として再び含めてはいけません。 + +## 準備状況と証拠を確認する + +1. QA の判定と、要件に対応する証拠を確認します。**NO-GO**、ブラウザーの証拠の不足、必要なチェックのスキップは、マージ前に解消すべき阻害要因です。 +2. lint、単体テスト、E2E、型チェックの4つが、実際に quality-checks スキルを通じて実行されたことを確認します。 +3. テストしたリビジョンと、チェック後の変更を確認します。テスト対象のコード、テスト、検証スクリプトが変わっていない場合にのみ、現在の QA の証拠を再利用してください。ファイル内容が同じなら、チェックポイントコミットだけでは証拠は無効になりませんが、コードの変更では無効になります。 +4. 実装やテストの入力が変わった場合は、該当するスキルのチェックとブラウザー観察を再実行し、証拠を更新します。現在の QA 結果がまだ適用できるなら、PR を作成するという理由だけでスイート全体を再実行してはいけません。 +5. 最新のチェックポイントや未コミットの変更だけでなく、ブランチの差分全体を確認します。 + +同じチェックアウトの別のターミナルで、次を実行します。 + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +3点の diff は、`origin/main` との共通祖先以降のこのブランチの変更を、以前のチェックポイントも含めて表示します。意図したフィルター機能のマイルストーンだけが含まれることを確認してください。新しいファイルも確認し、予期しない未追跡または未コミットのファイルは、ステージングする前にレビューします。 + +## PR 3 を依頼する + +演習7では、チェックポイントの前に通常の **Interactive** セッションに戻りました。QA プロファイルがすでに無効で、フィルター機能のチェックアウトとブランチが変わっていなければ、そのセッションを続けます。Issue の URL、計画時に承認した追加の取り決め、テストしたリビジョンとチェック結果を含む現在の QA レポートを利用できる状態にします。 + +QA プロファイルは、QA 中のコミットと PR 操作を禁止しています。まだ有効な場合は、PR を依頼する前に通常のセッションに戻ります。 + +1. QA が待機状態になるまで待ち、CLI のプロンプトで `/exit` を入力します。別のセッションが有効なため CLI が開いたままの場合は、その作業を完了するか保存します。その後、通常のプロンプトに戻り、Ctrl+D を押してこの CLI インスタンスを終了します。 +2. シェルのプロンプトでは、同じフィルター機能のチェックアウトとブランチを維持します。両方を確認してから、`--agent qa` や再開フラグを付けずに新しい通常のセッションを開始します。 + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. **Interactive** モードで、QA プロファイルが無効になっていることを確認します。別のワークツリーの作成、ブランチの変更、QA セッションの再開はしないでください。 + +以下のすべてのプレースホルダーを、実際の Issue の URL、承認した追加の取り決め、現在の QA の証拠に置き換えます。演習7の通常セッションを続けている場合でも、これらを明示的に渡してください。新しい会話で QA セッションの記憶に依存してはいけません。 + +```plaintext +次の Issue のフィルター機能 PR を準備してください: 。計画時に承認した追加の受け入れ条件は次のとおりです: <合意した追加の取り決めを貼り付けるか、なければ none と記入>。現在の QA の証拠は次のとおりです: <テストしたリビジョン、ブラウザー観察、カバレッジの評価、4つすべてのチェック結果、制限事項を含む QA レポートを貼り付ける>。 + +チェックアウトと現在のフィルター機能のブランチを確認してください。main に対する差分全体、マイルストーンのすべてのチェックポイントコミット、git status、リポジトリの PR テンプレート、提供した QA の証拠を確認してください。レビュー済みのフィルター機能の実装、quality-checks スキルと同梱スクリプト、QA エージェント定義、関連テストだけを含めてください。 + +最終的なファイル内容をまだ表している間は、QA 結果を再利用してください。その後にコード、テスト、検証スクリプトが変更された場合は報告し、現在の結果として提示する前に、該当するチェックをスキル経由で実行し、影響するブラウザー検証を行ってください。失敗、阻害、スキップされたチェックを成功扱いにしないでください。 + +必要に応じて、レビュー済みのマイルストーンの残りの変更をコミットし、この現在のブランチをプッシュして、リポジトリの規約に従い main を対象とする PR を1つ作成してください。Issue と承認済みの条件、実装の概要、追加したテストまたは追加不要だった理由、ブラウザー観察、4つすべてのチェック結果、残る制限事項を含めてください。マージ、別のブランチの作成、コントリビューション用スキルの呼び出し、別の機能の開始はしないでください。 +``` + +## PR と CI をレビューする + +返された URL を開き、PR 全体の **Files changed** を確認します。スキルのスクリプトと QA プロファイルが含まれ、認証情報、ローカルの MCP 設定、無関係なファイル、生成されたレポート、依存関係のインストールによる変更が差分に紛れ込んでいないことを確認します。 + +PR の **Checks** タブを使うか、機能ブランチのターミナルで次を実行します。 + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +緑色のバッジがあらゆる検証を網羅していると判断せず、リポジトリの `.github/workflows/` を確認します。現在の Tailspin の **Run tests** ワークフローは、ビルドした静的サイトに対して lint、型チェック、Vitest の単体テスト、Playwright の E2E テストを実行します。QA レポートに含まれる MCP の直接的なブラウザー観察を置き換えるものではありません。ワークショップサイトの Astro ビルドとリンクチェックは、別のリポジトリを検証しています。 + +チェックが失敗したら、ログを確認して原因に対処します。範囲を絞った修正は、プッシュ前に更新後のリビジョンでレビューして再検証する必要があります。`main` が変更され、競合の解決によって機能が変わった場合も、影響する証拠を更新してください。必要な人間のレビューを待ちます。エージェント自身の承認がブランチ保護に優先することはありません。 + +## マージしてローカルの main を更新する + +PR がすべてのレビューとチェックの要件を満たしたら、GitHub で **Merge pull request** を明示的に選択し、マージを確定します。PR 3 が **Merged** であることを確認します。 + +`/exit` で CLI セッションを終了します。作業ツリーに未コミットの変更がない状態で、ローカルのチェックアウトを更新します。 + +```bash +git status +git switch main +git pull --ff-only +``` + +## まとめと次のステップ + +次の演習に新しいブランチは必要ありません。これで、星評価、指示と実証、フィルター機能と品質チェックスキル・QA プロファイル・テストという、ちょうど3つのワークショップ PR をマージしました。 + +[演習 9 - スラッシュコマンドと CLI オプションを確認する][next-lesson]に進みます。別の実装タスクではなく、範囲を限定して CLI の操作方法を確認します。 + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/ja-jp/cli/8-review.md b/docs/ja-jp/cli/8-review.md deleted file mode 100644 index 71baaadf..00000000 --- a/docs/ja-jp/cli/8-review.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: "演習 8 - 振り返りと次のステップ" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -ここ数回の演習で、GitHub Copilot CLI の最も一般的なユース ケースのいくつかを確認しました。具体的には次の内容です。 - -- GitHub やほかの MCP server と連携する。 -- instruction file を使ってコード生成を導く。 -- skill を実装して、Copilot CLI のツールボックスに tool を追加する。 -- custom agent を呼び出して、より高度で複雑なタスクに対応する。 -- slash command を使ってセッションを管理し、必要に応じて `/delegate` で cloud agent に橋渡しする。 - -ここでは、いくつかの slash command、ベスト プラクティス、次のステップについて確認します。 - -## slash command - -Copilot CLI には、多数の slash command が用意されています。設定を変更したり、内部で起きていることを確認したりできるコマンドも含まれます。すでに、現在のコンテキストをクリアして新しい chat を始める `/clear` と、MCP server を確認 / 管理する `/mcp` を使いました。役立つ追加コマンドとしては次のようなものがあります。 - -| Command | 説明 | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | Copilot の trusted list にディレクトリを追加する | -| `/clear`, `/new` | 会話履歴をクリアして新しく始める | -| `/compact` | 会話履歴を要約し、context window の使用量を減らす | -| `/context` | context window の token 使用量と可視化を表示する | -| `/diff` | 現在のディレクトリで行われた変更をレビューする | -| `/model` | 使用する AI model を選択する（Claude Sonnet、GPT-5 など） | -| `/plan ` | コーディング前に実装計画を作成する | -| `/review ` | code review agent を実行して変更を分析する | -| `/delegate` | タスクを Copilot cloud agent に委任して非同期で処理する | -| `/session` | セッション情報と workspace の概要を表示する | -| `/share` | セッションを markdown ファイルまたは GitHub gist に共有する | -| `/skills` | capability を拡張する skill を管理する | -| `/usage` | セッションの使用状況メトリクスと統計を表示する | - -> [!TIP] -> `/help` を使うと、利用可能な command とキーボード shortcut の完全な一覧を表示できます。 - -## ベスト プラクティス - -AI ツールを使うときは、基盤となる仕組みが出力品質を左右します。しっかりした instruction file、custom agent、agent skill のいずれも重要な役割を果たします。このワークショップでは、それらをそれぞれ確認しました。[awesome-copilot][awesome-copilot] はテンプレートのよい情報源であり、Copilot 自身にこれらのひな形を作らせて出発点にすることもできます。 - -基盤と同じくらい、コンテキストも重要です。何を作りたいのか、なぜ必要なのか、どのように進めたいのかを明確に伝えることで、出力は大きく変わります。Copilot の助けになる情報があるなら、できるだけ渡してください。 - -## 次のステップ - -どのツールでも、スキルを高める最善の方法は使い続けることです。本番コード、趣味のコード、何年も頭の中にあったけれどまだ形にしていない小さなアプリなど、さまざまな場面で活用してください。学びをチームと共有し、チームからも学んでください。そして、いつものようにドキュメントを確認しましょう。 - -GitHub Copilot エコシステムをさらに試してみたい場合は、[VS Code ハーネス][vscode-harness-link] または [Cloud agent ハーネス][cloud-harness-link] を確認してください。 - -## リソース - -- [Copilot CLI について][about-copilot-cli] -- [Copilot CLI を使う][using-copilot-cli] -- [Awesome Copilot リポジトリ][awesome-copilot] -- [Custom instructions ガイド][repo-instructions] -- [Agent Skills ドキュメント][agent-skills] -- [カスタム エージェント ドキュメント][custom-agents] -- [MCP 仕様][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ - -[vscode-harness-link]: ../../vscode/ -[cloud-harness-link]: ../../cloud/ diff --git a/docs/ja-jp/cli/9-slash-commands.md b/docs/ja-jp/cli/9-slash-commands.md new file mode 100644 index 00000000..9364a9e4 --- /dev/null +++ b/docs/ja-jp/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "演習 9 - スラッシュコマンドと CLI オプションを確認する" +description: "別の機能を開始せず、コンテキスト、モデルとセッションの操作、共有先、CLI フラグを確認します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +3つの PR マイルストーンを完了しました。次は、セッションを理解して管理するための CLI の操作方法を確認します。この演習では、別の機能の実装、作業の委任、別の PR の作成は行いません。 + +この演習では、次のことを行います。 + +- コンテキスト、使用量、モデル、モードの操作方法を確認します。 +- コマンドラインオプションを、インストール済みのバージョンのヘルプと比較します。 +- セッションをローカルにエクスポートし、何かを共有する前に内容を確認します。 + +## シナリオ + +機能のリリースが完了したので、日々の作業で使う CLI の操作方法を理解します。別のタスクを開始せずにセッションと共有方法を確認し、コンテキストの管理や会話のエクスポートで、意図せず作業を承認したりプロジェクト情報を開示したりしないようにします。 + +更新済みの学習用チェックアウトから、**Interactive** モードで `copilot` を起動します。`/help` と[コマンドリファレンス][cli-reference]で、インストール済みのバージョンがサポートするコマンドを確認します。現在のドキュメントには、使用中のバージョンより新しい操作が記載されている場合があります。 + +## コンテキストとセッション情報を確認する + +1. 範囲を限定した読み取り専用のリクエストを送信します。 + + ```plaintext + リポジトリの指示ファイル、quality-checks スキル、QA プロファイルを要約してください。フィルター機能の検証にどのように役立つか説明してください。ファイルの変更、チェックの実行、作業の委任、コミット、PR の作成はしないでください。 + ``` + +2. `/context` を入力してコンテキストウィンドウの使用状況を確認します。メッセージ、指示、ツール定義がコンテキストをどのように消費するか確認してください。 +3. `/compact` を入力し、もう一度 `/context` を入力します。圧縮は履歴を要約してサイズを減らします。短いセッションでは変化が小さい場合があります。 +4. `/session` で現在のセッションを、`/usage` で使用量の情報を確認します。 + +圧縮は要件を渡すことの代わりにはなりません。タスクやエージェントを変更するときは、Issue の URL、承認済みの条件、チェックアウトの識別情報、関連する証拠を明示的に引き継ぎます。 + +`/clear` は新しい会話を開始しますが、ファイルを元に戻したり Git ブランチを切り替えたりはしません。`/resume` は、以前の作業に戻るためのセッション選択画面を開きます。選択画面を確認したら、Esc を押し、別のタスクを再開せずに閉じてください。受け入れ条件の唯一のコピーを消したり、会話を再開したから古い検証が今も有効だと判断したりしてはいけません。 + +## モデルとモードを確認する + +`/model` を入力し、提供されている場合の **Auto** も含め、アカウントで使えるモデルを確認します。選択の詳細と使用量の情報を読んでください。モデルの提供状況と料金は変わる場合があります。Esc を押し、モデルを変更せずに選択画面を閉じます。変更した場合は、表示された選択内容と、使用中の CLI バージョンでの適用範囲を確認してください。 + +Shift+Tab で **Interactive**、**Plan**、**Autopilot** を順に切り替えながらモード表示を確認し、実装プロンプトを送らずに **Interactive** に戻します。次の違いを思い出してください。 + +- Plan は、コーディング前に作業内容に合意するためのモードです。 +- Autopilot は、承認された範囲限定のタスクを継続します。 +- Interactive は、意識的にレビューして判断する機会を提供します。 +- 権限は、許可するツール操作を別途制御します。 + +## コマンドラインオプションを確認する + +別のターミナルで次を実行します。 + +```bash +copilot --help +``` + +以下のドキュメント上のオプションを、インストール済みバージョンのヘルプと比較します。 + +| オプション | 目的 | +| --- | --- | +| `--model MODEL` | 起動時のモデルを選択する。先に利用可能か確認する | +| `--agent AGENT` | 起動時のカスタムエージェントを選択する | +| `-p PROMPT` | プロンプトをプログラムから実行し、完了時に終了する | +| `--output-format json` | 1行に1つの JSON オブジェクトを含む、構造化された JSONL を出力する | +| `--resume` | 既存のセッションを再開する | +| `--enable-all-github-mcp-tools` | 組み込みの GitHub MCP ツールをすべて公開する | + +これらは理解するための操作項目であり、別のタスクを開始するためのものではありません。プログラムから実行するモードでも実際のツール操作が行われます。出力形式を JSON にしてもリクエストは読み取り専用にはなりません。エージェントの選択には[演習7][qa-lesson]で検証した手順を使います。カスタムエージェントの有効化を、既定のエージェントにプロファイルを読むよう依頼する方法に置き換えてはいけません。権限とアクセスの制限は引き続き適用されます。 + +## 共有前に確認する + +`/share` はセッションの内容をさまざまな共有先に送れます。[CLI コマンドリファレンス][cli-reference]には、Markdown エクスポート用の `/share file [session|research] [PATH]` と、gist 公開用の `/share gist [session|research]` が記載されています。サブコマンドがない場合、現在のドキュメントでは、ログインして同期済みなら共有可能な GitHub リンクを作成し、そうでなければ Markdown エクスポートに切り替えるとされています。内容のプレビューだけだと思って、サブコマンドなしで実行してはいけません。 + +このワークショップでは、公開するのではなく、ローカルのセッションエクスポートとファイル名を明示的に指定します。 + +```text +/share file session cli-session-review.md +``` + +エクスポートしたファイルをエディターで開き、実際の内容を確認します。プロンプト、回答、ツール出力、ファイルパス、リポジトリのデータ、認証情報や個人情報を確認してください。すべての内部手順が含まれている、あるいは機密情報が自動的に削除されていると判断してはいけません。 + +> [!CAUTION] +> Gist や共有リンクは外部への情報開示です。シークレット gist は非公開のアクセス制御ではなく、URL を知る人は誰でも閲覧できます。共有前に、共有先、受信者、権限、組織のポリシーを確認してください。情報を削除する必要がある場合は、確認して機密部分を除いた資料だけを承認済みの経路で共有します。その後に元のセッションを公開してはいけません。 + +このエクスポートを機能の PR やリポジトリの履歴に含めないでください。確認後、自分で生成したファイルを削除するか、承認済みのローカルのメモ保存先に移動します。無関係なファイルを削除してはいけません。 + +Cloud への委任では、リモートの作業と追加の PR が作成される場合があるため、ここで `/delegate` を実行してはいけません。この別の流れは [Cloud エージェントワークショップ][cloud-workshop]で扱います。 + +## まとめと次のステップ + +別の機能を開始せずに、コンテキスト、使用量、モデルとモードの操作、コマンドラインオプション、共有先を確認しました。[演習 10 - 振り返りと次のステップ][next-lesson]で、構築したワークフローと資産を振り返ります。 + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ja-jp/cli/README.md b/docs/ja-jp/cli/README.md index 2ab725f8..15681879 100644 --- a/docs/ja-jp/cli/README.md +++ b/docs/ja-jp/cli/README.md @@ -3,12 +3,12 @@ slug: ja-jp/cli title: "GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- **[GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)** は、ターミナルで GitHub Copilot をエージェント型のコーディング アシスタントとして利用できるようにします。コードベースを探索し、コードを生成し、コマンドを実行し、外部ツールに接続できます。すべてコマンド ラインから行えるため、グラフィカル エディターに切り替えずに作業の流れを保てます。 -これらの演習では、Copilot CLI のインストールと認証から始め、カスタム命令でプロジェクトのコンテキストを与えたうえで、プラン モードを使って意図的に機能を実装します。続いて Playwright MCP サーバーを接続し、実際のブラウザーでその機能をテストします。その後、再利用可能な agent skill と custom agent で Copilot を拡張します。最後に、コンテキスト管理、モデル選択、共有に使う slash command を確認し、作成した内容を振り返ります。 +演習0～1のセットアップ後、演習2～10の9つのコアモジュールに取り組みます。星評価を追加する小さな変更から始め、ドキュメントの指示を整備し、**Plan** と **Autopilot** モードでフィルター機能を構築します。続いて再利用可能な quality-checks スキルを作成し、Playwright MCP で動作を検証し、QA エージェントを作成して機能をリリースします。最後に CLI の操作方法を確認し、作成した内容を振り返ります。 ## 演習 @@ -16,13 +16,21 @@ lastUpdated: 2026-06-30 |----------|-------|-------------| | [0. 前提条件][ex0] | セットアップ | リポジトリと codespace を作成する | | [1. Copilot CLI のインストール][ex1] | インストール | Copilot CLI をインストールして認証する | -| [2. カスタム命令][ex2] | コンテキスト | 命令を追加し、Copilot CLI がどのように従うかを確認する | -| [3. コード生成][ex3] | コード生成 | プラン モードを使って機能を生成する | -| [4. Playwright MCP によるテスト][ex4] | 外部ツール | Playwright MCP サーバーを追加し、ブラウザーで機能をテストする | -| [5. エージェント スキル][ex5] | スキル | 専門スキルで Copilot を強化する | -| [6. カスタム エージェント][ex6] | エージェント | カスタム エージェントを確認して使用する | -| [7. スラッシュ コマンド][ex7] | CLI 機能 | コンテキスト、モデル、共有、cloud agent への任意の委任を確認する | -| [8. 振り返り][ex8] | まとめ | 重要な概念と次のステップを確認する | +| [2. 星評価を追加して小さな成果を得る][ex2] | 最初の変更 | 既存の評価を表示し、検証して PR 1 をマージする | +| [3. カスタム指示で Copilot を導く][ex3] | コンテキスト | ドキュメント規約を追加して実証し、PR 2 をマージする | +| [4. Plan と Autopilot でフィルター機能を構築する][ex4] | 実装 | 計画をレビューし、Autopilot を承認してテストし、チェックポイントを保存する | +| [5. quality-checks スキルを作成して使用する][ex5] | スキル | シェルスクリプトを同梱したチェックを生成、確認、実行する | +| [6. Playwright MCP で機能を検証する][ex6] | ブラウザーツール | 実際のブラウザーでフィルターの動作を観察する | +| [7. QA エージェントを作成して使用する][ex7] | エージェント | 要件とカバレッジを評価し、最終的な証拠を集める | +| [8. 機能の PR を作成してマージする][ex8] | リリース | フィルター機能と再利用可能なカスタマイズを PR 3 でまとめてレビューする | +| [9. スラッシュコマンドと CLI オプションを確認する][ex9] | CLI の操作 | コンテキスト、モデル、セッション、共有先を確認する | +| [10. 振り返りと次のステップ][ex10] | まとめ | 共通の資産と3つの PR マイルストーンを振り返る | + +## ブランチと pull request + +3つの pull request をマージします。星評価、指示と小さな実証、そしてフィルター機能と quality-checks スキル・QA プロファイル・関連テストです。最初の2つの PR は、それぞれマージしてから更新済みの `main` で次のマイルストーンを始めます。 + +演習4～8では1つの機能ブランチとチェックアウトを共有します。途中でチェックポイントコミットを保存してください。スキルの作成、MCP の設定、QA の選択で新しい機能ブランチは作成しません。演習9では別の機能や PR を開始せず、操作方法を確認します。 ## 前提条件 @@ -46,10 +54,12 @@ lastUpdated: 2026-06-30 [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ diff --git a/docs/ko-kr/README.md b/docs/ko-kr/README.md index b0e2abac..6ecf9836 100644 --- a/docs/ko-kr/README.md +++ b/docs/ko-kr/README.md @@ -3,7 +3,7 @@ slug: ko-kr title: "GitHub Copilot 에이전트 실습" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- 최근 GitHub Copilot에 추가된 기능은 소프트웨어 개발 수명 주기(SDLC) 전반에서 개발자에게 강력한 도구를 제공합니다. 여기에는 GitHub의 이슈 및 끌어오기 요청 작업, 외부 서비스와의 상호 작용, 그리고 코드 작성이 포함됩니다. 이 랩에서는 이러한 기능을 살펴보고, 실제 사용 사례와 도구를 최대한 활용하는 방법을 소개합니다. @@ -23,7 +23,7 @@ GitHub Copilot은 어떤 작업 환경에서든 함께할 수 있습니다. 원 ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI**는 터미널에서 실행되는 에이전트형 도우미입니다. 이를 설치하고, MCP 서버를 연결하고, 계획 모드로 코드를 생성하고, 명령줄에서 직접 스킬, 사용자 지정 에이전트, 슬래시 명령을 만듭니다. +**GitHub Copilot CLI**는 터미널에서 실행되는 에이전트형 도우미입니다. 설정 후 아홉 개의 핵심 모듈을 진행합니다. 별점을 추가하는 작은 변경을 제공하고, 지침을 정립하고, 필터링을 계획하고 구축한 다음, quality-checks 스킬을 만들고, Playwright MCP로 검증하고, QA 에이전트를 만들어 기능을 병합합니다. 마지막으로 CLI 조작 방법과 마무리를 다룹니다. 이 과정에는 세 번의 끌어오기 요청 마일스톤이 있습니다. ### 🤖 [Copilot 앱](app/) diff --git a/docs/ko-kr/cli/0-prerequisites.md b/docs/ko-kr/cli/0-prerequisites.md index 555bd1cd..b30a898e 100644 --- a/docs/ko-kr/cli/0-prerequisites.md +++ b/docs/ko-kr/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "연습 0: 사전 준비" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Copilot CLI 연습을 시작하기 전에 모든 것을 준비해야 합니다. Tailspin Toys 리포지토리(Repository)의 복사본을 만들고 [코드스페이스][codespaces]를 시작합니다. 다음 연습에서는 해당 코드스페이스의 통합 터미널을 사용해 Copilot CLI를 설치하고 실행합니다. +이 연습에서는 다음을 수행합니다. + +- Tailspin Toys 템플릿에서 자신의 리포지토리를 만듭니다. +- 코드스페이스를 열고 CLI 설정을 위한 작업 공간이 준비되었는지 확인합니다. + ## 실습용 리포지토리 설정 앞으로 작성할 코드를 위한 리포지토리 복사본을 만들기 위해 [template][template-repository]에서 새 인스턴스(Instance)를 만듭니다. 새 인스턴스에는 실습에 필요한 파일이 모두 포함되며, 연습을 진행하는 동안 이 리포지토리를 사용합니다. +템플릿의 새 복사본을 사용합니다. 리포지토리 지침, 애플리케이션 코드, 테스트, CI는 포함되지만 사용자 지정 에이전트나 스킬은 제공되지 않습니다. 이러한 자산은 직접 만듭니다. 이전 복사본으로 돌아온 경우 기존 사용자 지정을 살펴본 후 변경하며, 자신의 작업을 덮어쓰지 않습니다. + 1. 새 브라우저 창에서 이 실습의 GitHub 리포지토리로 이동합니다: `https://github.com/github-samples/tailspin-toys`. 2. 실습용 리포지토리 페이지에서 **Use this template** 버튼을 선택해 리포지토리 복사본을 만듭니다. 그런 다음 **Create a new repository**를 선택합니다. @@ -27,6 +34,8 @@ Copilot CLI 연습을 시작하기 전에 모든 것을 준비해야 합니다. > > template에서 리포지토리를 만들면 GitHub issue 백로그가 자동으로 생성됩니다. 워크숍 내내 이 issue를 바탕으로 작업하므로 직접 등록할 내용은 없습니다. +이슈 초기 생성 워크플로가 완료될 때까지 기다린 다음 **Issues** 탭에서 **Allow users to filter games by category and publisher**와 **Update our repository coding standards**를 확인합니다. 연습에서는 추정한 이슈 번호가 아니라 실제 제목과 URL을 사용합니다. 백로그가 없다면 워크플로 결과를 확인한 후 진행합니다. + ## 코드스페이스 만들기 이제 코드스페이스를 사용해 실습을 진행합니다. @@ -50,8 +59,8 @@ Copilot CLI 연습을 시작하기 전에 모든 것을 준비해야 합니다. > [!NOTE] > 이 워크숍은 코드스페이스 또는 로컬 [dev container][dev-containers] 안에서 실행하도록 설계되었습니다. 두 환경 모두 원활한 진행에 필요한 사전 요구 사항이 모두 설치된 상태를 보장합니다. 로컬에서 실행하고 싶다면 복제한 리포지토리를 VS Code에서 열고, 메시지가 표시되면 **Reopen in Container**를 선택합니다. 그러면 코드스페이스에서 사용하는 것과 동일한 dev container를 VS Code가 빌드합니다. -[codespaces]: https://github.com/features/codespaces -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers +코드스페이스가 준비되면 [연습 1][next-lesson]에서 터미널을 열고 Copilot CLI 설치 전에 리포지토리, 런타임, 인증을 확인합니다. + ## 요약 축하합니다! 실습용 리포지토리 복사본을 만들었습니다. 또한 Copilot CLI 작업을 시작할 때 사용할 코드스페이스 생성도 시작했습니다. @@ -69,3 +78,5 @@ Copilot CLI를 설치하고 GitHub 계정으로 인증해 보겠습니다. [연 [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [codespaces-quickstart]: https://docs.github.com/codespaces/getting-started/quickstart [next-lesson]: ../1-install-copilot-cli/ +[codespaces]: https://github.com/features/codespaces +[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers diff --git a/docs/ko-kr/cli/1-install-copilot-cli.md b/docs/ko-kr/cli/1-install-copilot-cli.md index 97f81415..c03f677d 100644 --- a/docs/ko-kr/cli/1-install-copilot-cli.md +++ b/docs/ko-kr/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "연습 1 - GitHub Copilot CLI 설치" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [GitHub Copilot CLI][about-copilot-cli]는 터미널에서 실행되는 강력한 에이전트형 코딩 도우미입니다. 코드베이스를 탐색하고, 코드를 생성하고, 명령을 실행하고, 외부 도구와 상호 작용하는 작업을 모두 명령줄에서 수행할 수 있습니다. 작업을 위임하고, 변경을 요청하고, 흐름을 유지할 수 있습니다. 예상할 수 있듯 첫 단계는 도구를 설치하는 일입니다. 다행히 이미 익숙한 도구로 설치할 수 있습니다. @@ -21,10 +21,25 @@ lastUpdated: 2026-06-30 Copilot CLI를 설치하기 전에 코드스페이스에서 터미널 창을 열어야 합니다. -1. 아직 열지 않았다면 코드스페이스로 돌아갑니다. +1. 코드스페이스로 돌아가 설정이 완료될 때까지 기다립니다. 2. Ctrl+`를 눌러 터미널 창을 엽니다. 3. VS Code 창 하단에 터미널 패널이 나타나는지 확인합니다. +## 학습 환경 확인 + +코드스페이스 터미널에서 워크숍 콘텐츠 리포지토리가 아니라 자신의 Tailspin Toys 리포지토리에 있는지 확인합니다. `README.md`와 `package.json`에서 설정 및 검사 명령을 읽습니다. 현재 Tailspin Toys에는 Node.js 22.13 이상, 프로젝트 의존성, E2E 테스트용 Playwright Chromium이 필요합니다. + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +GitHub CLI(`gh`)는 PR과 CI를 확인하는 데 유용합니다. 인증되지 않았다면 `gh auth login`을 실행하고 브라우저 안내를 따릅니다. 계정이 이 리포지토리에 브랜치를 푸시하고 PR을 생성하고 병합할 수 있는지 확인합니다. 조직 정책에 따라 다른 검토자가 필요할 수 있습니다. 코드 변경을 시작하기 전에 리포지토리 설정 안내에 따라 누락된 필수 조건을 해결하고, 설치 내용을 검토한 후 승인합니다. + +CLI는 시작한 체크아웃에서 실행됩니다. 대화를 시작해도 격리된 워크트리(Worktree)가 자동으로 생성되지는 않습니다. 이 워크숍에서는 PR 마일스톤마다 하나의 브랜치를 사용합니다. 먼저 별점과 지침 실증을 병합한 후 연습 4~8에서 동일한 필터링 브랜치를 유지합니다. + ## Copilot CLI 설치 Copilot CLI는 [npm][install-npm], [WinGet][install-winget], [Homebrew][install-homebrew]로 설치할 수 있습니다. GitHub Codespaces에는 Node.js가 이미 설치되어 있으므로 npm을 사용해 Copilot CLI를 설치합니다. @@ -35,7 +50,7 @@ Copilot CLI는 [npm][install-npm], [WinGet][install-winget], [Homebrew][install- node --version ``` - 버전 22 이상(예: `v22.x.x`)이 표시되어야 합니다. + CLI 자체의 요구 사항이 다르더라도 Tailspin Toys에는 버전 22.13 이상이 필요합니다. 버전이 너무 낮다면 학습용 리포지토리의 설정 안내를 따릅니다. 2. npm을 사용해 코드스페이스에 Copilot CLI를 전역 설치합니다. @@ -51,8 +66,8 @@ Copilot CLI는 [npm][install-npm], [WinGet][install-winget], [Homebrew][install- 버전 번호(예: `v1.0.XX`)가 표시되어야 합니다. -> [!TIP] -> 권한 오류가 발생하면 일부 시스템에서는 `sudo npm install -g @github/copilot`를 사용해야 할 수 있습니다. 하지만 GitHub Codespaces에서는 일반적으로 필요하지 않습니다. +> [!NOTE] +> 권한 오류로 설치가 실패하면 익숙하지 않은 명령을 관리자 권한으로 다시 실행하지 말고 npm 설정을 확인하거나 워크숍 진행자에게 도움을 요청합니다. ## GitHub로 인증하기 @@ -85,22 +100,39 @@ Copilot CLI를 처음 실행하면 GitHub 계정으로 인증하라는 메시지 2. 이 워크숍에서는 계속 이 리포지토리에서 작업하므로 **Yes, and remember this folder for future sessions**를 선택합니다. 3. 간단한 질문을 해 Copilot이 작동하는지 확인합니다. - ``` - What files are in this project? + ```plaintext + 이 프로젝트에는 어떤 파일이 있습니까? ``` 4. Copilot이 리포지토리를 탐색하고 프로젝트 구조 요약을 제공해야 합니다. 5. `/help` 명령으로 사용 가능한 slash commands를 확인합니다. - ``` + ```text /help ``` -6. 터미널에서 다음 명령을 입력해 Copilot CLI를 종료합니다. 이후 연습에서 다시 Copilot CLI로 돌아옵니다. +6. Copilot 프롬프트에서 다음 명령을 입력해 이 세션을 종료합니다. 첫 변경은 새 세션에서 시작합니다. + ```text + /exit ``` - exit - ``` + +## 모드와 권한 이해 + +Copilot CLI는 시작한 디렉터리와 Git 브랜치에서 작업합니다. 디렉터리를 신뢰하면 리포지토리 컨텍스트를 사용할 수 있지만, 모든 도구 작업을 승인하는 것과는 다릅니다. 파일 변경, 셸 명령, GitHub 작업에 대한 권한 요청을 검토합니다. + +학습용 리포지토리 루트에서 다음 명령으로 코드 연습을 시작합니다. + +```bash +copilot --enable-all-github-mcp-tools +``` + +GitHub MCP 서버는 기본 제공됩니다. 이 플래그는 이슈와 PR 작업에 필요한 전체 도구를 노출하지만, 인증과 리포지토리 권한 및 도구 승인은 계속 적용됩니다. 플래그 자체가 커밋이나 PR을 승인하지는 않습니다. + +Shift+Tab으로 일반 **Interactive**, **Plan**, **Autopilot** 모드를 순환합니다. 요청 전에 모드 표시를 확인합니다. 초기 변경에서는 Interactive를 유지하고, 필터링은 구축 전에 계획하며, 사용자 지정을 만들고 검토하기 전에는 명시적으로 Interactive로 돌아옵니다. + +> [!CAUTION] +> 모드와 권한 설정은 다릅니다. Autopilot은 자율적으로 작업을 계속하며, `--allow-all`과 별칭 `--yolo`는 모든 도구, 경로, URL 권한을 부여합니다. 이 워크숍은 매번 무제한 권한으로 세션을 시작할 것을 요구하지 않습니다. 코드스페이스에서도 액세스를 허용하기 전에 범위를 검토합니다. ## 요약 및 다음 단계 @@ -111,7 +143,7 @@ Copilot CLI를 처음 실행하면 GitHub 계정으로 인증하라는 메시지 - Copilot CLI가 작업할 디렉터리를 신뢰하도록 설정합니다. - 설치가 올바르게 작동하는지 확인합니다. -이제 Copilot CLI가 설치되었으니, Copilot에 프로젝트 컨텍스트를 제공해 보겠습니다. [연습 2 - CLI로 커스텀 지침 사용하기][next-lesson]로 계속 진행합니다. +Copilot CLI를 설치했으므로 [연습 2 - 별점 추가로 작은 성과 얻기][next-lesson]에서 검토하기 쉬운 작은 변경을 수행합니다. ## 리소스 @@ -120,7 +152,7 @@ Copilot CLI를 처음 실행하면 GitHub 계정으로 인증하라는 메시지 - [Copilot CLI 사용하기][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/ko-kr/cli/10-review.md b/docs/ko-kr/cli/10-review.md new file mode 100644 index 00000000..e7dd1e55 --- /dev/null +++ b/docs/ko-kr/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "연습 10 - 마무리 및 다음 단계" +description: "공통 개발 워크플로, 재사용 가능한 자산, 세 번의 CLI 끌어오기 요청 마일스톤을 검토합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Copilot CLI를 사용하여 작은 변경에서 재사용 가능한 검증을 갖춘 계획된 기능으로 발전했습니다. 연습 0~1의 설정으로 환경을 준비했고, 연습 2~10의 아홉 개 핵심 모듈에서 완전한 개발 워크플로를 배웠습니다. + +## 세 번의 PR 마일스톤 검토 + +| 마일스톤 | 병합한 결과 | 검토 습관 | +| --- | --- | --- | +| PR 1: 별점 | 게임 카드에 기존 `starRating` 표시, `null`이면 `No rating yet` 표시 | 변경 범위를 제한하고 두 경우 모두 검증합니다 | +| PR 2: 사용자 지정 지침 | 범위를 좁힌 문서화 규칙과 작은 실제 코드 실증 | 채팅 예시뿐 아니라 지침이 실제 코드를 개선하는지 확인합니다 | +| PR 3: 필터링과 검증 | 필터링, quality-checks 스킬, QA 프로필, 관련 테스트 | 병합 전에 모든 체크포인트, 현재 QA 근거, CI를 검토합니다 | + +처음 두 PR은 각각 병합한 후 업데이트된 `main`에서 다음 마일스톤을 시작했습니다. 연습 4~8은 하나의 브랜치와 체크아웃을 공유했습니다. 체크포인트 커밋으로 진행 상황을 보존하고 모듈마다 PR을 만들지는 않았습니다. 조작 방법 연습에서도 다른 기능이나 PR을 시작하지 않았습니다. + +## 공통 자산 검토 + +터미널 인터페이스를 통해 [Copilot App 워크숍][app-workshop]과 같은 핵심 결과를 얻었습니다. + +- **리포지토리 지침**은 프로젝트 컨텍스트와 표준을 설명하며, 경로별 지침은 관련 파일의 세부 사항을 추가합니다. +- **필터링 구현과 테스트**는 이슈와 계획 중 승인한 추가 합의 사항을 충족합니다. +- **quality-checks 스킬**은 재사용 가능한 지침과 프로젝트의 네 가지 검사를 실행하는 실제 셸 스크립트를 묶습니다. +- **Playwright MCP 설정**은 직접 관찰을 위한 브라우저 도구를 제공합니다. 이 CLI 흐름에서는 기능 PR이 아니라 사용자 설정에 저장됩니다. +- **QA 사용자 지정 에이전트**는 요구 사항에서 시작하여 커버리지를 확인하고, 스킬과 브라우저 도구를 사용하며, 사실에 맞는 결과를 보고하는 재사용 가능한 역할을 정의합니다. +- **PR과 검증 근거**는 검토한 변경을 테스트 결과, 브라우저 관찰, 한계, CI와 연결합니다. + +스킬은 단순한 명령 목록이 아니며, 프로필도 단순한 파일명이 아닙니다. 생성된 자산을 검토하고 실제 실행을 확인했으며, 사용자 지정 에이전트를 선택한 후 그 보고서를 활용했습니다. + +## 검증 목적 구분 + +계획으로 구현 전에 요구 사항을 명확히 했습니다. Autopilot은 범위가 제한된 계획을 수행했고, Interactive로 돌아와 사용자 지정 작성 전에 의식적인 검토 시점을 되찾았습니다. + +구현 단계에서는 스킬이 생기기 전부터 기존 npm 검사를 사용했습니다. 스킬 연습에서는 함께 제공되는 스크립트와 인수 전달이 작동함을 확인했습니다. MCP는 전체 스위트 반복 대신 직접적인 브라우저 상호 작용을 보여 주었습니다. QA는 기준, 커버리지, 브라우저 근거, 스킬로 실행하는 네 가지 검사를 통합했습니다. PR에서는 여전히 유효한 QA 결과를 재사용했고 CI는 제출된 리비전을 검사했습니다. + +실패와 차단 요인도 유용한 결과입니다. 브라우저 도구 누락, 건너뛴 테스트, 오래된 서버, 해결되지 않은 요구 사항은 **NO-GO**를 의미하며 기준을 낮춰도 된다는 뜻이 아닙니다. 실제 공백이 있을 때 테스트를 추가합니다. 기존 커버리지가 충분하다면 테스트를 추가하지 않는 것이 올바른 판단입니다. + +## 앞으로도 유지할 습관 + +- Copilot에 이슈, 변경 이유, 명확한 경계를 제공합니다. +- 자율 작업을 승인하기 전에 계획을 검토합니다. +- 생성한 지침, 스킬, 프로필을 실행 전에 확인합니다. +- 결과가 어떤 체크아웃, 브랜치, 서버, 리비전을 설명하는지 파악합니다. +- 정당한 최소 수정만 적용하고 변경 후 근거를 갱신합니다. +- 설치, 파괴적 작업, 공유, PR 병합은 명시적으로 승인합니다. + +## 학습 계속하기 + +[Copilot App 워크숍][app-workshop]은 그래픽 인터페이스로 공통 결과에 도달하고 캔버스 마일스톤을 추가합니다. [VS Code 워크숍][vscode-workshop]과 [Cloud 에이전트 워크숍][cloud-workshop]에서는 에이전트와 작업하는 다른 방법을 살펴봅니다. + +[Awesome Copilot][awesome-copilot]에서 지침, 스킬, 사용자 지정 에이전트 예제를 찾습니다. [연습 5의 스킬 예제][skill-examples]에는 기여 워크플로, 요구 사항 문서, 다이어그램, 브라우저 테스트가 있습니다. 커뮤니티 콘텐츠를 채택하기 전에 필수 조건과 동작을 검토합니다. + +일상적인 참조에는 [CLI 명령 참조][cli-reference], [에이전트 스킬 문서][agent-skills], [사용자 지정 에이전트 문서][custom-agents]를 활용합니다. 범위가 제한된 작업으로 계속 실험하고 검토한 자료만 승인된 경로로 공유합니다. + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#더-많은-스킬-예제 +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/ko-kr/cli/2-add-star-rating.md b/docs/ko-kr/cli/2-add-star-rating.md new file mode 100644 index 00000000..32661de6 --- /dev/null +++ b/docs/ko-kr/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "연습 2 - 별점 추가로 작은 성과 얻기" +description: "기존 게임 별점을 표시하고 변경을 검토·검증한 후 첫 번째 끌어오기 요청을 병합합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +이해하고 검증할 수 있는 작은 변경부터 시작합니다. Tailspin Toys는 이미 각 게임의 `starRating`을 저장하고 상세 페이지에 표시합니다. 게임 카드에도 이 기존 값을 표시하고, 아직 평가되지 않은 게임에는 명확한 메시지를 보여 줍니다. + +이 연습에서는 다음을 수행합니다. + +- Interactive CLI 세션에서 범위를 좁힌 변경을 요청합니다. +- diff를 검토하고 평가된 카드와 미평가 카드를 검증합니다. +- 커밋하고 PR 1을 생성, 검토, 병합합니다. + +## 시나리오 + +방문자는 게임 상세 페이지에서 별점을 볼 수 있지만 카탈로그를 탐색하면서 비교할 수는 없습니다. Tailspin Toys는 게임 카드에 기존 별점을 표시하고 평가가 없는 상태도 명확하게 보여 주려고 합니다. 이 작은 변경으로 더 큰 기능을 다루기 전에 작업 요청, 검토, 출시를 연습합니다. + +## 첫 마일스톤 시작 + +학습용 리포지토리 루트에서 작업 트리에 미커밋 변경이 없는지 확인하고, `main`을 업데이트한 후 브랜치를 만듭니다. `git status`에 예상하지 못한 변경이 표시되면 전환 전에 해결합니다. 변경을 버리지 않습니다. + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +메시지가 표시되면 리포지토리를 신뢰합니다. **Interactive** 모드인지 확인하고 `/model`로 사용 가능한 모델을 살펴보거나 **Auto**를 선택합니다. 도구 승인 요청이 표시되면 검토합니다. + +## 변경 요청 + +다음 프롬프트를 보냅니다. + +```plaintext +게임 카드에 각 게임의 별점을 표시해 주십시오. Game 타입에는 이미 starRating 필드가 있습니다. 5점 만점의 숫자이며 아직 평가되지 않은 게임은 null입니다. src/components/GameCard.astro의 각 카드에 표시하고, starRating이 null이면 대신 "No rating yet"을 표시해 주십시오. 변경을 작게 유지하고 카드 레이아웃을 재구성하지 마십시오. + +리포지토리 지침을 살펴보고 따라 주십시오. 기존 데이터 모델을 사용하고 별점 API, 새 스키마, 관련 없는 기능을 추가하지 마십시오. 평가된 경우와 미평가 경우에 적절한 테스트를 추가하거나 업데이트해 주십시오. 아직 커밋, 푸시, 끌어오기 요청 생성을 하지 마십시오. +``` + +Copilot은 편집 전에 기존 타입과 컴포넌트를 확인해야 합니다. 최종 응답뿐 아니라 도구 작업도 읽습니다. 자신감 있는 요약이 구현의 정확성을 증명하지는 않습니다. + +## 검토 및 검증 + +1. `/diff`를 입력하고 편집기나 diff 보기에서 변경된 파일을 모두 확인합니다. +2. 카드가 기존 `starRating`을 사용하고, 5점 만점의 값을 표시하며, `null`이면 `No rating yet`을 표시하는지 확인합니다. 참·거짓 변환만으로 검사하면 숫자 0을 미평가로 잘못 처리할 수 있습니다. +3. 카드 레이아웃을 유지하고, 별 기호나 색상만이 아니라 의미 있는 텍스트 레이블로 별점을 전달하는지 확인합니다. +4. 기존 검사로 변경을 검증하도록 Copilot에 요청합니다. + + ```plaintext + package.json과 테스트 설정을 살펴본 다음, 이 카드 변경에 적합한 lint, 타입 검사, 기존 단위 또는 E2E 테스트를 실행해 주십시오. 숫자 별점과 null 대체 표시를 모두 검증하고, 누락된 커버리지나 차단된 검사도 포함하여 정확한 명령과 결과를 보고해 주십시오. 설치하거나 브랜치를 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. + ``` + +5. 명령 출력과 테스트 변경을 검토합니다. 제공 전에 실패를 해결하고, 누락된 필수 조건을 설치하기 전에 질문합니다. + +브라우저에서 카드를 관찰하려면 같은 체크아웃에서 두 번째 터미널을 열고 실행합니다. + +```bash +npm run dev +``` + +코드스페이스의 **Ports** 패널에서 전달된 포트를 엽니다. 홈 페이지에서 평가된 카드를 확인합니다. 현재 시드 데이터에 미평가 예제가 없다면 `null`을 검증하는 자동 테스트 픽스처(Fixture)를 요구합니다. 미평가 카드를 관찰했다고 주장하지 않습니다. E2E 검사 전이나 연습을 마치기 전에 개발 서버 터미널에서 Ctrl+C로 서버를 중지합니다. Playwright 자동 테스트가 다른 체크아웃의 서버를 재사용해서는 안 됩니다. + +## PR 1 생성 및 병합 + +변경 검토와 검사 통과 후 이 마일스톤을 별도로 승인합니다. + +```plaintext +현재 diff와 검사 결과를 검토해 주십시오. 검토한 별점 변경과 테스트만 커밋하고 현재 브랜치를 푸시한 후 main을 대상으로 끌어오기 요청을 만들어 주십시오. 리포지토리에 PR 템플릿이 있다면 사용해 주십시오. 변경 요약과 실제 검증 결과를 포함해 주십시오. PR을 병합하거나 다른 작업을 시작하지 마십시오. +``` + +반환된 PR URL을 엽니다. 에이전트 요약뿐 아니라 **Files changed**와 검사 결과를 확인합니다. CI를 해석할 때는 Tailspin 리포지토리의 워크플로 정의를 검토합니다. CI는 브라우저 관찰을 대체하지 않습니다. 실패를 해결하고 변경된 코드를 재검증합니다. + +PR이 리포지토리의 검토 및 검사 요구 사항을 충족하면 **Merge pull request**를 선택하고 GitHub에서 병합을 확정합니다. 브랜치 보호에 따라 다른 검토자가 필요하면 승인을 기다립니다. 진행 전에 PR이 **Merged**인지 확인합니다. + +`/exit`로 Copilot 세션을 종료합니다. 다음 연습에서는 지침 브랜치를 만들기 전에 로컬 `main`을 업데이트합니다. 병합되지 않은 이 기능 브랜치에서 시작하지 않습니다. + +## 요약 및 다음 단계 + +범위가 제한된 프롬프트, 코드 검토, 검증 근거, PR 병합이라는 첫 주기를 완료했습니다. 다음에는 [사용자 지정 지침으로 Copilot을 안내하고][next-lesson], 두 번째 작은 PR에서 문서화 규칙을 실증합니다. + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/ko-kr/cli/2-custom-instructions.md b/docs/ko-kr/cli/2-custom-instructions.md deleted file mode 100644 index 6603b934..00000000 --- a/docs/ko-kr/cli/2-custom-instructions.md +++ /dev/null @@ -1,241 +0,0 @@ ---- -title: "연습 2 - 커스텀 지침(Copilot CLI)" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[← 이전 연습: Copilot CLI 설치][previous-lesson] · [다음 연습: CLI로 코드 생성하기 →][next-lesson] - -생성형 AI로 작업할 때는 컨텍스트가 핵심입니다. 작업을 특정 방식으로 수행해야 하거나 Copilot이 알아야 할 배경 정보가 있다면, 그 컨텍스트를 사용할 수 있게 해야 합니다. Copilot을 돕는 여러 도구가 있으며, 이 워크숍 전반에서 이를 살펴봅니다. 먼저 [instruction files][instruction-files]부터 시작합니다. Instruction files는 일반적으로 코드 자체를 어떻게 구성해야 하는지에 초점을 맞춥니다. 이를 통해 Copilot은 원하는 코드가 *무엇인지*뿐 아니라 *어떻게* 구조화되어야 하는지도 이해할 수 있습니다. - -이 연습에서는 다음을 수행합니다. - -- 리포지토리 커스텀 지침과 경로 범위 지침 파일을 통해 프로젝트별 컨텍스트, 코딩 가이드라인, 문서화 표준이 Copilot에 전달되는 방식을 살펴봅니다. -- 현재 지침이 적용된 상태에서 필터링을 위한 첫 번째 데이터 조각인 publishers helper를 생성합니다. -- `.github/copilot-instructions.md`에 새로운 리포지토리 전체 표준을 추가합니다. -- 후속 프롬프트를 실행하고 재생성된 코드가 새 표준을 따르는 모습을 확인합니다. -- 다음 연습에서 이어서 사용할 수 있도록 지침 업데이트와 helper를 커밋합니다. - -> [!CAUTION] -> 생성된 코드는 설정한 표준 일부와 다를 수 있습니다. Copilot은 비결정적입니다. 목표는 출력이 문자 단위로 완전히 일치하는 것이 아니라, 지침을 업데이트한 뒤 동작 경향이 어떻게 바뀌는지 확인하는 것입니다. - -## 지침 파일 - -### 시나리오 - -훌륭한 개발 조직답게 Tailspin Toys에는 개발 관행에 대한 가이드라인과 요구 사항이 있습니다. 여기에는 다음이 포함됩니다. - -- 데이터 계층에는 항상 단위 테스트가 필요합니다. -- UI는 dark mode여야 하며 현대적인 느낌을 제공해야 합니다. -- 코드 문서는 TSDoc doc comments 형태로 추가해야 합니다. -- 각 파일의 맨 앞에는 파일의 역할을 설명하는 주석 블록을 추가해야 합니다. - -Instruction files를 사용하면 Copilot이 이러한 관행에 맞춰 작업을 수행하는 데 필요한 정보를 갖추도록 할 수 있습니다. - -### 커스텀 지침 - -커스텀 지침을 사용하면 Copilot에 컨텍스트와 선호 사항을 제공하여 코딩 스타일과 요구 사항을 더 잘 이해하도록 도울 수 있습니다. 이 기능은 더 관련성 높은 제안과 코드 스니펫을 얻도록 Copilot의 방향을 조정하는 강력한 방법입니다. 선호하는 코딩 규칙, 라이브러리, 코드에 포함하고 싶은 주석 유형까지 지정할 수 있습니다. 전체 리포지토리에 대한 지침을 만들 수도 있고, 작업 수준 컨텍스트를 위해 특정 파일 형식에 대한 지침을 만들 수도 있습니다. - -지침 파일에는 두 가지 유형이 있습니다. - -- `.github/copilot-instructions.md`는 리포지토리에 대한 **모든** 요청에서 Copilot으로 전송되는 단일 지침 파일입니다. 이 파일에는 프로젝트 수준 정보, 즉 Copilot에 보내는 대부분의 채팅 또는 CLI 요청에 공통으로 관련된 컨텍스트를 담아야 합니다. 사용 중인 기술 스택, 빌드 중인 내용의 개요, 모범 사례, 기타 전역 가이드라인이 여기에 포함될 수 있습니다. -- `.github/instructions/*.instructions.md` 파일은 특정 작업이나 파일 형식을 위해 만들 수 있습니다. TypeScript나 Astro 같은 특정 언어에 대한 지침을 제공하거나, UI 컴포넌트 또는 새로운 단위 테스트 세트 생성 같은 작업에 대한 지침을 제공할 수 있습니다. - -> [!NOTE] -> IDE에서 작업할 때 지침 파일은 Copilot Chat의 코드 생성에만 사용되며, code completions나 next-edit suggestions에는 사용되지 않습니다. -> -> Copilot Chat, Copilot CLI, Copilot cloud agent는 코드를 생성할 때 리포지토리 수준 지침과 `applyTo` front matter가 있는 `*.instructions.md` 파일을 모두 사용합니다. -> -> 또한 Copilot은 AGENTS.md와 CLAUDE.md를 포함한 [다른 표준의 지침 파일도 지원합니다][custom-instructions-support]. - -### 지침 파일 관리 모범 사례 - -지침 파일을 만드는 방법 전체를 이 워크숍에서 모두 다루지는 않습니다. 하지만 샘플 프로젝트에 포함된 예시는 대표적인 접근 방식을 보여 줍니다. 높은 수준에서 보면 다음과 같습니다. - -- `copilot-instructions.md`의 지침은 빌드 중인 내용의 설명, 프로젝트 구조, 전역 코딩 표준처럼 프로젝트 수준 가이드에 집중합니다. -- `*.instructions.md` 파일은 파일 형식(단위 테스트, Astro 컴포넌트, 데이터 계층)이나 특정 작업에 대한 구체적인 지침을 제공하는 데 사용합니다. -- 자연어를 사용합니다. 가이드는 명확하게 유지합니다. 코드가 어떻게 보여야 하는지와 어떻게 보이면 안 되는지에 대한 예시를 제공합니다. - -AI를 사용하는 방법이 하나로 정해져 있지 않듯, 지침 파일을 만드는 방법도 하나로 정해져 있지 않습니다. 실험을 통해 프로젝트에 가장 잘 맞는 방식을 찾게 됩니다. - -> [!TIP] -> GitHub Copilot을 사용하는 모든 프로젝트에는 탄탄한 instruction files 모음이 있어야 합니다. 이 프로젝트의 instruction files를 살펴보면 [UI 업데이트][ui-instructions]와 [Astro][astro-instructions]를 포함해 다양한 작업 유형에 대한 파일이 있다는 점을 확인할 수 있습니다. -> -> Copilot은 instruction files 생성도 도와줄 수 있습니다. 각 표면마다 노출 방식은 다르지만(예: VS Code의 **Configure Chat → Generate Agent Instructions**, Copilot CLI의 `/init`) 관련이 있는 경우 현재 사용 중인 표면의 연습에서 이를 안내합니다. -> -> 템플릿이나 시작점을 찾고 있나요? Instruction files, custom agents, 기타 리소스를 모아 둔 리포지토리인 [awesome-copilot][awesome-copilot]을 살펴봅니다. - -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support -## 이 프로젝트의 커스텀 지침 파일 살펴보기 - -잠시 시간을 내어 이 리포지토리에 포함된 지침 파일을 읽어 봅니다. 핵심 `copilot-instructions.md` 하나와 다양한 작업을 위한 `*.instructions.md` 파일 모음이 있습니다. 편집기 또는 GitHub 웹 UI에서 열어 봅니다. - -1. `.github/copilot-instructions.md`를 엽니다. -2. 파일을 살펴보면서 프로젝트의 간단한 설명과 **Agent notes**, **Code standards**, **Scripts**, **Repository Structure** 같은 섹션을 확인합니다. **Code standards** 아래에 중첩된 **GitHub Actions Workflows** 가이드가 있다는 점에 주목합니다. 이 내용은 Copilot과 상호 작용할 때 전반적으로 적용됩니다. -3. `.github/instructions` 폴더를 열어 둘러봅니다. Astro 파일, Drizzle 데이터 계층, 테스트 등 다양한 지침이 있는지 확인합니다. -4. `.github/instructions/unit-tests.instructions.md`를 엽니다. 상단의 `applyTo` 필드를 확인합니다. 이 필드는 지침이 적용될 파일을 결정하는 glob(리포지토리 루트 기준)을 설정합니다. 여기서는 모든 TypeScript test 파일(예: `**/*.test.ts`와 일치하는 파일)에 적용됩니다. -5. 이 프로젝트에서 단위 테스트를 만들 때 적용되는 구체적인 지침을 확인합니다. -6. 마지막으로 `.github/instructions/drizzle.instructions.md`를 열고 맨 아래로 스크롤합니다. 다른 지침 파일(`unit-tests.instructions.md` 등)과 프로젝트의 기존 파일에 대한 링크가 있는지 확인합니다. 이렇게 하면 더 큰 지침 세트를 더 작고 재사용 가능한 파일로 나눌 수 있고, 코드 생성 시 Copilot이 따를 예시를 가리킬 수 있습니다. (해당 경로는 리포지토리 루트가 아니라 지침 파일 기준 상대 경로입니다.) - -> [!NOTE] -> `copilot-instructions.md`의 **Code formatting requirements** 섹션에는 프로젝트 코딩 표준이 문서화되어 있지만, 아직 코드 내부 문서화는 요구하지 않습니다. 다음 단계에서 TSDoc doc comments와 파일 주석 헤더에 대한 규칙을 추가합니다. - -## 브랜치 만들기 - -코드를 변경할 예정이므로 작업용 브랜치를 만듭니다. - -1. 코드스페이스 터미널에서 새 브랜치를 만들고 전환합니다. - - ```bash - git checkout -b update-custom-instructions - ``` - -2. Copilot CLI가 설치 및 인증되었는지 확인합니다. - - ```bash - copilot --version - ``` - - 명령을 찾을 수 없거나 아직 로그인하지 않았다면 [연습 1 - GitHub Copilot CLI 설치](../1-install-copilot-cli/)로 돌아갑니다. - -## 지침을 업데이트하기 *전*에 Copilot CLI 사용하기 - -커스텀 지침의 영향을 확인하려면 먼저 현재 지침이 적용된 상태에서 코드를 생성합니다. 이후 파일을 업데이트하고 후속 프롬프트를 실행합니다. - -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. - -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI 세션이 **repository root**에서 실행 중인지 확인합니다. 그래야 `.github/copilot-instructions.md`를 자동으로 불러옵니다. -2. Copilot CLI 프롬프트에서 필터링 UI가 사용할 publishers helper를 생성해 달라고 요청합니다. - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -3. Copilot CLI는 프로젝트를 탐색하고, 계획을 제안하고, 이 `--yolo` 세션에서 파일을 작성합니다. 터미널 출력의 변경 내용을 확인한 뒤 편집기에서 검토합니다. -4. 편집기에서 생성된 `src/lib/publishers.ts`를 엽니다. -5. helper가 첫 번째 인수로 `db` client를 받고, publisher의 typed array를 반환하는 typed function이라는 점을 확인합니다. 이는 `src/lib/*.ts`에 적용되는 `.github/instructions/drizzle.instructions.md`의 데이터 계층 규칙에서 비롯됩니다. -6. 생성된 코드에 TSDoc doc comments와 파일 수준 주석 헤더가 **없다**는 점을 확인합니다. - -> [!CAUTION] -> Copilot은 확률적으로 동작하므로, 지시하지 않았더라도 doc comments를 추가할 가능성이 있습니다. 그런 경우에도 괜찮습니다. 지침 업데이트 후 *일관성*이 향상되는 점이 핵심입니다. - -## 새로운 리포지토리 표준 추가하기 - -앞서 설명했듯이 `.github/copilot-instructions.md`는 Copilot에 프로젝트 수준 정보를 제공하도록 설계되었습니다. 이제 리포지토리 코딩 표준을 문서화해 코드 제안을 개선해 보겠습니다. - -1. `.github/copilot-instructions.md`를 다시 엽니다. -2. **Code formatting requirements** 섹션을 찾습니다. 대략 27번째 줄 근처에 있을 것입니다. 이 섹션이 프로젝트의 코딩 표준을 문서화하고 있지만, 아직 코드 내부 문서화 규칙이 없기 때문에 생성된 helper에 doc comments가 없었다는 점을 확인합니다. -3. 기존 표준 바로 아래에 다음 markdown 줄을 추가해 Copilot이 파일 주석 헤더와 TSDoc doc comments를 넣도록 지시합니다. - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. `copilot-instructions.md`를 저장합니다. - -> [!TIP] -> 이전 연습에서 본 것처럼 지침 파일은 전역 가이드를 위한 리포지토리 수준(`.github/copilot-instructions.md`)으로 만들 수도 있고, 특정 언어, 파일 형식, 작업을 위한 `*.instructions.md` 파일로 만들 수도 있습니다. 방금 추가한 doc comment 규칙처럼 프로젝트 전반에 적용되는 표준은 리포지토리 수준 파일에 두는 것이 적절합니다. - -## 프롬프트를 다시 실행하고 변화를 관찰하기 - -이제 지침에 doc comment 규칙이 추가되었으므로 방금 생성한 publishers 파일을 Copilot CLI로 업데이트해 보겠습니다. 동일한 표준 지시가 다시 작성된 코드에도 적용됩니다. - -1. Copilot CLI 세션에서 `/clear`를 보내 새 대화를 시작합니다. -2. 다음 프롬프트를 보냅니다. - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. 편집이 완료되면 `src/lib/publishers.ts`를 다시 엽니다. -4. 이제 파일 맨 앞에 다음과 비슷한 주석 블록이 추가된 점을 확인합니다. - - ```typescript - /** - * Publisher data-access helpers for the Tailspin Toys Crowd Funding platform. - * Provides functions to retrieve publisher information from the database. - */ - ``` - -5. 생성된 함수에 이제 다음과 비슷한 TSDoc doc comment가 포함된 점을 확인합니다. - - ```typescript - /** - * Returns a list of all publishers with their id and name. - * - * @param db - The Drizzle database client. - * @returns A promise that resolves to an array of publisher objects. - */ - ``` - -6. 업데이트된 파일은 그대로 유지합니다. 다음 연습에서 이 파일을 기반으로 첫 번째 데이터 조각을 확장합니다. - -## 첫 번째 필터링 조각 커밋 및 푸시하기 - -1. 터미널에서 변경된 파일을 확인합니다. - - ```bash - git status - ``` - -2. 지침 업데이트와 helper를 stage합니다. - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. 변경 사항을 커밋합니다. - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. 브랜치를 푸시합니다. - - ```bash - git push -u origin update-custom-instructions - ``` - -## 요약 및 다음 단계 - -이 프로젝트의 지침 파일을 통해 Copilot이 어떻게 컨텍스트를 받아들이는지 살펴본 다음, Copilot CLI를 사용해 다음을 수행했습니다. - -- 기존 지침을 바탕으로 필터링용 publishers data-access helper 기반을 생성했습니다. -- `.github/copilot-instructions.md`에 새로운 리포지토리 전체 표준을 추가했습니다. -- 후속 프롬프트를 실행하고 재생성된 코드가 새 표준을 따르는 모습을 확인했습니다. -- 지침 업데이트와 helper 기반을 모두 커밋하고 푸시했습니다. - -다음으로는 [코드 생성 연습][next-lesson]에서 백로그 작업을 구현하면서 이 지침을 적용합니다. - -## 리소스 - -- [GitHub Copilot 사용자 지정을 위한 instruction files][instruction-files] -- [커스텀 지침 작성 모범 사례][instructions-best-practices] -- [Copilot용 더 나은 커스텀 지침을 작성하는 5가지 팁][copilot-instructions-five-tips] -- [Instruction files와 기타 리소스를 모아 둔 Awesome Copilot][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ diff --git a/docs/ko-kr/cli/3-custom-instructions.md b/docs/ko-kr/cli/3-custom-instructions.md new file mode 100644 index 00000000..0030270f --- /dev/null +++ b/docs/ko-kr/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "연습 3 - 사용자 지정 지침으로 Copilot 안내" +description: "범위를 좁힌 문서화 규칙을 추가하고 기존 코드에 적용하여 실증한 후 두 번째 끌어오기 요청을 병합합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +컨텍스트는 Copilot이 *무엇을* 만들지뿐 아니라 팀이 *어떻게* 코드를 작성하기를 기대하는지도 이해하게 합니다. 범위를 좁힌 문서화 규칙을 추가하고 실제 코드에 미치는 효과를 확인한 후, 지침과 실증을 PR 2로 함께 병합합니다. + +이 연습에서는 다음을 수행합니다. + +- 리포지토리 전체 지침과 경로별 지침을 살펴봅니다. +- 필터링을 미리 구현하지 않고 문서화 표준을 추가합니다. +- 작은 기존 헬퍼나 컴포넌트에서 표준을 실증합니다. +- 지침 마일스톤을 검증하고 병합합니다. + +## 시나리오 + +Tailspin Toys 팀은 유용한 코드 문서화를 대화마다 누군가 기억해서 요청해야 하는 일이 아니라 반복해서 적용할 수 있는 규칙으로 만들려고 합니다. 리포지토리 지침에 표준을 추가하고 기존 코드에서 실증하되, 동작을 변경하거나 필터링을 미리 구현하지 않습니다. + +## 지침 살펴보기 + +리포지토리에는 이미 두 가지 유용한 지침이 있습니다. + +- `.github/copilot-instructions.md`는 기술 스택, 구조, 공통 관행 등 리포지토리 전체의 컨텍스트를 제공합니다. +- `.github/instructions/*.instructions.md`는 특정 범위의 지침을 제공합니다. 프런트매터의 `applyTo` glob이 지침을 적용할 파일을 식별합니다. + +편집기에서 다음 파일을 엽니다. + +1. `.github/copilot-instructions.md`를 읽고 현재 코딩 및 검증 표준을 찾습니다. +2. `.github/instructions/`에서 Astro, 데이터 계층, 테스트 지침을 살펴봅니다. +3. `unit-tests.instructions.md`에서 `applyTo` 패턴과 테스트 규칙을 확인합니다. +4. `drizzle.instructions.md`에서 데이터 접근 패턴과 예제 참조를 확인합니다. + +리포지토리 전체 지침은 간결하게 유지하고, 파일별 세부 사항은 해당 범위의 파일에 두며, 같은 규칙의 상충하는 복사본을 피합니다. [GitHub 지침 지원 참조][instruction-support]에서 각 환경이 지원하는 지침 형식을 설명합니다. + +> [!NOTE] +> 지침은 생성에 영향을 주지만 준수를 보장하지 않습니다. 지침 내용과 코드에 미치는 효과를 모두 검토합니다. Copilot이 이미 좋은 주석을 작성한다면, 이 연습은 규칙을 명시적이고 반복 가능하게 만드는 과정입니다. 변경 전후의 실패를 억지로 만드는 과정이 아닙니다. + +## 병합된 PR 1에서 시작 + +별점 PR이 병합되었는지 확인합니다. 학습용 리포지토리 터미널에서 업데이트된 `main`을 기반으로 다음 마일스톤을 시작합니다. + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +작업 트리에 미커밋 변경이 있거나 pull이 실패하면 해당 상태를 해결한 후 계속합니다. **Interactive** 모드를 유지합니다. + +리포지토리의 **Issues** 탭에서 **Update our repository coding standards**를 찾아 실제 URL을 복사합니다. 이 이슈는 의도를 설명하고, 내보낸 데이터 계층 함수와 컴포넌트 계약을 문서화하며, 주석을 최신 상태로 유지하는 넓은 맥락을 제공합니다. 이 연습은 문서화의 제한된 일부를 다루며, 리포지토리 전체 리팩터링이나 이슈의 모든 기준을 완료하겠다는 약속이 아닙니다. + +## 문서화 규칙 추가 + +플레이스홀더를 실제 이슈 URL로 바꾸고 보냅니다. + +```plaintext +컨텍스트를 위해 다음 코딩 표준 이슈를 읽어 주십시오: . 기존 리포지토리 전체 지침과 범위별 지침을 살펴봐 주십시오. 범위를 좁힌 문서화 규칙을 추가해 주십시오. 코드를 반복하지 말고 의도를 설명하고, db/와 src/lib/에서 내보낸 함수의 목적·매개변수·반환값을 TSDoc/JSDoc으로 문서화하고, 재사용 가능한 Astro 컴포넌트의 Props 계약을 문서화하며, 관련 코드가 바뀔 때 주석도 최신 상태로 유지하도록 해 주십시오. + +각 규칙을 적절한 기존 지침 파일에 두고 중복이나 모순을 피해 주십시오. 기존 포맷 및 lint 표준을 유지하고, 적절한 경우 README에 문서화 규칙을 링크하거나 요약해 주십시오. 변경을 문서화 표준으로 제한하고 포맷 도구를 이전하거나 리포지토리 전체를 다시 작성하지 마십시오. 스킬이나 에이전트를 만들거나 필터링을 구현하거나 커밋, 푸시, PR 생성을 하지 마십시오. 실증 전에 지침을 검토할 수 있도록 중단해 주십시오. +``` + +diff를 확인합니다. 규칙은 유용한 주석을 장려해야 하며, 모든 파일에 상용구 헤더를 요구하거나 명백한 코드를 반복하는 주석을 요구해서는 안 됩니다. 진행 전에 수정을 요청합니다. + +## 실제 코드에서 규칙 실증 + +리포지토리를 살펴본 후 작은 기존 내보낸 헬퍼나 재사용 가능한 컴포넌트를 선택합니다. 퍼블리셔 헬퍼일 필요는 없으며, `src/lib/publishers.ts`가 이미 존재해야 한다는 요구 사항도 없습니다. + +다음을 보냅니다. + +```plaintext +업데이트된 지침을 사용하여 더 명확한 문서화가 도움이 될 작은 기존 내보낸 헬퍼 또는 재사용 가능한 Astro 컴포넌트를 하나 선택해 주십시오. 런타임 동작을 바꾸거나 필터링 기능을 추가하지 않고 해당 파일에 규칙을 직접 적용해 주십시오. 어떤 지침이 변경을 이끌었는지 설명하고 커밋이나 PR 생성 전에 중단해 주십시오. +``` + +실제로 변경된 파일을 엽니다. 헬퍼라면 주석이 매개변수, 반환값, 주입되는 데이터베이스 인수를 정확히 설명하는지 확인합니다. 컴포넌트라면 `Props` 계약이 문서화되었는지 확인합니다. 주석 블록 유무만 보지 말고 설명과 코드가 일치하는지 확인합니다. + +> [!TIP] +> 채팅의 예시 코드 조각은 실증이 아닙니다. 실제 리포지토리 변경을 확인합니다. 선택한 코드가 이미 규칙을 충족한다면 중복 주석을 추가하지 말고 개선할 이유가 있는 다른 작은 기존 대상을 선택합니다. + +## PR 2 검증 및 병합 + +검토한 변경을 검증하도록 Copilot에 요청합니다. + +```plaintext +지침 변경과 작은 문서화 실증을 검토해 주십시오. 런타임 동작이 바뀌지 않았는지 확인해 주십시오. package.json을 확인하고 npm run lint와 npm run typecheck:all을 실행하며, 코드 변경상 필요한 경우 영향을 받는 기존 테스트도 실행해 주십시오. 정확한 명령과 결과를 보고해 주십시오. 아직 설치하거나 스킬을 만들거나 커밋, 푸시, PR 생성을 하지 마십시오. +``` + +실패를 해결하고 최종 diff를 확인합니다. 그런 다음 마일스톤을 승인합니다. + +```plaintext +검토한 문서화 지침, 직접 관련된 README 업데이트, 작은 코드 실증만 커밋해 주십시오. 현재 브랜치를 푸시하고 리포지토리 PR 템플릿에 따라 main을 대상으로 PR을 만들어 주십시오. 검증 결과를 포함하고 코딩 표준 이슈에 대한 부분적 기여로 참조해 주십시오. 모든 이슈 기준을 실제로 충족하지 않았다면 이슈 종료 키워드를 사용하지 마십시오. 병합하거나 필터링을 시작하지 마십시오. +``` + +PR URL을 열고 **Files changed**와 CI를 검토합니다. 필수 검사와 검토가 모두 통과한 후 GitHub에서 병합하고 PR 2가 **Merged**인지 확인합니다. `/exit`로 CLI 세션을 종료합니다. 이 PR이 병합되기 전에는 다음 마일스톤을 시작하지 않습니다. + +## 요약 및 다음 단계 + +문서화 규칙과 실제 실증이 이제 `main`에 있습니다. 다음에는 병합된 상태를 기반으로 새 브랜치를 만들어 [Plan과 Autopilot으로 필터링을 구축합니다][next-lesson]. + +## 리소스 + +- [리포지토리 사용자 지정 지침 추가][repository-instructions]에서는 리포지토리 전체와 경로별 지침을 설명합니다. +- [Awesome Copilot][awesome-copilot]의 예제는 무조건 채택하지 말고 검토하고 조정하여 사용합니다. + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/ko-kr/cli/3-generating-code.md b/docs/ko-kr/cli/3-generating-code.md deleted file mode 100644 index 4dfa4c62..00000000 --- a/docs/ko-kr/cli/3-generating-code.md +++ /dev/null @@ -1,98 +0,0 @@ ---- -title: "연습 3 - GitHub Copilot CLI로 프로젝트 기능 추가하기" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -예상할 수 있듯이 GitHub Copilot CLI로 수행하는 핵심 작업은 프로젝트에 기능, 동작, 코드를 추가하는 일입니다. 이제 백로그의 issue 중 하나를 가져와 Copilot이 구현을 도와주도록 해보겠습니다. - -## 시나리오 - -이제 프로젝트의 필터링 작업을 마무리할 차례입니다. 백로그에는 이미 필터링 issue가 있고, 이전 연습에서 foundation helper도 만들었습니다. Copilot이 issue 세부 정보를 가져오고, 기존 작업을 고려한 뒤, 남은 기능을 구현하도록 해보겠습니다. - -이 연습에서는 다음을 수행합니다. - -- Plan mode를 사용해 필터링 기능 구현 계획을 생성합니다. -- Copilot으로 웹 사이트에 필터링을 추가하는 데 필요한 코드를 생성합니다. - -이 연습이 끝나면 프로젝트에 새로운 기능이 추가됩니다. - -## Plan mode 활용하기 - -AI의 가장 뛰어난 활용 방식 중 하나는 계획 수립입니다. 무엇을 만들고 싶은지 대략적인 개념은 있지만 아이디어를 정리할 대상이 필요할 때가 많습니다. AI 도구는 후속 질문을 하고, 빠진 구성 요소나 잠재적인 함정을 함께 검토하면서 생각을 구체화하도록 도와줍니다. Copilot CLI는 이 과정을 지원하기 위해 plan mode를 제공합니다. 또한 계획 수립에 들인 시간은 Copilot이 요구 사항에 더 잘 맞는 코드를 생성하는 데 도움이 됩니다. - -Copilot CLI의 plan mode를 사용해 새 기능 생성 과정을 시작합니다. - -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. - -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI에 다음 프롬프트를 입력해 필터링 issue를 바탕으로 계획을 생성합니다. - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -2. Copilot이 계획을 세우는 동안 후속 질문을 할 수 있습니다. 질문이 나오면 원하는 구현 방식에 맞게 답변합니다. -3. 계획이 생성되면 설계 청사진을 검토합니다. 데이터 계층과 UI 전반의 남은 변경 사항, 그리고 테스트 생성이 권장되는 것을 확인할 수 있습니다. -4. Copilot CLI는 계획에 대한 추가 피드백을 제공할 수 있는 기능도 제공합니다. 안내된 영역으로 커서를 이동한 뒤 제안을 입력하면 Copilot이 이를 반영한 새 버전의 계획을 제시합니다. -5. 계획이 만족스럽다면 Copilot이 제공하는 옵션을 선택해 새 기능 구현을 시작합니다. - -> [!NOTE] -> Copilot은 확률적으로 동작하므로, 정확한 텍스트와 제공되는 옵션은 달라질 수 있습니다. 하지만 구현을 시작하는 옵션이 표시되며 대체로 다음과 비슷한 문구를 보게 됩니다. -> -> `Yes, and switch to autopilot mode`. -> -> Copilot은 위 예시처럼 [autopilot mode](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot)를 활성화하는 옵션을 제안할 수 있습니다. Autopilot mode를 사용하면 Copilot CLI가 각 단계마다 입력을 기다리지 않고 작업을 진행합니다. 처음 지시를 주면 Copilot CLI가 작업이 완료되었다고 판단할 때까지 각 단계를 자율적으로 처리합니다. 현재는 격리된 환경에서 작업하므로 autopilot을 실행하고 모든 도구를 허용해도 괜찮습니다. - -6. Copilot이 파일 생성을 시작합니다. - -> [!NOTE] -> 이 작업은 몇 분 정도 걸릴 수 있습니다. Copilot이 파일을 수정하고 생성하며, 테스트를 업데이트 및 생성하고, 모든 테스트를 실행해 성공 여부를 확인하는 모습을 보게 됩니다. 지금까지 살펴본 내용을 되돌아보거나 잠시 음료를 즐기기 좋은 시간입니다. - -## 코드 검토하기 - -AI가 생성한 코드는 운영 환경에 병합하기 전에 반드시 검토해야 합니다. 이제 Copilot이 기능 구현 과정에서 생성하거나 수정한 파일을 살펴보겠습니다. - -1. Copilot CLI에서 다음 명령을 사용해 "diff" 또는 코드 변경 사항을 표시합니다. - - ``` - /diff - ``` - -2. 변경된 파일을 확인합니다. 화살표 키로 좌우 이동하면서 서로 다른 파일을 볼 수 있습니다. 새 필터 컨트롤과 클라이언트 측 필터링이 들어간 게임 목록 페이지, `src/lib/games.ts`, `games.test.ts` 같은 테스트 파일이 업데이트된 것을 확인할 수 있습니다. Copilot이 전체 구현에 맞춰 기존 helper를 조정했다면 `publishers.ts`가 수정된 경우도 있을 수 있습니다. - -## 요약 및 다음 단계 - -이제 Copilot CLI의 도움으로 웹 사이트에 필터링 기능을 추가했습니다. 구체적으로 다음을 수행했습니다. - -- Plan mode를 사용해 필터링 기능 구현 계획을 생성했습니다. -- Copilot을 사용해 웹 사이트에 필터링을 추가하는 데 필요한 코드를 생성했습니다. - -물론 다음 단계는 실제로 동작하는지 확인하는 것입니다. Pull request를 열기 전에 [Playwright MCP server로 기능 테스트하기][next-lesson]로 이동해 검증해 보겠습니다. - -## 리소스 - -- [Copilot CLI 사용하기][using-copilot-cli] -- [Copilot CLI 소개][about-copilot-cli] -- [Copilot CLI의 컨텍스트 관리][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/ko-kr/cli/4-build-filtering.md b/docs/ko-kr/cli/4-build-filtering.md new file mode 100644 index 00000000..9ea7ddfe --- /dev/null +++ b/docs/ko-kr/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "연습 4 - Plan과 Autopilot으로 필터링 구축" +description: "필터링 요구 사항에 합의하고 구현 계획을 승인한 후 코드를 검증하고 기능 브랜치에 체크포인트를 저장합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +이제 사용자가 카테고리와 퍼블리셔로 게임을 필터링하는 더 큰 기능을 구축합니다. 코딩 전에 계획하고 **Autopilot**을 명시적으로 승인한 후 구현을 검토하고 테스트하며 체크포인트를 저장합니다. 이 연습에서는 스킬, QA 에이전트, 기능 PR을 만들지 않습니다. + +이 연습에서는 다음을 수행합니다. + +- 필터링 이슈를 읽고 Plan 모드에서 불명확한 요구 사항을 합의합니다. +- Autopilot을 통한 제한된 범위의 구현을 명시적으로 승인합니다. +- diff와 네 가지 검사 결과를 모두 검토하고 체크포인트를 저장합니다. + +## 시나리오 + +Tailspin Toys의 카탈로그가 커지면서 방문자가 카테고리와 퍼블리셔로 게임을 좁혀 볼 수 있어야 합니다. 백로그 이슈에 기능이 설명되어 있지만 카테고리 조합 방식 같은 세부 사항은 코딩 전에 합의해야 합니다. Plan 모드로 결정을 정리한 다음 Autopilot을 통한 제한된 범위의 구현을 승인합니다. + +## 필터링 마일스톤 시작 + +PR 1과 PR 2가 병합되었는지 확인합니다. 학습용 리포지토리 터미널에서 실행합니다. + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +작업 트리에 미커밋 변경이 없고 `main`에서 성공적으로 업데이트한 경우에만 계속합니다. 연습 4~8은 동일한 브랜치와 체크아웃을 사용합니다. 이후 체크포인트 커밋에서 스킬과 QA 프로필을 추가합니다. 연습마다 브랜치를 만들지 않습니다. + +## 실제 이슈 가져오기 + +리포지토리의 **Issues** 탭에서 **Allow users to filter games by category and publisher**를 찾아 URL을 복사합니다. 템플릿의 파일명이나 이슈 번호로 자신의 복사본에서 이슈를 식별할 수 있다고 가정하지 않습니다. + +현재 이슈는 다음을 요구합니다. + +- 하나 이상의 카테고리를 선택합니다. +- 퍼블리셔로 필터링하고 카테고리와 조합합니다. +- 두 필터를 모두 지원하는 데이터 접근 헬퍼를 `src/lib/`에 둡니다. +- 키보드 탐색, 적절한 ARIA, 보이는 포커스 상태, `data-testid` 속성을 갖춘 접근성 있는 컨트롤을 제공합니다. +- 헬퍼는 Vitest 단위 테스트로, 필터링 동작은 Playwright E2E 테스트로 검증합니다. + +실제 이슈를 기준으로 읽습니다. 이슈 URL과 승인한 추가 합의 사항을 연습 7의 QA 프롬프트에서 사용할 수 있도록 보관합니다. + +## 코딩 전에 계획 + +Shift+Tab으로 **Plan** 모드를 선택하거나 `/plan`으로 시작합니다. 이슈 플레이스홀더를 바꾸고 보냅니다. + +```plaintext +다음 이슈에 설명된 필터링 기능을 계획해 주십시오: . 변경을 제안하기 전에 이슈, 리포지토리 지침, 기존 데이터 접근 헬퍼, UI, 테스트를 읽어 주십시오. 현재 체크아웃을 기준으로 삼고 퍼블리셔 헬퍼가 이미 만들어졌다고 가정하지 마십시오. + +여러 카테고리 선택, 퍼블리셔 필터링, 두 조건의 조합, 데이터 접근 지원, 접근성 있는 컨트롤, 단위/E2E 커버리지를 다뤄 주십시오. 여러 카테고리의 조합 방식, 필터 해제, 빈 결과 등 지정되지 않은 동작은 질문하고 승인된 계획과 함께 결정을 기록해 주십시오. 불필요한 서버 API를 도입하지 말고 정적 Astro 아키텍처를 유지해 주십시오. + +현재 브랜치에서 구현하도록 계획하고, 필요한 단위 및 E2E 테스트와 npm run lint, npm run test:unit, npm run test:e2e, npm run typecheck:all을 통한 검증을 포함해 주십시오. 먼저 필수 조건과 서버 소유권을 확인하고, 소프트웨어를 설치하거나 관련 없는 프로세스를 중지하지 말고 차단 요인을 보고해 주십시오. + +계획에 다음 실행 경계를 포함해 주십시오. 제가 승인한 후에는 필터링 기능과 필요한 테스트만 구현하고 검사를 실행한 다음 검토할 수 있도록 중단해 주십시오. quality-checks 스킬, QA 에이전트, 이후 워크숍에서 다룰 다른 자산을 만들지 마십시오. 브랜치를 변경하거나 커밋, 푸시, PR 생성 또는 병합을 하지 마십시오. + +제가 계획을 승인하기 전에는 애플리케이션 코드를 편집하거나 구현을 시작하지 마십시오. +``` + +후속 질문에 답합니다. 나중에 숨겨진 수락 기준을 추가하지 않습니다. 구현, 브라우저 검사, QA가 동일한 요구 사항을 사용할 수 있도록 합의한 답변을 이슈 URL과 함께 저장합니다. + +계획에서 데이터 계층 및 UI 변경, 테스트, 접근성 있는 컨트롤, 병합한 문서화 규칙을 검토합니다. 네 가지 검사 모두, 검토를 위한 중단 조건, 이후 워크숍 자산·브랜치 변경·커밋·푸시·PR 작업 금지가 명시되어 있는지 확인합니다. 제한이나 기준이 누락되었거나 이슈 범위 밖의 작업을 제안하면 승인 전에 수정을 요청합니다. + +## Autopilot 명시적 승인 + +계획에 검토한 범위와 실행 경계가 포함된 후에만 계획 승인 옵션 **Accept plan and build on autopilot**을 사용합니다. 버전에 따라 문구가 다르면 **Autopilot**으로 전환하는 옵션을 명시적으로 선택하고 모드 표시를 확인합니다. 승인하면 범위가 제한된 계획의 실행이 시작됩니다. 작업 시작 후 프롬프트로 제한을 추가하는 방식에 의존하지 않습니다. + +> [!CAUTION] +> Autopilot은 도구 권한뿐 아니라 작업의 지속을 제어합니다. 선택 전에 권한 대화 상자를 검토합니다. 전체 권한은 도구, 경로, URL 액세스를 허용하며, 제한된 권한은 승인이 필요한 작업을 차단할 수 있습니다. 코드스페이스가 비밀을 노출하거나 관련 없는 리소스를 변경해도 된다는 허가는 아닙니다. 건너뛴 검사를 통과로 처리하지 말고 차단된 액세스를 신중하게 해결합니다. + +작업과 명령 결과를 살펴봅니다. Autopilot은 계획을 완료하기 전에 연속 실행 한도에서 멈추거나 차단 요인을 보고할 수 있습니다. 동일한 범위를 유지하면서 상태를 검토한 후 계속하도록 승인합니다. + +## Interactive로 돌아와 검토 + +구현이 멈추면 추가 프롬프트를 보내기 전에 Shift+Tab으로 **Interactive** 모드로 돌아옵니다. 작업 후에도 Autopilot이 활성 상태일 수 있습니다. 자동으로 전환되었다고 가정하지 않습니다. + +`/diff`를 입력하고 변경된 모든 파일을 확인합니다. 구현을 이슈 및 승인한 추가 합의 사항과 비교합니다. + +- 사용자가 합의한 대로 여러 카테고리를 선택하고 퍼블리셔로 필터링하며 두 조건을 조합할 수 있습니까? +- 데이터 접근 헬퍼가 UI만 바꾸는 것이 아니라 실제로 필터를 지원합니까? +- 컨트롤에 의미 있는 레이블, 키보드 지원, 보이는 포커스, 안정적인 테스트 식별자가 있습니까? +- 기존 검증을 약화하지 않고 합의한 필터 해제 및 빈 결과를 포함해 테스트가 동작을 검증합니까? +- 코드가 문서화 규칙을 따르고 정적 앱 아키텍처를 유지합니까? + +네 가지 npm 검사 모두의 근거를 검토합니다. 아직 `quality-checks`를 만들지 않았으므로 검사는 직접 실행합니다. Playwright E2E 설정은 빌드하고 미리 보기를 제공합니다. 오래된 콘텐츠를 재사용하지 않도록 스위트 실행 전에 직접 시작한 개발 서버만 중지합니다. 포트 충돌이나 브라우저 누락은 해결해야 할 차단 요인이며, 다른 프로세스를 종료하거나 통과를 주장할 이유가 아닙니다. + +필요하면 범위를 좁힌 수정을 요청하고 영향을 받는 검사를 다시 실행하여 최종 구현의 검증을 완료합니다. 직접 브라우저 관찰은 연습 6에서 수행하며, 이번 자동 검증과는 목적이 다릅니다. + +## 구현 체크포인트 저장 + +diff와 결과에 문제가 없다면 로컬 체크포인트를 승인합니다. + +```plaintext +현재 diff와 검증 결과를 검토해 주십시오. 검토한 필터링 구현과 테스트만 포함한 체크포인트 커밋을 만들어 주십시오. 현재 필터링 브랜치와 체크아웃을 유지해 주십시오. 아직 푸시하거나 PR을 생성하거나 스킬 또는 QA 에이전트를 만들지 마십시오. +``` + +## 요약 및 다음 단계 + +필터링 요구 사항을 합의하고 구현과 테스트를 검토했으며 체크포인트를 저장했습니다. 테스트한 리비전을 기록하고 이슈 URL과 승인한 추가 합의 사항을 보관합니다. **Interactive**를 유지하고 동일한 체크아웃에서 [연습 5 - quality-checks 스킬 만들기 및 사용][next-lesson]을 계속합니다. + +## 리소스 + +- [Autopilot 모드 및 권한][autopilot]에서는 자율적인 작업 지속과 Interactive로 돌아가는 방법을 설명합니다. +- [Copilot CLI 명령 참조][cli-reference]에는 현재 모드 조작 방법과 명령이 나열되어 있습니다. + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ko-kr/cli/4-mcp.md b/docs/ko-kr/cli/4-mcp.md deleted file mode 100644 index e696b6b8..00000000 --- a/docs/ko-kr/cli/4-mcp.md +++ /dev/null @@ -1,158 +0,0 @@ ---- -title: "연습 4 - Playwright MCP server로 기능 테스트하기" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -방금 Copilot CLI로 필터링 기능을 생성했습니다. Pull request를 열기 전에 브라우저에서 실제로 동작하는지 확인해야 합니다. 직접 앱을 눌러 보며 확인하는 대신 **Playwright MCP server**를 연결해 Copilot이 실제 브라우저를 제어하면서 기능을 테스트하도록 해보겠습니다. - -이 연습에서는 다음을 수행합니다. - -- Model Context Protocol(MCP)이 무엇인지 이해하고, MCP server가 Copilot CLI를 어떻게 확장하는지 살펴봅니다. -- Playwright MCP server를 Copilot CLI에 추가합니다. -- 브라우저에서 필터링 기능을 수동 테스트하도록 Copilot에 요청합니다. - -## Model Context Protocol(MCP)이란 무엇인가요? - -[Model Context Protocol(MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/)은 AI agent가 외부 도구 및 서비스와 통신할 수 있는 방법을 제공합니다. MCP를 사용하면 AI agent는 외부 도구와 서비스를 실시간으로 사용할 수 있습니다. 이를 통해 최신 정보에 접근하고(resources 사용), 작업을 대신 수행하도록(tools 사용) 할 수 있습니다. - -이러한 도구와 리소스는 MCP server를 통해 접근합니다. MCP server는 AI agent와 외부 도구 및 서비스 사이의 브리지 역할을 합니다. MCP server는 AI agent와 외부 도구(기존 API 또는 NPM package 같은 로컬 도구 등) 간의 통신을 관리합니다. 각 MCP server는 AI agent가 접근할 수 있는 서로 다른 도구와 리소스 집합을 나타냅니다. - -널리 사용되는 MCP server 예시는 다음과 같습니다. - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**: GitHub 리포지토리를 관리하기 위한 API 집합에 접근할 수 있게 해줍니다. 새 리포지토리 생성, 기존 리포지토리 업데이트, issue 및 pull request 관리 같은 작업을 AI agent가 수행할 수 있습니다. -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**: Playwright를 사용한 브라우저 자동화 기능을 제공합니다. 웹 페이지 탐색, 양식 입력, 버튼 선택 같은 작업을 AI agent가 수행할 수 있습니다. - -서로 다른 도구와 리소스에 접근할 수 있게 해주는 다른 MCP server도 많이 있습니다. GitHub는 검색성과 생태계 기여를 높이기 위해 [MCP registry](https://github.com/mcp)를 제공합니다. - -> [!CAUTION] -> 보안 측면에서 MCP server는 프로젝트의 다른 dependency와 동일하게 취급해야 합니다. MCP server를 사용하기 전에 소스 코드를 신중히 검토하고, 게시자를 확인하며, 보안 영향을 고려합니다. 신뢰할 수 있는 MCP server만 사용하고, 민감한 리소스나 작업에 대한 액세스를 부여할 때는 특히 주의합니다. - -> [!NOTE] -> [GitHub MCP server][github-mcp-server]는 Copilot CLI에 **기본 내장**되어 있습니다. 별도 설정 없이 바로 사용할 수 있으며, 워크숍 전반에서 Copilot이 리포지토리를 읽고 쓰고 있었던 것도 이 서버 덕분입니다. 이 연습에서는 Copilot에 브라우저를 제공하기 위해 두 번째 서버인 Playwright를 추가합니다. - -## Playwright MCP server 추가하기 - -서버를 추가하는 가장 빠른 방법은 대화형 `/mcp add` 명령입니다. Copilot이 제어할 수 있는 브라우저를 제공하는 [Playwright MCP server][playwright-mcp-server]를 등록합니다. - -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. - -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI 세션에서 다음을 입력합니다. - - ```text - /mcp add - ``` - -2. 구성 양식이 나타나면 Tab으로 필드 사이를 이동하면서 다음과 같이 입력합니다. - - - **Server Name**: `playwright` - - **Server Type**: **Local**(또는 **STDIO**로 표시됨)을 선택합니다. - - **Command**: `npx @playwright/mcp@latest --headless` - - **Tools**: 서버의 모든 도구를 허용하기 위해 `*` 그대로 둡니다. - -3. Ctrl+S를 눌러 저장합니다. 서버가 추가되고 즉시 사용할 수 있습니다. 재시작은 필요하지 않습니다. - -`--headless` 플래그는 Playwright가 표시 창 없이 브라우저를 실행하도록 지정합니다. 데스크톱을 표시할 수 없는 코드스페이스 안에서는 이 설정이 필요합니다. 내부적으로는 다음 내용이 `~/.copilot/mcp-config.json` 파일에 기록됩니다. - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -4. MCP server 목록을 확인해 서버가 등록되어 활성 상태인지 검증합니다. - - ```text - /mcp show - ``` - -5. 기본 제공 `github` server와 함께 `playwright`가 표시되어야 합니다. - -> [!NOTE] -> Tailspin Toys 프로젝트는 이미 end-to-end 테스트에 Playwright를 사용하므로, Playwright에 필요한 브라우저가 대체로 이미 설치되어 있습니다. 나중에 Copilot이 브라우저가 없다고 보고하면 `npx playwright install chromium`를 실행하도록 요청한 뒤 다시 시도합니다. - -## 웹 사이트 시작하기 - -Playwright MCP server가 테스트를 수행하려면 실행 중인 앱이 필요합니다. Copilot CLI에서 작업하는 동안 계속 실행되도록 **별도의** 터미널에서 Astro dev server를 시작합니다. - -1. Ctrl+`를 선택해 코드스페이스에서 새 터미널을 엽니다. -2. 웹 사이트를 시작합니다. - - ```bash - npm run dev - ``` - -3. 이 터미널은 계속 실행된 상태로 둡니다. `Astro server: http://localhost:4321` 배너가 표시되면 앱이 준비된 것입니다. - -## 필터링 기능 테스트하기 - -Copilot CLI 세션으로 돌아가 Copilot에 기능 테스트를 요청합니다. - -[Playwright MCP server][playwright-mcp-server]는 Copilot이 실제 브라우저를 제어할 수 있게 해줍니다. 직접 앱을 눌러 보며 작업을 확인하는 대신, agent가 페이지를 열고, 탐색하고, 필터를 적용하고, 결과를 다시 읽어 준 다음, 본 내용을 요약할 수 있습니다. 대화를 벗어나지 않고 기능이 기대대로 동작하는지 확인하는 가장 빠른 방법입니다. - -내부적으로 Playwright MCP server는 스크린샷이 아니라 페이지의 [accessibility tree][playwright-mcp-server]를 기반으로 동작합니다. 즉, agent는 보조 기술이 처리하는 방식과 유사하게 구조화되고 레이블이 지정된 요소(버튼, 링크, 목록 항목)를 기준으로 추론합니다. 따라서 빠른 기능 점검이 가벼운 접근성 sanity check 역할도 함께 합니다. - -서버가 연결되고 앱이 실행 중인 상태에서 Copilot에게 방금 만든 필터링 기능을 검증해 달라고 요청합니다. - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -Copilot은 Playwright MCP server를 통해 브라우저를 실행하고, 각 단계를 수행한 뒤, 확인한 내용을 보고합니다. 요약 내용을 issue의 acceptance criteria와 비교해 보고, 어긋나는 부분이 있으면 후속 질문을 하거나 pull request를 열기 전에 코드를 수정하도록 다시 요청합니다. - -> [!NOTE] -> 이 테스트를 수행하려면 앱이 `http://localhost:4321`에서 실행 중이어야 합니다. Dev server를 중지했다면 프롬프트를 보내기 전에 다시 시작합니다. Copilot이 처음으로 Playwright MCP server를 사용할 때 브라우저를 다운로드해야 할 수도 있습니다. 브라우저가 없다고 보고하면 `npx playwright install chromium`를 실행하도록 요청한 뒤 다시 시도합니다. - -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -## 요약 및 다음 단계 - -축하합니다. Copilot CLI에서 Playwright MCP server를 사용해 기능을 수동으로 테스트했습니다. 정리하면 다음을 수행했습니다. - -- Model Context Protocol(MCP)이 무엇인지 학습하고, MCP server가 Copilot CLI를 어떻게 확장하는지 살펴보았습니다. -- `/mcp add`로 Playwright MCP server를 추가했습니다. -- 기능을 배포하기 전에 Copilot에게 브라우저를 제어해 필터링 기능을 검증하도록 요청했습니다. - -이제 기능이 동작함을 확인했으니, 다음 연습으로 이동해 [에이전트 스킬의 도움을 받아 pull request를 열 수 있습니다][next-lesson]. - -## 리소스 - -- [MCP가 대체 무엇이고 왜 모두가 이야기할까요?][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [Copilot CLI용 MCP server 추가하기][cli-add-mcp] -- [GitHub MCP Server][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers diff --git a/docs/ko-kr/cli/5-agent-skills.md b/docs/ko-kr/cli/5-agent-skills.md index 48c8f6bb..665446a1 100644 --- a/docs/ko-kr/cli/5-agent-skills.md +++ b/docs/ko-kr/cli/5-agent-skills.md @@ -1,119 +1,99 @@ --- -title: "연습 5 - 에이전트 스킬 사용하기" +title: "연습 5 - quality-checks 스킬 만들기 및 사용" +description: "재사용 가능한 셸 스크립트 기반 품질 검사를 Copilot에 요청하고, 스킬을 검토한 후 필터링 브랜치에서 실행합니다." authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -앱 개발에는 빌드 생성, 테스트 실행, pull request 작성처럼 반복 가능한 작업이 자주 포함됩니다. **에이전트 스킬(Agent Skills)**을 사용하면 Copilot과 다른 AI agent에 이러한 작업을 수행하는 방법에 대한 가이드를 제공할 수 있습니다. 스킬은 agent가 필요할 때 불러올 수 있는 지침, 스크립트, 리소스 폴더입니다. [Agent Skills는 오픈 표준][agent-skills-repo]이며, 여러 agent에서 사용됩니다. 따라서 동일한 스킬을 Copilot Chat in agent mode, Copilot cloud agent, Copilot CLI, GitHub Copilot app 전반에서 사용할 수 있습니다. +필터링 기능을 구현하고 기존 npm 명령으로 검사했습니다. 이제 이러한 검사를 재사용 가능한 **에이전트 스킬**로 묶습니다. 연습 4~8에서 동일한 필터링 세션과 브랜치를 유지합니다. 이 연습에서는 끌어오기 요청을 만들지 않습니다. -스킬은 프로젝트의 `.github/skills` 폴더 또는 전역 `~/.copilot/skills`에 저장됩니다. 각 스킬은 YAML frontmatter(`name`과 `description`)가 포함된 `SKILL.md` 파일과 그 뒤에 이어지는 markdown 지침으로 구성된 폴더입니다. +이 연습에서는 다음을 수행합니다. -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +- 사용자 지정을 만들기 전에 **Interactive** 모드로 돌아옵니다. +- Copilot에 `quality-checks`를 만들고 검토를 위해 중단하도록 요청합니다. +- 함께 제공되는 스크립트로 네 가지 검사를 모두 실행하고, 단일 테스트 파일을 지정하는 인수가 해당 파일만 선택함을 입증합니다. +- 필터링 기능과 함께 스킬의 체크포인트를 저장합니다. -스킬에는 스크립트, asset, 참고 자료를 담은 하위 폴더도 포함될 수 있습니다. 전체 구조는 [agent skills specification][agent-skills-spec]에서 다룹니다. +## 시나리오 -> [!TIP] -> 스킬은 동적으로 로드됩니다. 어떤 스킬이 적용되는지는 agent가 `description` 필드를 기준으로 판단합니다. 시나리오별로 명확한 설명이 있어야 실제로 사용되는 스킬이 되고, 그렇지 않으면 무시될 수 있습니다. +Tailspin Toys는 필터링이 변경될 때마다 동일한 품질 검사가 필요합니다. 팀은 대화마다 명령과 필수 조건을 설명하는 대신 재사용 가능한 스킬을 원합니다. 스킬을 만들고 스크립트를 검토한 후 다른 요청에서도 검사를 올바르게 실행할 수 있는지 확인합니다. -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification -이제 스킬이 팀의 사양에 맞는 pull request를 보장하는 방법을 살펴보겠습니다. +## 지침, 스크립트, 리소스 -## 시나리오 +스킬은 에이전트가 필요할 때 불러오는 재사용 가능한 작업 지침, 실행 가능한 스크립트, 보조 리소스를 묶습니다. 사용자 지정 에이전트는 전문 역할, 지침, 사용 가능한 도구를 정의합니다. 두 방식은 상호 보완적입니다. 사용자 지정 에이전트도 스킬에 포함된 스크립트를 비롯한 스크립트를 실행할 수 있습니다. -팀에는 pull request(PR)에 대한 다음 요구 사항이 있습니다. +리포지토리 스킬은 `.github/skills//SKILL.md`에 있으며 `name`과 `description` 프런트매터 및 Markdown 지침을 포함합니다. 스크립트와 다른 리소스는 그 옆에 둡니다. 완성된 답을 복사하지 않고 Copilot에 `.github/skills/quality-checks/SKILL.md`와 함께 제공되는 스크립트를 생성하도록 요청합니다. [Agent Skills 명세][skill-spec]에서 형식을 설명합니다. -- 명확한 커밋 메시지를 사용하고, 파일은 논리적으로 그룹화해야 합니다. -- PR을 만들기 전에 모든 테스트가 통과해야 합니다. -- 각 PR에는 다음 섹션이 포함되어야 합니다. - - 변경이 필요한 이유에 대한 설명 - - 변경된 파일 개요 - - 중요한 코드 블록 스니펫 - - 수행한 변경 사항을 묶어 설명하는 세부 내용 +Copilot은 발견한 스킬의 설명으로 언제 불러올지 판단합니다. 이미 열린 세션에서 새 스킬을 즉시 발견한다고 가정하지 않습니다. 실행 절에서는 명시적으로 읽는 대체 절차를 제공합니다. 이식 가능한 형식이라고 해서 셸이나 프로젝트 필수 조건이 없어지지는 않습니다. -팀은 Copilot으로 코드와 PR을 생성하고 있으므로, AI 도구가 이러한 요구 사항을 따르도록 보장하고 싶어 합니다. +## 스킬 만들기 -이 연습에서는 다음을 수행합니다. +프롬프트를 보내기 전에 **Interactive** 모드로 돌아옵니다. 현재 체크아웃과 브랜치를 유지합니다. 이 스킬이 이미 있는 이전 템플릿으로 시작했다면 사용자 지정을 덮어쓰지 말고 검토하여 확장합니다. -- Pull request 생성을 위한 기존 스킬을 살펴봅니다. -- AI agent가 스킬을 활용하는 방식을 학습합니다. -- 스킬의 도움으로 가이드라인에 맞는 PR을 만듭니다. +```plaintext +.github/skills/quality-checks/SKILL.md와 npm run lint, npm run test:unit, npm run test:e2e, npm run typecheck:all을 호출하는 스크립트 4개를 만들어 주십시오. 먼저 package.json, README, 테스트 설정, 리포지토리 지침을 읽어 주십시오. -## 스킬 실행하기 +현재 환경을 감지해 주십시오. macOS/Linux/WSL이면 Bash .sh 스크립트만, 네이티브 Windows이면 PowerShell .ps1 스크립트만 만들고, 확실하지 않으면 질문해 주십시오. 두 가지 모두 만들지 마십시오. 래퍼는 자신의 위치에서 리포지토리 루트를 찾고, 그곳에 이 프로젝트의 package.json이 있는지 검증한 후 npm을 호출하는 역할로 제한해 주십시오. 루트가 잘못되면 명확한 오류와 함께 실패하도록 해 주십시오. 어떤 작업 디렉터리와 공백이 있는 경로에서도 작동해야 합니다. 출력과 실패 종료 코드를 유지하고 PowerShell 네이티브 명령 실패도 처리해 주십시오. npm의 -- 구분자는 정확히 한 번만 삽입하고, 호출자는 추가 -- 없이 도구의 인수를 직접 전달하도록 해 주십시오. 포트나 프로세스를 관리하지 마십시오. -스킬은 agent가 필요하다고 판단할 때 동적으로 로드됩니다. 어떤 스킬을 사용할지는 `SKILL.md` 파일의 설명에 따라 결정됩니다. 따라서 스킬의 사용 사례를 정의하는 명확한 설명을 작성하는 것이 중요합니다. +SKILL.md에 name과 description 프런트매터, 래퍼 4개를 실행하는 지침, 필수 조건, 문제 해결 방법, 기존 단위 테스트 파일 하나를 사용하는 예시를 포함한 이식 가능한 호출 예시를 작성해 주십시오. 모든 Bash 예시는 bash를 명시적으로 호출해야 하며, PowerShell 실행 정책은 절대 우회하지 마십시오. Playwright 서버 재사용을 설명하고, 실제로 직접 시작한 서버만 중지하며 그렇지 않으면 질문하도록 해 주십시오. -## PR 스킬 살펴보기 +스킬과 필요한 스크립트만 만들어 주십시오. 검사나 탐색용 실행을 하거나, 무언가를 설치하거나, 애플리케이션 코드를 변경하거나, 커밋하거나, PR을 열지 마십시오. 검토할 수 있도록 중단해 주십시오. +``` -Tailspin Toys에는 PR 생성에 대한 요구 사항이 있으므로, AI 도구가 이러한 가이드라인을 따르는 PR을 생성할 수 있도록 도와주는 스킬을 만들었습니다. 이 스킬이 무엇을 하는지 이해하기 위해 내용을 살펴보겠습니다. +## 스킬 검토 -1. `.github/skills/make-contribution/SKILL.md`를 엽니다. -2. 이름과 설명을 확인합니다. 설명이 pull request 생성 또는 코드 커밋 요청이 있을 때 사용해야 하는 시나리오를 어떻게 강조하는지 확인합니다. -3. 스킬 내용을 읽어 봅니다. 브랜치 생성 방식, 커밋 생성 방식, pull request 내용에 관한 규칙이 정의되어 있음을 확인합니다. +1. 편집기에서 `.github/skills/quality-checks/SKILL.md`와 함께 제공되는 스크립트를 열고 diff를 확인합니다. +2. `name`과 `description`이 스킬과 적용 시점을 설명하는지 확인합니다. 메타데이터뿐 아니라 지침도 읽습니다. +3. 실행 순서가 lint, 단위 테스트, E2E, 타입 검사를 위해 `.github/skills/quality-checks/` 아래에 함께 제공되는 스크립트를 실제로 호출하는지 확인합니다. +4. 각 래퍼에서 스크립트 위치 기반 루트 탐색과, 찾은 디렉터리에 이 체크아웃에서 의도한 `package.json`이 있는지 명시적으로 확인하는 절차를 살펴봅니다. npm이 상위 디렉터리를 검색하여 명령이 성공한 것은 루트가 올바르다는 증거가 아닙니다. 경로의 따옴표 처리, 인수 전달, 출력 표시, 실패 종료를 확인합니다. PowerShell은 네이티브 npm 실패를 전달해야 합니다. +5. 문서화된 단일 단위 테스트 파일 실행 예시를 확인합니다. 래퍼가 npm의 `--` 구분자를 삽입하므로 호출자는 다른 구분자 없이 대상 도구의 인수를 직접 전달합니다. 재사용 가능한 지침에는 특정 컴퓨터의 절대 체크아웃 경로를 포함하지 않습니다. 실행 전에 부족한 부분을 수정하도록 Copilot에 요청합니다. +6. 스크립트는 루트/매니페스트 검증과 기존 npm 검사 실행으로 제한합니다. 포트와 프로세스에 관한 판단은 셸 프로세스 관리 코드가 아니라 SKILL.md에 둡니다. 에이전트가 실제로 시작한 서버만 중지할 수 있는지 확인합니다. 작업 디렉터리나 프로세스 이름이 일치한다고 소유권이 성립하지는 않습니다. 제공한 파일에는 스킬, 필수 래퍼, 필요한 공유 헬퍼만 포함하고 임시 조사 파일이나 디버그 파일은 포함하지 않습니다. -## 스킬 사용하기 +> [!NOTE] +> 현재 Tailspin Toys에는 Node.js 22.13 이상, 프로젝트 의존성, E2E 검사용 Playwright Chromium이 필요합니다. 체크아웃의 README와 `package.json`에서 필수 조건을 확인합니다. 누락된 필수 조건이나 PowerShell 실행 정책에 의한 차단은 승인된 방법으로 해결해야 합니다. 자동 설치, 정책 우회, 알리지 않고 직접 npm으로 전환하는 방식으로 해결하지 않습니다. -앞서 강조했듯이 스킬은 Copilot CLI가 자동으로 호출합니다. 따라서 Copilot에게 PR 생성을 요청하기만 하면 됩니다. +## 스킬 실행 -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. +이전 연습의 개발 서버가 중지되었는지 확인합니다. Playwright는 E2E를 위해 빌드하고 미리 보기를 제공하지만, 로컬 설정은 포트 `4321`의 서버를 재사용할 수 있습니다. 다른 체크아웃의 서버는 이 기능의 유효한 근거가 아닙니다. -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. +Copilot CLI에 `/quality-checks`가 표시되면 선택하여 발견된 스킬을 명시적으로 호출하고 아래 요청을 포함합니다. 발견되지 않았다면 이 세션에서 동일한 요청을 직접 보냅니다. 이 연습에서는 스킬을 읽는 방법을 대체 절차로 사용할 수 있습니다. -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. 다음 프롬프트를 사용해 Copilot에게 PR 생성을 요청합니다. +```plaintext +.github/skills/quality-checks/SKILL.md를 읽고 지침에 따라 이 체크아웃의 필터링 기능을 검증해 주십시오. 먼저 각 래퍼의 코드를 검토하여 npm의 상위 디렉터리 패키지 탐색에 의존하지 않고, 이 체크아웃에서 의도한 package.json을 포함하는 디렉터리를 찾으며, 잘못된 루트에서는 명시적으로 실패하도록 처리하는지 확인해 주십시오. 실패를 재현하기 위해 리포지토리 파일을 이동하거나 이름을 바꾸거나 삭제하거나 수정하지 마십시오. 함께 제공되는 lint, 단위 테스트, 엔드투엔드 테스트, 타입 검사 스크립트를 실제로 실행해 주십시오. 문서화된 단일 단위 테스트 파일 실행 예시도 실행하되, npm의 -- 구분자는 래퍼가 담당하므로 대상 도구의 인수를 직접 전달해 주십시오. 테스트 러너의 결과에서 지정한 파일만 실행되었는지 확인하고, 해당 파일명과 실행된 테스트 파일 수를 보고해 주십시오. 인수를 출력하거나 종료 코드 0을 반환하는 것만으로는 올바른 선택을 증명하지 못합니다. - ``` - Can you please create a pull request for me! - ``` +실패, 건너뛴 검사, 누락된 필수 조건을 포함하여 각 스크립트 호출과 결과를 보고해 주십시오. 사용할 수 없는 스킬 스크립트를 알리지 않고 직접 npm 명령으로 대체하지 마십시오. 테스트할 체크아웃과 서버를 식별하고 직접 시작한 서버만 중지하며, 설치하거나 다른 프로세스를 중지하기 전에 질문해 주십시오. 애플리케이션 코드나 브랜치를 변경하거나 커밋, 푸시, 끌어오기 요청 생성을 하지 마십시오. +``` -2. Copilot이 요청을 확인합니다. 잠시 후 Copilot이 **make-contribution** 스킬을 사용 중이라고 표시하는 것을 확인할 수 있습니다. +도구 호출과 출력을 확인합니다. 네 스크립트가 모두 실제로 실행되어야 합니다. 검사 설명이나 건너뛴 검사는 통과가 아닙니다. 단일 파일 예시에서는 요청한 파일명을 러너의 실제 파일별 결과 및 보고한 수와 비교합니다. 해당 파일만 실행되어야 합니다. 다른 파일도 실행되었다면 인수 출력이나 종료 코드 0만으로는 충분하지 않습니다. 실패는 유용한 근거입니다. 스킬을 수정하거나 승인받아 설정 차단 요인을 해결한 다음 영향을 받는 검사를 다시 실행합니다. 관련 없는 프로세스를 중지하거나 포트 충돌을 강제로 없애지 않습니다. -3. Copilot은 이어서 스킬의 지침을 따릅니다. 먼저 테스트를 실행한 뒤 브랜치, 커밋, 그리고 최종적으로 PR을 생성합니다. -4. PR이 생성되면 리포지토리로 돌아가 PR을 엽니다. 섹션이 스킬에 정의된 가이드라인을 따르고 있으며, 팀이 제시한 요구 사항과 일치하는지 확인합니다. -5. 다음 연습으로 넘어가기 전에 이 필터링 PR과 접근성 작업을 분리하기 위해 로컬 작업 공간을 `main`에서 새 브랜치로 초기화합니다. +## 체크포인트 저장 - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +스킬과 결과를 검토한 후 로컬 체크포인트를 승인합니다. + +```plaintext +현재 diff를 검토하고 quality-checks 스킬 파일만 포함한 체크포인트 커밋을 만들어 주십시오. 기존 필터링 브랜치를 유지해 주십시오. 푸시하거나 끌어오기 요청을 만들지 마십시오. +``` ## 요약 및 다음 단계 -에이전트 스킬의 도움으로 문서화된 요구 사항을 충족하는 새로운 PR을 만들었습니다. 다음을 수행했습니다. +재사용 가능한 quality-checks 스킬을 만들고 검토했으며 단일 파일 테스트 예제를 포함해 실행했습니다. 스킬 파일은 연습 8의 기능 PR에 필터링, QA 프로필, 관련 테스트와 함께 포함됩니다. 동일한 체크아웃에서 [연습 6 - Playwright MCP로 기능 검증][next-lesson]을 계속합니다. -- Pull request 생성을 위한 기존 스킬을 살펴보았습니다. -- AI agent가 스킬을 활용하는 방식을 학습했습니다. -- 스킬의 도움으로 가이드라인에 맞는 PR을 만들었습니다. +## 더 많은 스킬 예제 -스킬은 특정 작업에 적합하지만, 더 강력한 작업을 수행하려면 [custom agents][next-lesson]를 활용해야 합니다. 다음으로 이를 살펴보겠습니다. +이 커뮤니티 예제는 참고 자료이며 추가 작업이 아닙니다. 채택하기 전에 필수 조건과 동작을 검토합니다. -## 리소스 +- [기여 워크플로: `make-repo-contribution`][contribution-example]. +- [요구 사항 문서: `prd`][prd-example]. +- [다이어그램과 함께 제공되는 내보내기 스크립트: `drawio`][drawio-example]. +- [브라우저 테스트: `webapp-testing`][browser-example]. -- [에이전트 스킬 소개][about-agent-skills] -- [Agent Skills Specification][agent-skills-spec] -- [Agent Skills Repository][agent-skills-repo] -- [Awesome-copilot의 Agent Skills][awesome-copilot-skills] +업스트림 기여 예제의 이름은 `make-repo-contribution`이며, 이전 Tailspin 템플릿은 `make-contribution`이라는 다른 이름을 사용했습니다. 이 워크숍은 두 기여 스킬 중 어느 것에도 의존하지 않습니다. -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/ko-kr/cli/6-custom-agents.md b/docs/ko-kr/cli/6-custom-agents.md deleted file mode 100644 index ddb510e4..00000000 --- a/docs/ko-kr/cli/6-custom-agents.md +++ /dev/null @@ -1,113 +0,0 @@ ---- -title: "연습 6 - GitHub Copilot CLI로 커스텀 에이전트 사용하기" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## 커스텀 에이전트란 무엇인가요? - -GitHub Copilot의 [커스텀 에이전트][custom-agents-concept]를 사용하면 개발 워크플로 안의 특정 작업이나 도메인에 맞춘 전문 AI 도우미를 만들 수 있습니다. 리포지토리의 `.github/agents` 폴더 안에 있는 markdown 파일로 agent를 정의하면, 특정 종류의 작업을 더 효과적으로 수행하도록 Copilot을 이끄는 집중된 지침, 모범 사례, 코딩 패턴, 도메인별 지식을 제공할 수 있습니다. 팀은 전문성을 재사용 가능한 agent로 체계화할 수 있습니다. 예를 들어 [WCAG][wcag] 준수를 강제하는 접근성 agent, 보안 코딩 관행을 따르는 보안 agent, 일관된 테스트 패턴을 유지하는 테스트 agent 등을 만들 수 있습니다. - -커스텀 에이전트는 프로젝트의 `.github/agents` 폴더 또는 전역 `~/.copilot/agents`의 markdown 파일로 정의합니다. 각 파일에는 최소한 `name`과 `description`이 포함된 YAML frontmatter가 있고, 그 뒤에 agent의 동작, 전문성, 지침을 정의하는 markdown 프롬프트가 이어집니다. - -### 커스텀 에이전트와 에이전트 스킬 비교하기 - -커스텀 에이전트와 [에이전트 스킬][agent-skills-concept] 사이에는 개념적으로 겹치는 부분이 있습니다. 둘 다 주로 markdown 파일로 정의되며 AI에게 작업 수행 방법을 알려 줍니다. 가장 깔끔하게 구분하면 **커스텀 에이전트**는 작업자이고, **스킬**은 도구입니다. - -커스텀 에이전트는 자체 컨텍스트 창을 가지며, 작업을 수행하는 과정에서 스킬(심지어 다른 agent까지도)을 오케스트레이션하도록 설계됩니다. 이 실습에서 접근성 커스텀 에이전트는 접근성 가이드라인을 기준으로 사이트를 검토하고 업데이트합니다. 이 과정에서 pull request 워크플로 스킬이나 테스트 실행 및 관리를 담당하는 스킬 같은 도구를 호출할 수도 있습니다. - -> [!NOTE] -> 커스텀 에이전트를 작성하는 유일한 "정답"은 없습니다. AI의 다른 작업과 마찬가지로, 환경과 시나리오에 가장 잘 맞는 방식을 찾기 위해 테스트하고 반복해 보아야 합니다. - -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ -## 시나리오 - -많은 웹 애플리케이션이 모든 사용자에게 접근 가능하지 못하며, 지금 작업 중인 웹 사이트도 예외는 아닙니다. 커스텀 에이전트를 사용해 접근성 문제를 식별하고 해결해 보겠습니다. - -Tailspin Toys는 시각 능력이나 선호도와 관계없이 모든 사용자가 crowdfunding platform을 이용할 수 있도록 보장하는 데 전념하고 있습니다. 최근 사용자 피드백에 따르면 현재 dark theme는 텍스트와 배경색 사이의 대비가 충분하지 않아 일부 사용자가 읽기 어렵다고 느끼고 있습니다. 이 접근성 문제를 해결하기 위해 디자인 팀은 사용자가 켜고 끌 수 있는 high-contrast mode 구현을 요청했습니다. - -접근성은 매우 중요하므로 가능한 한 빠르게 구현하고 싶습니다. 커스텀 에이전트를 활용해 이 기능을 생성합니다. -이 연습에서는 다음을 수행합니다. - -- 커스텀 에이전트를 살펴봅니다. -- 커스텀 에이전트를 활성화하고 Copilot CLI를 사용해 작업을 할당합니다. - -## 접근성 커스텀 에이전트 검토하기 - -접근성을 위해 이미 커스텀 에이전트가 준비되어 있습니다. Copilot을 어떻게 안내하는지 이해하기 위해 내용을 검토해 보겠습니다. - -1. `.github/agents/accessibility.md`를 엽니다. -2. `name`과 `description` 필드가 포함된 YAML frontmatter를 확인합니다. - -> [!CAUTION] -> `name`과 `description`이 포함된 frontmatter는 커스텀 에이전트에 필수입니다. - -3. 이어지는 섹션을 훑어보며 다음 내용을 확인합니다. - - 접근 가능한 웹 사이트를 위한 코드를 생성할 때의 핵심 책임 - - 접근성 모범 사례 - - HTML, CSS, JavaScript용 코드 예시 - - 흔한 함정과 실수 목록 - -## Copilot CLI에서 커스텀 에이전트 사용하기 - -Copilot CLI에서는 `/agent` 명령으로 커스텀 에이전트를 시작할 수 있습니다. 이제 웹 사이트에 접근성 점검을 수행해 보겠습니다. - -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. - -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI의 프롬프트 창에 `/agent`를 입력하고 Enter를 눌러 agent 목록을 엽니다. -2. 사용 가능한 agent 목록에서 **Accessibility agent**를 선택합니다. -3. 다음 프롬프트를 사용해 접근성 agent에게 접근성 백로그 항목을 검토하고 수정 사항을 생성해 달라고 요청합니다. - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -4. Copilot이 작업을 시작합니다. 먼저 issue를 가져오고, 검토를 수행하고, 업데이트를 생성하고, 마지막으로 PR을 만듭니다. PR을 만들 때 프로젝트의 PR 전용 스킬을 사용하는 점도 확인할 수 있습니다. - -> [!NOTE] -> 이 과정은 몇 분 정도 걸릴 수 있습니다. 지금까지 학습한 내용을 되돌아보거나, 음료를 즐기거나, Copilot CLI에서 사용할 수 있는 추가 명령을 다루는 다음 모듈을 미리 살펴보기에 좋은 시간입니다. - -## 요약 및 다음 단계 - -이 연습에서는 GitHub Copilot의 [커스텀 에이전트][custom-agents]를 살펴보았습니다. 커스텀 에이전트는 특정 작업과 도메인에 맞춘 전문 AI 도우미입니다. 커스텀 에이전트를 사용하면 팀의 전문성과 표준을 재사용 가능한 agent로 체계화해 Copilot이 특정 유형의 작업을 더 효과적으로 수행하도록 안내할 수 있습니다. - -다음 개념을 살펴보았습니다. - -- 커스텀 에이전트가 어떻게 정의되는지 -- Copilot CLI에서 커스텀 에이전트를 사용하는 방법 - -다음으로는 [몇 가지 slash commands][next-lesson]를 살펴보며 Copilot CLI의 추가 팁을 알아보겠습니다. - -## 리소스 - -- [커스텀 에이전트][custom-agents] -- [리포지토리용 커스텀 에이전트 만들기][creating-custom-agents] -- [Awesome-copilot의 커스텀 에이전트][awesome-copilot-agents] -- [조직에서 커스텀 에이전트를 사용하기 위한 준비][org-custom-agents] -- [엔터프라이즈에서 커스텀 에이전트를 사용하기 위한 준비][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents diff --git a/docs/ko-kr/cli/6-mcp-playwright.md b/docs/ko-kr/cli/6-mcp-playwright.md new file mode 100644 index 00000000..1f04aec4 --- /dev/null +++ b/docs/ko-kr/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "연습 6 - Playwright MCP로 기능 검증" +description: "MCP로 브라우저를 연결하고 관찰한 필터링 동작을 이슈 및 승인된 계획과 비교합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +필터링 구현과 quality-checks 스킬은 이미 자동 검증을 거쳤습니다. 이제 Copilot에 브라우저를 제공하고 기능을 직접 관찰하도록 요청합니다. 이 연습은 **Model Context Protocol(MCP)** 상호 작용을 실증하며, 전체 테스트 스위트를 다시 실행하는 과정이 아닙니다. + +동일한 필터링 체크아웃과 브랜치에서 **Interactive** 모드를 유지합니다. MCP 설정으로 새 기능 마일스톤을 시작하지 않습니다. + +이 연습에서는 다음을 수행합니다. + +- Playwright MCP를 연결하고 브라우저 도구를 사용할 수 있는지 확인합니다. +- 실제 필터링 동작을 이슈 및 승인한 기준과 비교합니다. +- 관찰 결과를 검토하고 직접 시작한 개발 서버를 중지합니다. + +## 시나리오 + +자동 검사는 통과했지만 Tailspin Toys에는 방문자 경험에 대한 근거도 필요합니다. Copilot에 브라우저 도구를 제공하여 필터를 조작하고 표시된 게임을 합의한 동작과 비교합니다. 컨트롤이 반응한다는 사실만으로 필터링이 제대로 작동한다고 판단하지 않습니다. + +## MCP가 추가하는 기능 + +[MCP][mcp-overview]는 서버를 통해 에이전트를 외부 도구와 컨텍스트에 연결합니다. 기본 제공 GitHub MCP 서버로 이슈와 PR을 다룰 수 있습니다. [Playwright MCP 서버][playwright-mcp]는 페이지 열기, 접근성 요소 확인, 탐색, 컨트롤 조작을 위한 브라우저 도구를 제공합니다. + +브라우저의 접근성 스냅샷은 에이전트가 컨트롤을 식별하는 데 도움이 되지만 완전한 접근성 준수를 증명하지는 않습니다. 일반적인 “좋아 보입니다”라는 응답을 수락하지 말고 실제 작업과 관찰을 이슈 요구 사항과 비교합니다. + +> [!CAUTION] +> MCP 서버를 프로젝트 의존성처럼 다룹니다. 활성화 전에 게시자, 소스, 권한, 패키지 다운로드를 검토합니다. 조직 정책이 실행 가능한 서버를 제한할 수 있습니다. 커밋하는 설정에 자격 증명을 넣거나 연습을 끝내기 위해 알 수 없는 도구를 승인하지 않습니다. + +## Playwright MCP 설정 + +1. 기존 CLI 세션에서 `/mcp`를 입력해 설정된 서버를 확인합니다. 작동하는 Playwright 설정이 있다면 중복 추가하지 말고 재사용합니다. +2. 필요하면 `/mcp add`를 입력하고 Tab으로 양식을 이동합니다. +3. **Server Name**은 `playwright`, **Server Type**은 **STDIO**(또는 **Local**), **Command**는 `npx @playwright/mcp@latest --headless`로 설정합니다. +4. 검토한 이 브라우저 서버의 **Tools**를 `*`로 설정합니다. 도구를 사용할 수 있게 하지만 CLI의 권한 제어를 대체하지는 않습니다. +5. 패키지와 시작 명령을 검토한 후 Ctrl+S로 저장합니다. 등록하면 서버가 시작되며 패키지를 다운로드할 수 있습니다. 설정 내용을 이해하고 승인하며 패키지 프롬프트에 응답합니다. +6. `/mcp show playwright`를 입력하고 서버가 연결되었으며 브라우저 도구를 사용할 수 있는지 확인합니다. + +헤드리스 브라우저는 데스크톱 창이 필요하지 않아 Codespaces에 적합합니다. 대화형 추가 절차는 `~/.copilot/mcp-config.json`에 설정을 저장하고 CLI를 재시작하지 않아도 서버를 사용할 수 있게 합니다. 이는 사용자 설정이며 기능 PR에 포함할 파일이 아닙니다. [MCP 설정 가이드][mcp-setup]에서 필드와 설정 소스를 설명합니다. + +> [!NOTE] +> 프로젝트 E2E 의존성과 MCP 브라우저는 관련이 있지만 다른 설정이 필요할 수 있습니다. 브라우저나 시스템 의존성이 없다면 실제 오류를 확인하고 승인받아 해당 필수 조건을 해결합니다. 브라우저를 자동으로 설치하거나 서버 연결만으로 브라우저 실행이 가능하다고 판단하지 않습니다. + +## 올바른 앱 시작 + +동일한 필터링 체크아웃에서 별도 터미널을 엽니다. 디렉터리와 브랜치를 확인한 후 앱을 시작합니다. + +```bash +pwd +git branch --show-current +npm run dev +``` + +서버 출력에서 실제 로컬 URL을 확인합니다. 코드스페이스에서는 MCP 서버와 앱이 같은 환경에서 실행되므로, 전달된 브라우저 URL이 필요하다고 가정하지 말고 보통 `http://localhost:4321`인 로컬 URL을 사용합니다. + +포트가 사용 중이거나 Astro가 다른 포트를 선택하면 서버 소유자를 식별한 후 진행합니다. 알 수 없는 서버를 재사용하거나 종료하지 않습니다. 방금 시작한 프로세스의 URL을 사용하고 테스트하는 동안 해당 터미널을 열어 둡니다. + +## 필터링 동작 관찰 + +플레이스홀더를 실제 이슈 URL, 연습 4에서 승인한 추가 합의 사항, 앱 URL로 바꿉니다. + +```plaintext +설정된 Playwright MCP 서버를 사용하여 다음 이슈에 맞게 필터링 기능을 검증해 주십시오: . 계획 중 승인한 추가 합의 사항은 다음과 같습니다: <합의한 추가 내용을 붙여 넣거나 없으면 none 입력>. 이 체크아웃의 앱은 에서 실행 중입니다. 결과를 신뢰하기 전에 테스트할 체크아웃, 브랜치, 서버를 확인해 주십시오. + +게임 페이지를 열고 필터링되지 않은 상태를 기록한 다음, 하나의 카테고리와 여러 카테고리를 차례로 선택하고, 퍼블리셔 필터를 적용하며, 카테고리와 퍼블리셔 선택을 조합해 주십시오. 승인한 기준에 따라 필터 해제와 빈 결과 동작을 확인해 주십시오. 컨트롤 레이블, 키보드 조작, 보이는 포커스를 확인해 주십시오. 표시된 결과를 선택한 필터 및 원본 데이터와 비교하고, 컨트롤이 바뀌었다는 이유만으로 성공을 추론하지 마십시오. + +실제 브라우저 도구를 조작하고 각 기준에서 관찰한 내용을 보고하며 실패나 누락된 근거를 명확히 표시해 주십시오. 이 브라우저 연습만을 위해 전체 테스트 스위트를 다시 실행하거나 애플리케이션 코드를 변경하거나 테스트나 사용자 지정을 만들거나 브랜치를 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. 설치하거나 다른 프로세스를 중지하기 전에 질문해 주십시오. +``` + +브라우저 도구 호출과 보고서를 확인합니다. Copilot이 실제로 여러 카테고리를 선택하고 퍼블리셔와 조합했습니까? 반환된 게임이 합의한 동작과 일치합니까? 보고서가 관찰 가능한 브라우저 동작을 데이터 계층 및 자동 테스트 커버리지와 구분합니까? + +실패하면 관찰한 동작을 기록합니다. 범위를 좁힌 애플리케이션 수정은 별도로 승인하고, 영향을 받는 브라우저 검사와 자동 검사를 반복합니다. 구현에 맞춰 수락 기준을 바꾸거나 오래된 근거를 변경된 코드의 검증으로 계산하지 않습니다. + +## 직접 시작한 서버 중지 및 계속 진행 + +개발 서버를 시작한 터미널에서 Ctrl+C로 서버를 중지합니다. Playwright MCP 설정은 계속 사용할 수 있도록 유지합니다. 연습 7에서는 최신 브라우저 관찰과 자동 E2E 검사를 조율합니다. 오래된 개발 서버나 다른 체크아웃의 앱을 재사용해서는 안 됩니다. + +## 요약 및 다음 단계 + +QA 프로필을 만들기 전에 **Interactive**를 유지합니다. 다른 PR이나 브랜치를 만들지 않고 브라우저 동작을 관찰했습니다. 다음에는 [QA 에이전트를 만들어 사용하여][next-lesson] 요구 사항, 커버리지, 스킬, 최종 근거를 통합합니다. + +## 리소스 + +- [Copilot CLI에 MCP 서버 추가][mcp-setup]에서는 설정과 관리를 설명합니다. +- [Microsoft Playwright MCP][playwright-mcp]에서는 브라우저 설정과 도구를 설명합니다. +- [GitHub MCP 레지스트리][mcp-registry]에는 평가할 수 있는 다른 서버가 나열되어 있습니다. + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/ko-kr/cli/7-qa-agent.md b/docs/ko-kr/cli/7-qa-agent.md new file mode 100644 index 00000000..f0c54640 --- /dev/null +++ b/docs/ko-kr/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "연습 7 - QA 에이전트 만들기 및 사용" +description: "테스트 커버리지, quality-checks 스킬, 직접 관찰한 브라우저 근거를 통합하는 요구 사항 우선 QA 프로필을 만듭니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +반복 가능한 검사를 실행하고 Playwright MCP로 필터링을 살펴봤습니다. 이제 **QA 사용자 지정 에이전트**를 만들어 요구 사항, 커버리지, 브라우저 근거를 통합합니다. 필터링 세션, 체크아웃, 브랜치를 유지합니다. 기능 PR은 연습 8에서 만듭니다. + +이 연습에서는 다음을 수행합니다. + +- 요구 사항 우선 QA 프로필을 만들고 검토합니다. +- 프로필을 선택하여 커버리지, 검사 결과, 브라우저 근거를 검토합니다. +- 일반 에이전트로 돌아가 프로필과 필요한 테스트의 체크포인트를 저장합니다. + +## 시나리오 + +Tailspin Toys는 필터링 출시를 준비하고 있습니다. 테스트 통과만으로 합의한 모든 요구 사항을 다뤘는지는 알 수 없습니다. 팀은 이슈와 구현을 비교하고 공백을 찾아 검토 준비 여부를 설명하는 집중적인 검토가 필요합니다. QA 프로필은 사람의 판단을 대체하지 않고 이 평가를 안내합니다. + +## QA 프로필 만들기 + +**Interactive** 모드를 유지합니다. 프로필은 전문가의 역할과 지침을 정의하며, 스킬은 재사용 가능한 작업 지침, 스크립트, 리소스를 묶습니다. QA 에이전트는 스킬과 설정된 MCP 도구를 대체하지 않고 사용합니다. + +다음 프롬프트를 보낸 후 실행 전에 정의를 확인합니다. + +```plaintext +.github/agents/qa.agent.md에 재사용 가능한 QA 사용자 지정 에이전트를 만들어 주십시오. 먼저 리포지토리 지침, package.json, 테스트 설정, .github/skills/quality-checks/SKILL.md를 확인해 주십시오. 프로필에 유효한 YAML 프런트매터를 제공하고 name은 QA로, description은 사용할 시점을 설명하도록 설정해 주십시오. 모델을 고정하거나 tools 목록을 추가하지 말고 해당 환경에서 사용할 수 있는 도구와 권한을 상속해 주십시오. 에이전트 정의만 만든 다음 실행 전에 검토할 수 있도록 중단해 주십시오. + +에이전트 지침에서 모든 QA 작업을 이슈와 사용자가 제공한 승인된 수락 기준으로 시작하도록 요구해 주십시오. 구현이 아니라 이러한 요구 사항을 기준으로 삼아 주십시오. 요구 사항이 누락되거나 모호하면 질문해 주십시오. 기능과 기존 테스트를 확인하고 각 기준을 적절한 자동 테스트 커버리지 및 관찰 가능한 동작과 연결해 주십시오. + +설정된 Playwright MCP 서버를 통한 직접 브라우저 검증과 기존 quality-checks 스킬 및 함께 제공되는 스크립트를 통한 lint, 단위 테스트, 엔드투엔드 테스트, 타입 검사 실행을 요구해 주십시오. 스킬이 자동으로 발견되지 않았다면 명시적으로 읽어 주십시오. 스킬, MCP 도구, 필수 조건, 액세스가 없으면 차단된 상태로 보고해 주십시오. 알리지 않고 다른 워크플로로 대체하거나 건너뛴 검사를 통과로 표시하지 마십시오. 테스트할 체크아웃과 서버를 식별하고, 다른 워크트리의 서버를 재사용하지 않으며, 에이전트가 시작한 서버만 중지하고, 설치하거나 다른 프로세스를 중지하기 전에 질문해 주십시오. + +리포지토리 지침에 따라 실제 커버리지 공백에 필요한 최소 테스트를 QA 에이전트가 추가할 수 있도록 해 주십시오. 커버리지가 이미 충분하다면 추가 테스트가 없어도 타당합니다. 검증을 약화하거나 실패하는 테스트를 비활성화하거나 코드에 맞춰 수락 기준을 바꾸거나 제 승인 없이 애플리케이션 코드를 수정하지 마십시오. 변경 후 영향을 받는 검사를 다시 실행하고 변경된 리비전의 최종 검증을 완료해 주십시오. 각 기준을 근거와 통과/실패/차단 상태에 연결하고, 추가한 테스트 또는 추가할 필요가 없었던 이유, 네 가지 검사 결과, 해결되지 않은 결함을 포함하는 간결한 보고서를 요구해 주십시오. GO에는 모든 필수 검사와 근거가 필요하며, 그렇지 않으면 이유와 함께 NO-GO를 보고해야 합니다. QA 중에는 브랜치를 변경하거나 커밋, 푸시, PR 생성 또는 병합을 하거나 추가 에이전트나 스킬을 만들지 마십시오. +``` + +## 프로필 검토 + +편집기에서 `.github/agents/qa.agent.md`를 열고 diff를 확인합니다. `description`은 필수이며, 이 연습에서는 읽기 쉬운 `name`으로 `QA`도 제공합니다. 고정된 `model`이나 임의로 만든 도구 목록이 없는지 확인합니다. `tools`를 생략하면 사용 가능한 도구를 상속하지만 해당 환경의 권한을 우회하지는 않습니다. 프로덕션 프로필에서는 의도적으로 도구를 제한할 수 있습니다. + +지침이 요구 사항에서 시작하고, 실제 MCP 브라우저 작업과 스킬 스크립트를 요구하며, 정당한 테스트 추가만 허용하고, 차단 요인을 사실대로 보고하는지 확인합니다. 전문가 프로필이나 스킬에 별도 컨텍스트 윈도 또는 다른 에이전트의 오케스트레이션이 필수인 것은 아닙니다. + +## 이슈에 대한 QA 실행 + +실행 프롬프트는 프로필을 읽는 기본 에이전트가 아니라 선택된 **QA** 사용자 지정 에이전트를 위한 것입니다. 다른 기능 브랜치를 만들지 않고 동일한 체크아웃에서 새 CLI 대화를 시작하여 새 프로필을 불러옵니다. + +1. 필터링 이슈 URL과 승인한 추가 합의 사항을 보관합니다. 현재 에이전트가 완료될 때까지 기다린 후 `/exit`를 입력해 터미널로 돌아옵니다. +2. `git branch --show-current`와 `git status --short`로 여전히 필터링 리포지토리 디렉터리와 동일한 브랜치에 있는지 확인합니다. 브랜치를 전환하거나 워크트리를 만들지 않습니다. +3. 리포지토리 프로필로 CLI를 시작합니다. + + ```shell + copilot --agent qa + ``` + +4. 실행 전에 CLI가 **QA**를 선택된 에이전트로 표시하는지 확인합니다. [CLI 명령 참조][cli-reference]에는 `--agent`가 설명되어 있습니다. 프로필을 작성하거나 읽는 것만으로 활성화되지는 않습니다. 선택이 실패하거나 에이전트가 설정된 Playwright MCP 도구와 스킬에 액세스할 수 없다면 일시 중지하고 진행자와 차단 요인을 해결합니다. + +두 플레이스홀더를 실제 필터링 이슈 URL과 연습 4에서 승인한 추가 합의 사항으로 바꿉니다. 이슈만으로 요구 사항이 충분하다면 `none`을 사용합니다. 이전 에이전트의 기억에 의존하지 않습니다. + +```plaintext +다음 이슈에 맞게 필터링 기능을 검증해 주십시오: . 계획 중 승인한 추가 수락 기준은 다음과 같습니다: <합의한 추가 내용을 붙여 넣거나 없으면 none 입력>. + +Playwright MCP 서버로 동작을 검증하고, 테스트 커버리지를 확인하며, 누락된 커버리지에 대해서만 테스트를 추가하고, quality-checks 스킬을 통해 검증을 실행해 주십시오. 근거, 검사 결과, 차단 요인을 보고해 주십시오. 제 승인 없이 애플리케이션 코드를 변경하지 마십시오. 커밋하거나 끌어오기 요청을 만들지 마십시오. +``` + +## 근거 검토 + +보고서를 이슈와 비교합니다. 각 기준에는 적절한 자동 테스트 커버리지와 관찰 가능한 동작이 필요합니다. 실제 Playwright MCP 도구 작업, 체크아웃과 서버 식별 정보, 네 가지 스킬 스크립트 결과를 모두 확인합니다. 브라우저 검사와 자동 E2E가 오래된 서버나 다른 체크아웃을 재사용해서는 안 됩니다. + +추가한 테스트를 검토합니다. 검증을 약화하지 않고 실제 공백을 메워야 합니다. 커버리지가 충분하다면 새 테스트가 없는 것이 올바릅니다. 차단이나 실패에 따른 **NO-GO** 판정은 유효한 결과이며, 근거를 생략해도 된다는 허가가 아닙니다. + +QA에서 애플리케이션 결함을 발견하면 범위를 좁힌 수정을 별도로 승인하고, 변경된 리비전에서 영향을 받는 검사와 브라우저 관찰을 다시 실행합니다. 누락된 필수 조건이나 도구에는 명시적인 해결이 필요합니다. 오래된 근거를 변경된 코드의 증거로 취급하지 않습니다. + +## 체크포인트 저장 + +QA가 끝나면 이슈 URL, 승인한 추가 합의 사항, 테스트한 리비전, 브라우저 관찰, 검사 결과를 포함한 보고서를 보관합니다. `/exit`를 입력한 후 동일한 디렉터리와 브랜치에서 `--agent` 없이 `copilot`을 시작하여 일반 대화로 돌아옵니다. 해당 컨텍스트를 다시 제공합니다. 새 대화는 QA 대화의 근거를 상속하지 않습니다. + +프로필, 테스트 변경, 그 결과로 얻은 근거를 검토한 후 일반 에이전트에 다음 요청을 보냅니다. + +```plaintext +현재 diff를 검토하고 QA 에이전트 정의와 승인된 테스트 변경의 체크포인트 커밋을 만들어 주십시오. 기존 필터링 브랜치를 유지해 주십시오. 푸시하거나 끌어오기 요청을 만들지 마십시오. +``` + +## 요약 및 다음 단계 + +QA 프로필을 만들고 선택했으며 근거를 검토하고 프로필과 필요한 테스트를 저장했습니다. 해결되지 않은 사항은 다음 단계로 넘겨 추적합니다. 실패하거나 차단된 판정은 병합 승인이 아닙니다. 필터링 기능, 스킬, QA 프로필, 테스트, 현재 검증 근거를 갖추고 [연습 8 - 기능 PR 생성 및 병합][next-lesson]을 계속합니다. + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ko-kr/cli/7-slash-commands.md b/docs/ko-kr/cli/7-slash-commands.md deleted file mode 100644 index c01136b0..00000000 --- a/docs/ko-kr/cli/7-slash-commands.md +++ /dev/null @@ -1,176 +0,0 @@ ---- -title: "연습 7 - GitHub Copilot CLI의 슬래시 명령" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -좋은 CLI 도구라면 그렇듯 GitHub Copilot CLI에도 다양한 slash commands가 포함되어 있습니다. 이 명령은 고급 기능, "내부 동작" 정보, 추가 구성 옵션을 제공합니다. 이미 `/clear`로 컨텍스트를 지우고 `/mcp`로 MCP server를 검사하는 방법을 살펴보았습니다. 이제 `/context`, `/model`, `/share`, `/delegate`를 포함한 몇 가지 강력한 명령을 더 살펴보겠습니다. - -## 시나리오 - -이제 핵심 CLI 흐름은 모두 살펴보았습니다. 이번에는 세션 공유, 모델 전환, [Copilot cloud agent][about-cloud-agent]에 작업 위임 같은 추가 기능을 알아보겠습니다. - -이 연습에서는 다음을 사용합니다. - -- `/share`로 세션을 팀과 공유할 수 있도록 GitHub gist를 만듭니다. -- `/context`로 Copilot CLI가 현재 사용 중인 컨텍스트를 확인합니다. -- `/model`로 사용 가능한 모델 목록을 확인하고 원한다면 다른 모델을 선택합니다. -- `/delegate`로 선택적으로 작업을 cloud agent에 넘깁니다. 이 기능을 사용하려면 cloud agent가 필요하며, Copilot Student, Pro, Pro+, Business, Enterprise에서 사용할 수 있습니다. 즉 Copilot Free를 제외한 모든 플랜에서 사용할 수 있습니다. - -## 세션 공유하기 - -AI 도구를 포함해 어떤 도구든 잘 활용하는 것은 하나의 기술입니다. 팀으로 함께 작업하면서 서로의 학습 내용을 공유하는 것은 모두의 경험을 개선하고 더 높은 품질의 코드를 생성하는 가장 좋은 방법입니다. 이를 지원하기 위해 Copilot CLI는 `/share` 명령을 제공합니다. `/share` 명령은 세션에서 사용한 프롬프트와 Copilot이 따랐던 로직을 포함해 세션 세부 정보를 담은 markdown 파일이나 GitHub gist를 생성할 수 있습니다. - -이제 팀과 공유할 수 있는 GitHub gist를 만들어 보겠습니다. - -> [!TIP] -> **Copilot CLI 세션 시작하기** -> -> 아래 연습을 시작하기 전에 코드스페이스로 돌아가 터미널을 엽니다(이미 열려 있지 않다면 Ctrl+`). 그런 다음 `--yolo`와 `--enable-all-github-mcp-tools`를 사용해 Copilot CLI를 시작합니다. -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 이 프로젝트의 가장 최근 세션을 새로 시작하지 않고 이어서 사용하려면 `copilot --yolo --enable-all-github-mcp-tools --continue`를 실행합니다. 이전 연습에서 Copilot CLI가 이미 실행 중이라면 `/clear`를 보내 새 대화를 시작합니다. -> -> `--enable-all-github-mcp-tools`는 현재 세션에서 읽기/쓰기 GitHub MCP 도구를 활성화하므로, 워크숍 흐름 중 Copilot이 백로그를 읽고 pull request를 열 수 있습니다. - -> [!CAUTION] -> `--yolo`는 전체 자동 권한(`--allow-all-tools`, `--allow-all-paths`, `--allow-all-urls`)을 활성화합니다. Codespace나 VM 같은 격리된 환경에서만 사용하고, 일상적인 개발을 위한 기본 별칭으로는 절대 설정하지 않습니다. 자세한 내용은 [Allowing and denying tool use][allow-all-warning]를 참고합니다. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools -1. Copilot CLI 프롬프트 창에서 다음 명령을 보냅니다. - - ``` - /share gist - ``` - -2. 잠시 후 Copilot이 gist를 만들고 링크를 표시합니다. -3. 링크 텍스트를 복사합니다. -4. 새 브라우저 탭에 링크를 붙여 넣어 gist를 살펴봅니다. gist에 전송된 프롬프트, 사용한 스킬과 agent, Copilot의 사고 과정, 로컬에서 실행한 명령의 코드와 결과까지 강조되어 있는 점을 확인합니다. - -`/share`가 생성하는 gist와 markdown 파일은 코드가 어떻게 생성되었는지 문서화하거나, 원하는 결과를 얻기 위해 Copilot으로 어떤 작업을 수행했는지 팀과 공유하는 용도로 사용할 수 있습니다. - -## Copilot CLI의 컨텍스트 살펴보기 - -더 크거나 복잡한 작업을 수행할 때는 모델의 최대 context window에 도달할 수 있습니다. 창의 정확한 크기는 사용 중인 모델과 Copilot CLI 버전에 따라 달라집니다. Context window가 가득 차면 Copilot CLI는 이를 자동으로 compact하여 정보를 요약하고 현재 작업과 관련이 없다고 판단한 항목을 제거합니다. Slash commands를 사용하면 현재 컨텍스트 상태를 확인할 수도 있고 수동으로 compact할 수도 있습니다. 이제 context window를 살펴보겠습니다. - -1. Copilot CLI 프롬프트 창에서 다음 명령을 보냅니다. - - ``` - /context - ``` - -2. 잠시 후 Copilot CLI가 현재 컨텍스트를 시각적으로 표현한 결과를 생성합니다. - - ![Copilot CLI의 context window 화면](../../_images/cli-7-context-window.png) - -3. 표시된 모델(이미지와 다를 수 있음)과 현재 사용된 token 비율을 확인합니다. 나머지 정보는 다음을 보여 줍니다. - - | 제목 | 설명 | - | ------------ | ------------------------------------------------------ | - | System/Tools | 지침 파일, 파일 내용, 도구 정의 | - | Messages | 사용자와 Copilot 간의 대화 기록 | - | Buffer | 응답 생성을 위해 Copilot CLI가 예약한 공간 | - | Free space | 남아 있는 여유 공간 | - -4. 다음 slash command를 Copilot CLI에 보내 대화 기록을 compact합니다. - - ``` - /compact - ``` - -5. 완료되면 다음 명령을 보내 현재 컨텍스트 통계를 다시 표시합니다. - - ``` - /context - ``` - -6. 컨텍스트 변화에 주목합니다. 현재 context window가 상대적으로 작을 가능성이 높으므로 큰 차이가 없을 수도 있습니다. - -> [!NOTE] -> Copilot CLI는 컨텍스트가 가득 차면 자동으로 compact를 수행합니다. 용량이 100%에 가까워지면 프롬프트 창 바로 위에 비율을 표시합니다. 일반적으로는 비동기적으로 compact를 수행하므로, 작업 중에도 계속 Copilot과 상호 작용할 수 있습니다. 다만 작업을 수행하는 동안 몇 초간 실행 중인 작업을 차단할 수도 있습니다. - -### 컨텍스트 사용 모범 사례 - -대부분의 세션에서는 Copilot이 별도 지시 없이도 컨텍스트를 효율적으로 관리합니다. 하지만 다음과 같이 히스토리를 직접 지우거나 compact하도록 지시하고 싶어지는 상황도 있을 수 있습니다. - -- 애플리케이션의 다른 부분이나 관련 없는 작업으로 전환하는 경우, 오래되고 관련 없는 컨텍스트가 Copilot을 혼란스럽게 하지 않도록 `/clear`를 사용해 새로 시작할 수 있습니다. -- 최대 context window에 가까워지고 있다면 `/compact`로 수동으로 컨텍스트를 정리해 시점을 직접 제어할 수 있습니다. - -> [!CAUTION] -> 다시 말해 대부분의 시간에는 Copilot이 직접 컨텍스트를 관리합니다. 오래된 정보 때문에 Copilot이 약간 혼란스러워 보이거나 관련 없는 작업으로 전환하려는 경우에만 수동 명령 사용을 고려합니다. - -## 모델 선택하기 - -모델마다 강점이 다르고, 개발자마다 선호도도 다릅니다. Copilot CLI는 사용 가능한 모델을 나열하고 원하는 모델을 선택할 수 있게 해줍니다. - -1. Copilot CLI에 다음 slash command를 보내 모델 목록을 표시합니다. - - ``` - /model - ``` - -2. 모델 목록을 확인합니다. 각 모델 옆에는 이름과 요청당 비용 modifier가 함께 표시됩니다. -3. 원한다면 새 모델을 선택합니다. 아니면 Esc를 선택해 모델 목록을 종료합니다. - -> [!CAUTION] -> Copilot CLI의 모델 선택은 유지됩니다. - -## Cloud agent에 위임하기(선택 사항) - -터미널에서 계속 작업하고 싶지만 더 오래 걸리는 작업은 Copilot cloud agent에 넘기고 싶을 때가 있습니다. `/delegate` 명령은 현재 Copilot CLI 세션을 GitHub.com으로 보내고, cloud agent가 이를 받아 비동기적으로 작업한 뒤 완료되면 pull request를 엽니다. - -> [!NOTE] -> `/delegate`에는 cloud agent가 필요합니다. Copilot Student, Pro, Pro+, Business, Enterprise에서 사용할 수 있으며, Copilot Free에서는 사용할 수 없습니다. 액세스 권한이 없다면 이 섹션을 읽고 실습 단계는 건너뜁니다. - -1. 워크숍에서 누적된 컨텍스트가 함께 위임되지 않도록 먼저 현재 세션을 지웁니다. - - ``` - /clear - ``` - -2. 범위가 작고 명확한 프롬프트를 보냅니다. 예를 들어 백로그에 있는 pagination stretch goal을 위임할 수 있습니다. - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. 다음 slash command를 보내 세션을 cloud agent에 넘기고, 위임할 프롬프트를 확인합니다. - - ``` - /delegate - ``` - -4. 브라우저에서 [Copilot agents](https://github.com/copilot/agents)를 열어 진행 상황을 모니터링합니다. -5. 이 harness에서는 pull request가 완료될 때까지 기다릴 필요는 없습니다. 나중에 다시 돌아와도 됩니다. 비동기 agent 작업 관리 방법을 더 깊이 알아보고 싶다면 [Cloud agent harness](../../cloud/)를 계속 진행합니다. - -## 요약 및 다음 단계 - -Copilot CLI의 slash commands를 사용하면 구성을 변경하고, 세션을 공유하고, Copilot이 내부적으로 어떻게 동작하는지에 대한 정보를 얻을 수 있습니다. 이 연습에서는 다음을 사용하거나 살펴보았습니다. - -- `/share`로 세션을 팀과 공유할 GitHub gist를 만들었습니다. -- `/context`로 Copilot CLI가 현재 사용 중인 컨텍스트를 확인했습니다. -- `/model`로 사용 가능한 모델 목록을 살펴보고 원한다면 새 모델을 선택할 수 있음을 확인했습니다. -- `/delegate`를 cloud agent로 연결하는 선택적 브리지로 학습했습니다. - -물론 더 많은 slash commands가 있으며, Copilot CLI로 탐색할 내용도 더 많습니다. 마지막으로 [학습한 내용을 검토하고][next-lesson] 학습을 계속하기 위한 다음 단계를 살펴보며 여정을 마무리하겠습니다. - -## 리소스 - -- [Copilot CLI 사용하기][using-copilot-cli] -- [Copilot CLI 소개][about-copilot-cli] -- [Copilot CLI의 컨텍스트 관리][context-management] -- [Copilot CLI로 세션 공유하기][share-sessions] -- [Copilot CLI에서 모델 선택하기][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm diff --git a/docs/ko-kr/cli/8-create-pull-request.md b/docs/ko-kr/cli/8-create-pull-request.md new file mode 100644 index 00000000..c1ed6ced --- /dev/null +++ b/docs/ko-kr/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "연습 8 - 기능 PR 생성 및 병합" +description: "전체 필터링 마일스톤을 검토하고 현재 QA 근거를 재사용한 후 CI와 검토를 거쳐 세 번째 끌어오기 요청을 병합합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +이제 필터링 마일스톤을 PR 3으로 통합합니다. 연습 4~7에서 사용한 브랜치와 체크아웃을 유지합니다. 여기에는 필터링 구현, quality-checks 스킬과 스크립트, QA 프로필, 관련 테스트가 포함됩니다. + +이 연습에서는 다음을 수행합니다. + +- 전체 마일스톤의 diff와 현재 QA 근거를 검토합니다. +- 기능 PR 하나를 요청하고 검사 및 검토 피드백을 확인합니다. +- 검토한 PR을 명시적으로 병합하고 로컬 `main`을 업데이트합니다. + +## 시나리오 + +필터링 작업은 여러 체크포인트에 나뉘어 있지만 검토자는 하나의 완전한 기능으로 평가해야 합니다. Tailspin Toys는 요구 사항, 구현, 재사용 가능한 검사, QA 결과를 연결하는 PR을 원합니다. 검토를 위한 인계를 준비하고 병합 전에 차단 요인을 해결합니다. + +리포지토리 규칙을 사용하는 일반적인 범위 제한 PR 요청입니다. 기여 스킬은 필요하지 않습니다. + +> [!NOTE] +> 실제 팀은 기능과 재사용 가능한 품질 인프라를 분리할 수 있습니다. 이 워크숍은 하나의 기능 PR에서 전체 워크플로를 보여 주기 위해 의도적으로 통합합니다. 이전 별점과 지침 PR은 이미 `main`에 병합되어 있어야 하며, 관련 없는 작업으로 다시 포함되어서는 안 됩니다. + +## 준비 상태와 근거 확인 + +1. QA 판정과 요구 사항별 근거 매핑을 검토합니다. **NO-GO**, 브라우저 근거 누락, 필수 검사 건너뛰기는 병합 전에 해결해야 할 차단 요인입니다. +2. lint, 단위 테스트, E2E, 타입 검사 네 가지가 실제로 quality-checks 스킬을 통해 실행되었는지 확인합니다. +3. 테스트한 리비전과 검사 이후의 변경을 검토합니다. 테스트한 코드, 테스트, 검증 스크립트가 변경되지 않았을 때만 현재 QA 근거를 재사용합니다. 파일 내용이 같다면 체크포인트 커밋만으로 근거가 무효화되지는 않지만, 코드 변경은 근거를 무효화합니다. +4. 구현이나 테스트 입력이 변경되었다면 관련 스킬 검사와 브라우저 관찰을 다시 실행하고 근거를 갱신합니다. 현재 QA 결과가 여전히 적용된다면 PR을 생성한다는 이유만으로 전체 스위트를 다시 실행하지 않습니다. +5. 최근 체크포인트나 미커밋 변경뿐 아니라 전체 브랜치 diff를 확인합니다. + +동일한 체크아웃의 다른 터미널에서 실행합니다. + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +점 세 개를 사용하는 diff는 `origin/main`과의 공통 조상 이후 이 브랜치의 변경을 이전 체크포인트까지 포함하여 보여 줍니다. 의도한 필터링 마일스톤만 포함하는지 확인합니다. 새 파일도 확인합니다. 예상하지 못한 추적되지 않은 파일이나 미커밋 파일은 스테이징 전에 검토해야 합니다. + +## PR 3 요청 + +연습 7에서는 체크포인트 전에 일반 **Interactive** 세션으로 돌아왔습니다. QA 프로필이 더 이상 활성 상태가 아니고 필터링 체크아웃과 브랜치가 변경되지 않았다면 그 세션을 계속합니다. 이슈 URL, 계획 중 승인한 추가 합의 사항, 테스트한 리비전과 검사 결과를 포함한 현재 QA 보고서를 준비합니다. + +QA 프로필은 QA 중 커밋과 PR 작업을 금지합니다. 아직 활성 상태라면 PR을 요청하기 전에 일반 세션으로 돌아옵니다. + +1. QA가 유휴 상태가 될 때까지 기다린 다음 CLI 프롬프트에 `/exit`를 입력합니다. 다른 세션이 활성 상태라 CLI가 계속 열려 있다면 해당 작업을 마치거나 보존합니다. 그 후 일반 프롬프트로 돌아와 Ctrl+D를 눌러 이 CLI 인스턴스를 종료합니다. +2. 셸 프롬프트에서 동일한 필터링 체크아웃과 브랜치를 유지합니다. 둘을 확인한 후 `--agent qa`나 재개 플래그 없이 새로운 일반 세션을 시작합니다. + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. **Interactive** 모드이고 QA 프로필이 더 이상 활성 상태가 아닌지 확인합니다. 다른 워크트리를 만들거나 브랜치를 변경하거나 QA 세션을 재개하지 않습니다. + +아래의 모든 플레이스홀더를 실제 이슈 URL, 승인한 추가 합의 사항, 현재 QA 근거로 바꿉니다. 연습 7의 일반 세션을 유지했더라도 명시적으로 제공합니다. 새 대화가 QA 세션의 기억에 의존해서는 안 됩니다. + +```plaintext +다음 이슈의 필터링 기능 PR을 준비해 주십시오: . 계획 중 승인한 추가 수락 기준은 다음과 같습니다: <합의한 추가 내용을 붙여 넣거나 없으면 none 입력>. 현재 QA 근거는 다음과 같습니다: <테스트한 리비전, 브라우저 관찰, 커버리지 평가, 네 가지 검사 결과, 한계를 포함한 QA 보고서 붙여 넣기>. + +체크아웃과 현재 필터링 브랜치를 확인해 주십시오. main에 대한 전체 diff, 마일스톤의 모든 체크포인트 커밋, git status, 리포지토리 PR 템플릿, 제공된 QA 근거를 확인해 주십시오. 검토한 필터링 구현, quality-checks 스킬과 함께 제공되는 스크립트, QA 에이전트 정의, 관련 테스트만 포함해 주십시오. + +QA 결과가 최종 파일 내용을 여전히 설명하는 동안에는 재사용해 주십시오. 이후 코드, 테스트, 검증 스크립트가 바뀌었다면 보고하고, 최신 결과로 제시하기 전에 스킬을 통한 관련 검사와 영향을 받는 브라우저 검증을 실행해 주십시오. 실패하거나 차단되거나 건너뛴 검사를 통과로 표시하지 마십시오. + +필요하다면 검토한 마일스톤의 남은 변경을 커밋하고 현재 브랜치를 푸시한 후, 리포지토리 규칙에 따라 main을 대상으로 PR 하나를 만들어 주십시오. 이슈와 승인된 기준, 구현 요약, 추가한 테스트 또는 추가할 필요가 없었던 이유, 브라우저 관찰, 네 가지 검사 결과, 남은 한계를 포함해 주십시오. 병합하거나 다른 브랜치를 만들거나 기여 스킬을 호출하거나 다른 기능을 시작하지 마십시오. +``` + +## PR과 CI 검토 + +반환된 URL을 열고 전체 PR의 **Files changed**를 확인합니다. 스킬의 스크립트와 QA 프로필이 포함되었는지, 자격 증명, 로컬 MCP 설정, 관련 없는 파일, 생성된 보고서, 의존성 설치 변경이 diff에 섞이지 않았는지 확인합니다. + +PR의 **Checks** 탭을 사용하거나 기능 브랜치의 터미널에서 다음 명령을 실행합니다. + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +초록색 배지가 모든 종류의 검증을 포함한다고 가정하지 말고 리포지토리의 `.github/workflows/`를 확인합니다. 현재 Tailspin **Run tests** 워크플로는 빌드된 정적 사이트를 대상으로 lint, 타입 검사, Vitest 단위 테스트, Playwright E2E 테스트를 실행합니다. 이는 QA 보고서의 직접적인 MCP 브라우저 관찰을 대체하지 않습니다. 워크숍 사이트의 Astro 빌드와 링크 검사는 다른 리포지토리를 검증합니다. + +검사가 실패하면 로그를 확인하고 원인을 해결합니다. 범위를 좁힌 수정은 푸시 전에 업데이트된 리비전에서 검토하고 재검증해야 합니다. `main` 변경으로 충돌을 해결하면서 기능이 바뀌었다면 영향을 받는 근거도 갱신합니다. 필요한 사람의 검토를 기다립니다. 에이전트 자체의 승인은 브랜치 보호를 무시하지 못합니다. + +## 병합 및 로컬 main 업데이트 + +PR이 모든 검토와 검사 요구 사항을 충족하면 GitHub에서 **Merge pull request**를 명시적으로 선택하고 병합을 확정합니다. PR 3이 **Merged**인지 확인합니다. + +`/exit`로 CLI 세션을 종료합니다. 작업 트리에 미커밋 변경이 없는 상태에서 로컬 체크아웃을 업데이트합니다. + +```bash +git status +git switch main +git pull --ff-only +``` + +## 요약 및 다음 단계 + +다음 연습에는 새 브랜치가 필요하지 않습니다. 이제 별점, 지침과 실증, 필터링과 품질 스킬·QA 프로필·테스트라는 정확히 세 개의 워크숍 PR을 병합했습니다. + +[연습 9 - 슬래시 명령과 CLI 옵션 살펴보기][next-lesson]로 계속합니다. 또 다른 구현 작업이 아니라 범위를 제한하여 CLI 조작 방법을 살펴봅니다. + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/ko-kr/cli/8-review.md b/docs/ko-kr/cli/8-review.md deleted file mode 100644 index be6b5ec5..00000000 --- a/docs/ko-kr/cli/8-review.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "연습 8 - 검토 및 다음 단계" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -지난 여러 연습에서 다음을 포함해 GitHub Copilot CLI의 가장 일반적인 사용 사례를 살펴보았습니다. - -- GitHub 및 다른 MCP server와 상호 작용하기 -- 지침 파일을 사용해 코드 생성을 안내하기 -- 스킬을 구현해 Copilot CLI 도구 상자에 새 도구를 추가하기 -- 고급 작업과 더 복잡한 작업을 위해 커스텀 agent 호출하기 -- Slash commands를 사용해 세션을 관리하고, 선택적으로 `/delegate`를 통해 cloud agent로 다시 연결하기 - -이제 몇 가지 slash commands, 모범 사례, 다음 단계를 정리해 보겠습니다. - -## 슬래시 명령 - -Copilot CLI에는 이를 제어하거나 내부에서 무슨 일이 일어나고 있는지 확인할 수 있는 다양한 slash commands가 있습니다. 이미 현재 컨텍스트를 지우고 새 채팅을 시작하는 `/clear`, MCP server를 검사하고 관리하는 `/mcp`를 사용해 보았습니다. 추가로 유용할 수 있는 명령은 다음과 같습니다. - -| 명령 | 설명 | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | Copilot의 신뢰 목록에 디렉터리를 추가합니다 | -| `/clear`, `/new` | 대화 기록을 지우고 새로 시작합니다 | -| `/compact` | 컨텍스트 창 사용량을 줄이기 위해 대화 기록을 요약합니다 | -| `/context` | 컨텍스트 창 token 사용량과 시각화를 보여 줍니다 | -| `/diff` | 현재 디렉터리에서 이루어진 변경 사항을 검토합니다 | -| `/model` | 사용할 AI 모델을 선택합니다(Claude Sonnet, GPT-5 등) | -| `/plan ` | 코딩 전에 구현 계획을 만듭니다 | -| `/review ` | 변경 사항을 분석하도록 코드 리뷰 agent를 실행합니다 | -| `/delegate` | 비동기 처리를 위해 작업을 Copilot cloud agent에 위임합니다 | -| `/session` | 세션 정보와 작업 공간 요약을 보여 줍니다 | -| `/share` | 세션을 markdown 파일 또는 GitHub gist로 공유합니다 | -| `/skills` | 향상된 기능을 위한 스킬을 관리합니다 | -| `/usage` | 세션 사용량 지표와 통계를 표시합니다 | - -> [!TIP] -> `/help`를 사용하면 전체 명령 목록과 keyboard shortcuts를 확인할 수 있습니다. - -## 모범 사례 - -어떤 AI 도구를 사용하든, 그 결과물의 품질은 기반 인프라에 크게 좌우됩니다. 강력한 지침 파일, 커스텀 에이전트, 에이전트 스킬은 모두 중요한 역할을 하며, 이 워크숍에서 각각을 살펴보았습니다. [Awesome-copilot][awesome-copilot]은 템플릿을 찾기에 좋은 자료이며, Copilot 자체도 시작점을 마련할 수 있도록 이러한 요소를 스캐폴드해 줄 수 있습니다. - -인프라만큼이나 컨텍스트도 중요합니다. *무엇을* 만들고 싶은지, *왜* 필요한지, *어떻게* 만들고 싶은지를 명확하게 설명하면 결과가 크게 달라집니다. Copilot에 도움이 될 만한 정보라면 반드시 전달합니다. - -## 다음 단계 - -도구 사용 능력을 향상하는 가장 좋은 방법은 계속 사용하는 것입니다. 운영 코드에도, 취미 프로젝트에도, 오랫동안 마음속에 있었지만 아직 만들지 못한 작은 앱에도 사용해 봅니다. 학습한 내용을 팀과 공유하고, 팀으로부터도 배웁니다. 그리고 늘 그렇듯 문서를 계속 탐색합니다. - -GitHub Copilot 생태계를 더 살펴보고 싶다면 [VS Code harness](../../vscode/) 또는 [Cloud agent harness](../../cloud/)를 확인합니다. - -## 리소스 - -- [Copilot CLI 소개][about-copilot-cli] -- [Copilot CLI 사용하기][using-copilot-cli] -- [Awesome Copilot 리포지토리][awesome-copilot] -- [커스텀 지침 가이드][repo-instructions] -- [에이전트 스킬 문서][agent-skills] -- [커스텀 에이전트 문서][custom-agents] -- [MCP 사양][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ diff --git a/docs/ko-kr/cli/9-slash-commands.md b/docs/ko-kr/cli/9-slash-commands.md new file mode 100644 index 00000000..26c8bea5 --- /dev/null +++ b/docs/ko-kr/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "연습 9 - 슬래시 명령과 CLI 옵션 살펴보기" +description: "다른 기능을 시작하지 않고 컨텍스트, 모델과 세션 조작, 공유 대상, CLI 플래그를 확인합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +세 번의 PR 마일스톤을 완료했습니다. 이제 세션을 이해하고 관리하는 데 도움이 되는 CLI 조작 방법을 살펴봅니다. 이 연습에서는 다른 기능을 구현하거나 작업을 위임하거나 다른 PR을 만들지 않습니다. + +이 연습에서는 다음을 수행합니다. + +- 컨텍스트, 사용량, 모델, 모드 조작 방법을 확인합니다. +- 명령줄 옵션을 설치된 버전의 도움말과 비교합니다. +- 세션을 로컬로 내보내고 내용을 공유하기 전에 검토합니다. + +## 시나리오 + +기능 출시를 마쳤으므로 일상 업무에 사용할 CLI 조작 방법을 이해하려고 합니다. 다른 작업을 시작하지 않고 세션과 공유 옵션을 살펴봅니다. 이를 통해 컨텍스트를 관리하거나 대화를 내보낼 때 실수로 작업을 승인하거나 프로젝트 정보를 공개하는 일을 방지합니다. + +업데이트된 학습용 체크아웃에서 **Interactive** 모드로 `copilot`을 시작합니다. `/help`와 [명령 참조][cli-reference]를 사용하여 설치된 버전이 지원하는 명령을 확인합니다. 현재 문서에는 설치된 버전보다 새로운 조작 방법이 설명되어 있을 수 있습니다. + +## 컨텍스트와 세션 정보 확인 + +1. 범위가 제한된 읽기 전용 요청을 보냅니다. + + ```plaintext + 리포지토리의 지침 파일, quality-checks 스킬, QA 프로필을 요약해 주십시오. 필터링 검증에 어떻게 도움이 되는지 설명해 주십시오. 파일을 수정하거나 검사를 실행하거나 작업을 위임하거나 커밋하거나 PR을 만들지 마십시오. + ``` + +2. `/context`를 입력해 컨텍스트 윈도 사용량을 확인합니다. 메시지, 지침, 도구 정의가 컨텍스트를 어떻게 사용하는지 살펴봅니다. +3. `/compact`를 입력하고 다시 `/context`를 입력합니다. 압축은 기록을 요약하여 크기를 줄입니다. 짧은 세션에서는 변화가 작을 수 있습니다. +4. `/session`으로 현재 세션을 확인하고 `/usage`로 사용량 정보를 확인합니다. + +압축이 요구 사항 제공을 대체하지는 않습니다. 작업이나 에이전트를 바꿀 때 이슈 URL, 승인된 기준, 체크아웃 식별 정보, 관련 근거를 명시적으로 전달합니다. + +`/clear`는 새 대화를 시작하지만 파일을 되돌리거나 Git 브랜치를 전환하지는 않습니다. `/resume`은 이전 작업으로 돌아가기 위한 세션 선택기를 엽니다. 선택기를 살펴본 후 Esc를 눌러 다른 작업을 재개하지 않고 닫습니다. 수락 기준의 유일한 사본을 지우거나 대화를 재개하면 오래된 검증도 여전히 유효하다고 가정하지 않습니다. + +## 모델과 모드 확인 + +`/model`을 입력하여 제공되는 경우 **Auto**를 포함해 계정에서 사용 가능한 모델을 확인합니다. 선택 세부 사항과 사용량 정보를 읽습니다. 모델 가용성과 가격은 바뀔 수 있습니다. Esc를 눌러 모델을 변경하지 않고 선택기를 닫습니다. 모델을 변경했다면 표시된 선택과 해당 CLI 버전의 적용 범위를 확인합니다. + +Shift+Tab으로 **Interactive**, **Plan**, **Autopilot**을 순환하며 모드 표시를 확인한 후, 구현 프롬프트를 보내지 않고 **Interactive**로 돌아옵니다. 다음 차이를 기억합니다. + +- Plan은 코딩 전에 작업에 합의하기 위한 모드입니다. +- Autopilot은 승인된 범위 제한 작업을 계속합니다. +- Interactive는 의식적인 검토와 결정 시점을 제공합니다. +- 권한은 허용되는 도구 작업을 별도로 제어합니다. + +## 명령줄 옵션 확인 + +별도 터미널에서 실행합니다. + +```bash +copilot --help +``` + +문서에 나오는 다음 옵션을 설치된 버전의 도움말과 비교합니다. + +| 옵션 | 목적 | +| --- | --- | +| `--model MODEL` | 실행할 모델을 선택합니다. 먼저 가용성을 확인합니다 | +| `--agent AGENT` | 실행할 사용자 지정 에이전트를 선택합니다 | +| `-p PROMPT` | 프롬프트를 프로그래밍 방식으로 실행하고 완료되면 종료합니다 | +| `--output-format json` | 한 줄에 JSON 객체 하나씩 구조화된 JSONL을 출력합니다 | +| `--resume` | 기존 세션을 재개합니다 | +| `--enable-all-github-mcp-tools` | 기본 제공 GitHub MCP의 전체 도구를 노출합니다 | + +이 옵션은 이해할 조작 방법이며 새 작업을 시작하라는 뜻이 아닙니다. 프로그래밍 방식 모드는 실제 도구 작업을 실행할 수 있습니다. JSON 출력 형식이 요청을 읽기 전용으로 만들지는 않습니다. 에이전트 선택은 [연습 7][qa-lesson]에서 검증한 워크플로를 따릅니다. 사용자 지정 에이전트 활성화를 기본 에이전트에게 프로필을 읽으라고 요청하는 방식으로 대체해서는 안 됩니다. 권한과 액세스 제한은 계속 적용됩니다. + +## 공유 전 검토 + +`/share`는 세션 내용을 여러 대상으로 보낼 수 있습니다. [CLI 명령 참조][cli-reference]에는 Markdown 내보내기용 `/share file [session|research] [PATH]`와 gist 게시용 `/share gist [session|research]`가 설명되어 있습니다. 하위 명령이 없으면 현재 문서상으로는 로그인 및 동기화 상태에서 공유 가능한 GitHub 링크를 만들고, 그렇지 않으면 Markdown으로 내보냅니다. 내용 미리 보기만 한다고 가정하여 하위 명령 없이 실행하지 않습니다. + +이 워크숍에서는 게시하는 대신 로컬 세션 내보내기와 파일명을 명시적으로 선택합니다. + +```text +/share file session cli-session-review.md +``` + +내보낸 파일을 편집기에서 열고 실제 내용을 확인합니다. 프롬프트, 응답, 도구 출력, 파일 경로, 리포지토리 데이터, 자격 증명이나 개인 정보를 검토합니다. 모든 내부 단계가 포함되었거나 민감한 내용이 자동으로 제거되었다고 가정하지 않습니다. + +> [!CAUTION] +> Gist나 공유 링크는 외부 공개입니다. 비밀 gist는 비공개 액세스 제어가 아닙니다. URL을 아는 사람은 누구나 볼 수 있습니다. 공유 전에 대상, 수신자, 권한, 조직 정책을 확인합니다. 민감한 내용을 제거해야 한다면 검토하고 해당 내용을 제거한 자료만 승인된 경로로 공유하며, 그 후 원본 세션을 게시하지 않습니다. + +이 내보내기 파일을 기능 PR과 리포지토리 기록에 포함하지 않습니다. 확인한 후 방금 생성한 파일을 삭제하거나 승인된 로컬 메모 위치로 옮깁니다. 관련 없는 파일은 삭제하지 않습니다. + +Cloud 위임은 원격 작업과 추가 PR을 생성할 수 있으므로 여기서는 `/delegate`를 실행하지 않습니다. [Cloud 에이전트 워크숍][cloud-workshop]에서 해당 별도 워크플로를 다룹니다. + +## 요약 및 다음 단계 + +다른 기능을 시작하지 않고 컨텍스트, 사용량, 모델과 모드 조작, 명령줄 옵션, 공유 대상을 확인했습니다. [연습 10 - 마무리 및 다음 단계][next-lesson]에서 구축한 워크플로와 자산을 검토합니다. + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/ko-kr/cli/README.md b/docs/ko-kr/cli/README.md index 82f069d0..f0f86057 100644 --- a/docs/ko-kr/cli/README.md +++ b/docs/ko-kr/cli/README.md @@ -3,12 +3,12 @@ slug: ko-kr/cli title: "GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [**GitHub Copilot CLI**](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)는 터미널에서 GitHub Copilot을 에이전트형 코딩 도우미로 사용할 수 있게 해줍니다. 코드베이스를 탐색하고, 코드를 생성하고, 명령을 실행하고, 외부 도구에 연결하는 작업을 모두 명령줄에서 처리하므로 그래픽 편집기로 전환하지 않고도 작업 흐름을 유지할 수 있습니다. -이 연습 전체에서 Copilot CLI를 설치하고 인증한 다음, 커스텀 지침으로 프로젝트 컨텍스트를 제공한 뒤 plan mode를 사용해 의도적으로 기능을 생성합니다. 이어서 Playwright MCP server를 연결해 실제 브라우저에서 해당 기능을 테스트하고, 재사용 가능한 agent skills와 custom agents로 Copilot을 확장합니다. 마지막으로 slash commands로 컨텍스트, 모델, 공유를 관리하는 방법을 살펴보고, 완성한 내용을 검토합니다. +연습 0~1에서 설정한 후 연습 2~10의 아홉 개 핵심 모듈을 완료합니다. 별점 추가로 작은 성과를 얻고, 문서화 지침을 정립한 다음, **Plan**과 **Autopilot** 모드로 필터링을 구축합니다. 이어서 재사용 가능한 quality-checks 스킬을 만들고 Playwright MCP로 동작을 검증하며 QA 에이전트를 만들어 기능을 제공합니다. 마지막으로 CLI 조작 방법과 완성한 내용을 살펴봅니다. ## 연습 @@ -16,13 +16,21 @@ lastUpdated: 2026-06-30 |----------|-------|-------------| | [0. 사전 준비][ex0] | 설정 | 리포지토리(Repository)와 코드스페이스(Codespace)를 만듭니다 | | [1. Copilot CLI 설치][ex1] | 설치 | Copilot CLI를 설치하고 인증합니다 | -| [2. 커스텀 지침][ex2] | 컨텍스트 | 지침을 추가하고 Copilot CLI가 이를 따르는 모습을 확인합니다 | -| [3. 코드 생성][ex3] | 코드 생성 | plan mode를 사용해 기능을 생성합니다 | -| [4. Playwright MCP로 테스트][ex4] | 외부 도구 | Playwright MCP server를 추가하고 브라우저에서 기능을 테스트합니다 | -| [5. 에이전트 스킬][ex5] | 스킬 | 특화된 스킬로 Copilot을 강화합니다 | -| [6. 커스텀 에이전트][ex6] | 에이전트 | 커스텀 에이전트를 검토하고 사용합니다 | -| [7. 슬래시 명령][ex7] | CLI 기능 | 컨텍스트, 모델, 공유, 그리고 선택적으로 cloud agent 위임을 살펴봅니다 | -| [8. 검토][ex8] | 요약 | 핵심 개념과 다음 단계를 검토합니다 | +| [2. 별점 추가로 작은 성과 얻기][ex2] | 첫 변경 | 기존 별점을 표시하고 검증한 후 PR 1을 병합합니다 | +| [3. 사용자 지정 지침으로 Copilot 안내][ex3] | 컨텍스트 | 문서화 규칙을 추가하고 실증한 후 PR 2를 병합합니다 | +| [4. Plan과 Autopilot으로 필터링 구축][ex4] | 구현 | 계획을 검토하고 Autopilot을 승인한 후 테스트하고 체크포인트를 저장합니다 | +| [5. quality-checks 스킬 만들기 및 사용][ex5] | 스킬 | 셸 스크립트를 포함한 검사를 생성하고 검토하고 실행합니다 | +| [6. Playwright MCP로 기능 검증][ex6] | 브라우저 도구 | 실제 브라우저에서 필터링 동작을 관찰합니다 | +| [7. QA 에이전트 만들기 및 사용][ex7] | 에이전트 | 요구 사항과 커버리지를 평가하고 최종 근거를 수집합니다 | +| [8. 기능 PR 생성 및 병합][ex8] | 제공 | 필터링과 재사용 가능한 사용자 지정을 PR 3에서 함께 검토합니다 | +| [9. 슬래시 명령과 CLI 옵션 살펴보기][ex9] | CLI 조작 | 컨텍스트, 모델, 세션, 공유 대상을 확인합니다 | +| [10. 마무리 및 다음 단계][ex10] | 요약 | 공통 자산과 세 번의 PR 마일스톤을 검토합니다 | + +## 브랜치와 끌어오기 요청 + +별점, 지침과 작은 실증, 필터링과 quality-checks 스킬·QA 프로필·관련 테스트를 담은 세 개의 끌어오기 요청을 병합합니다. 처음 두 PR은 각각 병합한 후 업데이트된 `main`에서 다음 마일스톤을 시작합니다. + +연습 4~8은 하나의 기능 브랜치와 체크아웃을 공유합니다. 진행 중 체크포인트 커밋을 저장합니다. 스킬 생성, MCP 설정, QA 선택 시 새 기능 브랜치를 만들지 않습니다. 연습 9에서는 다른 기능이나 PR을 시작하지 않고 조작 방법을 살펴봅니다. ## 사전 준비 @@ -46,10 +54,12 @@ lastUpdated: 2026-06-30 [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md index 80216e6a..67cb5910 100644 --- a/docs/pt-br/README.md +++ b/docs/pt-br/README.md @@ -3,7 +3,7 @@ slug: pt-br title: "Mãos à obra com os agentes do GitHub Copilot" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- As adições recentes aos recursos do GitHub Copilot oferecem ferramentas avançadas para apoiar pessoas desenvolvedoras durante todo o ciclo de vida de desenvolvimento de software (SDLC). Isso inclui trabalhar com problemas e solicitações de pull no GitHub, interagir com serviços externos e, é claro, criar código. Este laboratório explora esses recursos e apresenta casos de uso reais e dicas para aproveitar as ferramentas ao máximo. @@ -17,19 +17,19 @@ As adições recentes aos recursos do GitHub Copilot oferecem ferramentas avanç O GitHub Copilot acompanha você onde quer que trabalhe. Escolha o ambiente que corresponde à forma como você quer desenvolver e conclua os exercícios usando um backlog compartilhado da Tailspin Toys. Cada ambiente começa com sua própria configuração, para que você possa ir direto ao que escolheu. -### 🖥️ [VS Code](../vscode/) +### 🖥️ [VS Code](vscode/) GitHub Copilot no **Visual Studio Code** e no GitHub Codespaces. Trabalhe com o modo de agente do Copilot Chat, servidores MCP e agentes personalizados sem sair do editor que você já usa — ideal para integrar a assistência de IA diretamente ao seu IDE. ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI** — um assistente baseado em agentes que é executado no terminal. Instale-o, conecte servidores MCP, gere código com o modo de planejamento e crie suas próprias habilidades, agentes personalizados e comandos de barra, tudo pela linha de comando. +**GitHub Copilot CLI** — um assistente baseado em agentes que é executado no terminal. Após a configuração, siga nove módulos principais: entregue uma melhoria rápida de avaliações por estrelas, estabeleça instruções, planeje e crie a filtragem, crie uma skill quality-checks, valide pelo MCP do Playwright, crie um agente QA e faça o merge do recurso. Termine com os controles da CLI e um resumo. O fluxo tem três marcos de pull request. ### 🤖 [Aplicativo Copilot](app/) O **aplicativo GitHub Copilot** — um aplicativo para desktop criado com base no Copilot CLI. Siga a mesma configuração e os nove módulos principais do fluxo de avaliações por estrelas, instruções, filtragem, skill, MCP, QA e PR do recurso, usando as sessões isoladas do aplicativo e o **Agent Merge**. Crie e integre um canvas salvo no repositório como quarto marco de pull request e conclua com o resumo. -### ☁️ [Agente de nuvem do Copilot](../cloud/) +### ☁️ [Agente de nuvem do Copilot](cloud/) **Agente de nuvem do Copilot** — um programador parceiro assíncrono que trabalha em problemas do GitHub em segundo plano. Atribua tarefas, oriente-o com agentes personalizados, acompanhe o progresso no painel de agentes e revise as solicitações de pull que ele abre. diff --git a/docs/pt-br/cli/0-prerequisites.md b/docs/pt-br/cli/0-prerequisites.md index a3ee88c9..fb9262c4 100644 --- a/docs/pt-br/cli/0-prerequisites.md +++ b/docs/pt-br/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "Lição 0: Pré-requisitos" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- Antes de começar as lições do Copilot CLI, você precisa deixar tudo pronto. Você criará sua própria cópia do repositório Tailspin Toys e iniciará um [codespace][codespaces], cujo terminal integrado será usado para instalar e executar o Copilot CLI na próxima lição. +Nesta lição, você vai: + +- criar seu próprio repositório a partir do modelo da Tailspin Toys. +- abrir um codespace e confirmar que o ambiente está pronto para configurar a CLI. + ## Configurar o repositório do laboratório Para criar uma cópia do repositório para o código que você desenvolverá, crie uma instância a partir do [modelo][template-repository]. A nova instância conterá todos os arquivos necessários para o laboratório, e você a usará ao longo das lições. +Use uma cópia nova do modelo. Ele inclui instruções do repositório, código da aplicação, testes e CI, mas não agentes personalizados ou skills. Você criará esses ativos. Se estiver voltando a uma cópia antiga, examine as personalizações existentes antes de alterá-las; não sobrescreva seu trabalho. + 1. Em uma nova janela do navegador, acesse o repositório do GitHub deste laboratório: `https://github.com/github-samples/tailspin-toys`. 2. Crie sua própria cópia do repositório selecionando o botão **Use this template** na página do repositório do laboratório. Em seguida, selecione **Create a new repository**. @@ -27,6 +34,8 @@ Para criar uma cópia do repositório para o código que você desenvolverá, cr > > Quando você cria o repositório a partir do modelo, um backlog de issues do GitHub é criado automaticamente. Você trabalhará com essas issues durante todo o workshop e não precisará criar nada por conta própria. +Aguarde o término do fluxo de criação inicial de issues e verifique na aba **Issues** se aparecem **Allow users to filter games by category and publisher** e **Update our repository coding standards**. Use seus títulos e URLs reais nas lições, não números de issue presumidos. Se o backlog estiver ausente, examine o resultado do fluxo antes de prosseguir. + ## Criar um codespace Agora, você usará um codespace para concluir as lições do laboratório. @@ -53,6 +62,8 @@ A criação do codespace levará alguns minutos, embora ainda seja muito mais r [codespaces]: https://github.com/features/codespaces [dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers +Quando o codespace estiver pronto, a [Lição 1][next-lesson] abrirá o terminal e verificará o repositório, o ambiente de execução e a autenticação antes de instalar o Copilot CLI. + ## Resumo Parabéns, você criou uma cópia do repositório do laboratório! Você também iniciou a criação do seu codespace, que será usado quando começar a trabalhar com o Copilot CLI. diff --git a/docs/pt-br/cli/1-install-copilot-cli.md b/docs/pt-br/cli/1-install-copilot-cli.md index 65c00b37..acebd40f 100644 --- a/docs/pt-br/cli/1-install-copilot-cli.md +++ b/docs/pt-br/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "Lição 1 - Instalar o GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- O [GitHub Copilot CLI][about-copilot-cli] é um poderoso assistente de programação baseado em agentes que é executado no terminal, permitindo explorar bases de código, gerar código, executar comandos e interagir com ferramentas externas — tudo pela linha de comando. Ele permite delegar tarefas, solicitar alterações e manter o foco. Como você pode imaginar, o primeiro passo é instalar a ferramenta. Felizmente, isso pode ser feito com ferramentas que você já conhece. @@ -21,10 +21,25 @@ Sua equipe está começando a usar agentes de IA para avançar em um backlog cre Antes de instalar o Copilot CLI, você precisa abrir uma janela de terminal no codespace. -1. Volte ao codespace, caso ainda não esteja nele. +1. Volte ao codespace e aguarde o término da configuração. 2. Abra uma janela de terminal pressionando Ctrl+`. 3. Você verá um painel de terminal aparecer na parte inferior da janela do VS Code. +## Confirmar o ambiente do participante + +No terminal do codespace, confirme que você está no próprio repositório Tailspin Toys, não no repositório de conteúdo do workshop. Leia o `README.md` e o `package.json` para conhecer a configuração e os comandos de verificação. O Tailspin Toys atualmente exige Node.js 22.13 ou posterior, as dependências do projeto e o Chromium do Playwright para testes E2E. + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +A GitHub CLI (`gh`) ajudará a examinar PRs e CI. Se faltar autenticação, use `gh auth login` e siga as instruções do navegador. Confirme que sua conta pode enviar branches e criar e integrar PRs neste repositório; políticas da organização podem exigir outro revisor. Resolva pré-requisitos ausentes usando as instruções de configuração do repositório antes de alterar código e revise qualquer instalação antes de autorizá-la. + +A CLI atua na cópia de trabalho em que você a inicia; começar uma conversa não cria automaticamente um worktree isolado. Este workshop usa uma branch por marco de PR. Você integrará primeiro as avaliações por estrelas e a demonstração de instruções e manterá a mesma branch de filtragem durante as Lições 4–8. + ## Instalar o Copilot CLI Você pode instalar o Copilot CLI por [npm][install-npm], [WinGet][install-winget] e [Homebrew][install-homebrew]. Como o GitHub Codespaces já inclui o Node.js, você usará o npm para instalar o Copilot CLI. @@ -35,7 +50,7 @@ Você pode instalar o Copilot CLI por [npm][install-npm], [WinGet][install-winge node --version ``` - Você deve ver a versão 22 ou posterior, por exemplo `v22.x.x`. + O Tailspin Toys exige a versão 22.13 ou posterior, mesmo que o requisito da própria CLI seja diferente. Siga as instruções de configuração do repositório do participante se a sua versão for antiga demais. 2. Instale o Copilot CLI globalmente no codespace com npm: @@ -51,8 +66,8 @@ Você pode instalar o Copilot CLI por [npm][install-npm], [WinGet][install-winge Você deve ver o número da versão exibido, por exemplo `v1.0.XX`. -> [!TIP] -> Se você encontrar erros de permissão, talvez precise usar `sudo npm install -g @github/copilot` em alguns sistemas. No entanto, isso não deve ser necessário no GitHub Codespaces. +> [!NOTE] +> Se a instalação falhar por erro de permissão, examine a configuração do npm ou peça ajuda à pessoa que conduz o workshop, em vez de executar novamente um comando desconhecido com privilégios elevados. ## Autenticar com o GitHub @@ -85,22 +100,39 @@ Agora que você está no prompt do Copilot CLI pela primeira vez, vamos confiar 2. Neste workshop, selecione **Yes, and remember this folder for future sessions**, já que você trabalhará neste repositório ao longo de toda a atividade. 3. Faça uma pergunta simples ao Copilot para verificar se tudo funciona: - ``` - What files are in this project? + ```plaintext + Quais arquivos existem neste projeto? ``` 4. O Copilot deverá explorar o repositório e fornecer um resumo da estrutura do projeto. 5. Experimente o comando `/help` para ver os comandos de barra disponíveis: - ``` + ```text /help ``` -6. Saia do Copilot CLI digitando o comando a seguir no terminal. Voltaremos ao Copilot CLI em uma lição futura. +6. Saia desta sessão digitando o comando a seguir no prompt do Copilot. Você iniciará uma sessão nova para a primeira alteração. + ```text + /exit ``` - exit - ``` + +## Entender modos e permissões + +O Copilot CLI trabalha no diretório e na branch Git em que você o inicia. Confiar em um diretório permite usar o contexto do repositório; isso não equivale a aprovar todas as ações de ferramentas. Revise solicitações de permissão para alterações de arquivos, comandos de shell e operações do GitHub. + +Inicie as lições de código a partir da raiz do repositório do participante com: + +```bash +copilot --enable-all-github-mcp-tools +``` + +O servidor MCP do GitHub é integrado. Essa opção expõe todas as suas ferramentas para trabalhar com issues e PRs; autenticação, permissões do repositório e aprovações de ferramentas continuam se aplicando. Ela não autoriza um commit ou PR por si só. + +Use Shift+Tab para alternar entre os modos padrão **Interactive**, **Plan** e **Autopilot**. Verifique o indicador de modo antes de enviar uma solicitação. Você manterá Interactive nas primeiras alterações, planejará a filtragem antes de criá-la e voltará explicitamente a Interactive antes de criar e revisar personalizações. + +> [!CAUTION] +> As configurações de modo e permissão são diferentes. O Autopilot continua trabalhando de forma autônoma; `--allow-all` e seu alias `--yolo` concedem todas as permissões de ferramentas, caminhos e URLs. Este workshop não exige iniciar todas as sessões com permissões irrestritas. Revise o escopo antes de conceder acesso, mesmo dentro de um codespace. ## Resumo e próximos passos @@ -111,7 +143,7 @@ Parabéns! Você instalou e autenticou o GitHub Copilot CLI com sucesso. Você a - confiar em um diretório para o Copilot CLI trabalhar com ele. - verificar se a instalação está funcionando corretamente. -Agora que o Copilot CLI está instalado, vamos fornecer ao Copilot algum contexto sobre o projeto. Continue para a [Lição 2 - Instruções personalizadas com a CLI][next-lesson]. +Agora que o Copilot CLI está instalado, faça uma alteração pequena e revisável na [Lição 2 - Adicionar avaliações por estrelas: uma melhoria rápida][next-lesson]. ## Recursos @@ -120,7 +152,7 @@ Agora que o Copilot CLI está instalado, vamos fornecer ao Copilot algum context - [Usar o Copilot CLI][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/pt-br/cli/10-review.md b/docs/pt-br/cli/10-review.md new file mode 100644 index 00000000..2e0b3f49 --- /dev/null +++ b/docs/pt-br/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "Lição 10 - Revisão e próximos passos" +description: "Revise o fluxo de desenvolvimento compartilhado, os ativos reutilizáveis e os três marcos de pull request da CLI." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Você usou o Copilot CLI para passar de uma pequena alteração a um recurso planejado com verificação reutilizável. A configuração nas Lições 0–1 preparou seu ambiente; os nove módulos principais nas Lições 2–10 ensinaram um fluxo completo de desenvolvimento. + +## Revisar os três marcos de PR + +| Marco | Resultado integrado | Hábito de revisão | +| --- | --- | --- | +| PR 1: avaliações por estrelas | O `starRating` existente aparece nos cards dos jogos, incluindo `No rating yet` para `null` | Manter a alteração delimitada e verificar ambos os casos | +| PR 2: instruções personalizadas | Uma convenção de documentação específica e uma pequena demonstração em código real | Verificar se as instruções melhoram código real, não apenas exemplos no chat | +| PR 3: filtragem e verificação | Filtragem, a skill quality-checks, o perfil de QA e os testes associados | Revisar todos os checkpoints, as evidências atuais de QA e a CI antes do merge | + +Os dois primeiros PRs foram integrados antes de iniciar o próximo marco a partir de `main` atualizado. As Lições 4–8 compartilharam uma branch e uma cópia de trabalho. Commits de checkpoint preservaram o progresso sem criar um PR para cada módulo. A lição de controles não iniciou outro recurso ou PR. + +## Revisar os ativos compartilhados + +Estes são os mesmos resultados principais do [workshop do aplicativo Copilot][app-workshop], alcançados por uma interface de terminal: + +- **As instruções do repositório** explicam o contexto e os padrões do projeto; instruções com escopo de caminho acrescentam detalhes para os arquivos relevantes. +- **A implementação de filtragem e os testes** atendem à issue e aos esclarecimentos aprovados durante o planejamento. +- **A skill quality-checks** reúne instruções reutilizáveis e scripts reais de shell que executam as quatro verificações do projeto. +- **A configuração do MCP do Playwright** fornece ferramentas de navegador para observação direta. Neste fluxo da CLI, ela fica na configuração do usuário, não no PR do recurso. +- **O agente personalizado de QA** define um papel reutilizável que parte dos requisitos, verifica a cobertura, usa a skill e as ferramentas de navegador e relata resultados verdadeiros. +- **O PR e as evidências de verificação** conectam as alterações revisadas aos resultados de testes, observações no navegador, limitações e CI. + +Uma skill é mais do que uma lista de comandos, e um perfil é mais do que um nome de arquivo. Você examinou os ativos gerados, confirmou a execução real e selecionou o agente personalizado antes de confiar no relatório. + +## Distinguir as finalidades da validação + +O planejamento esclareceu os requisitos antes da implementação. O Autopilot executou esse plano delimitado; voltar a Interactive restabeleceu pontos deliberados de revisão antes de criar personalizações. + +A implementação usou as verificações npm existentes antes de haver uma skill. A lição da skill comprovou que seus scripts incluídos e o encaminhamento de argumentos funcionavam. O MCP demonstrou interação direta com o navegador em vez de repetir uma suíte completa. QA combinou critérios, cobertura, evidências de navegador e as quatro verificações executadas pela skill. O PR reutilizou os resultados atuais de QA enquanto a CI verificou a revisão enviada. + +Falhas e bloqueios são resultados úteis. Ferramentas de navegador ausentes, testes ignorados, servidores desatualizados ou um requisito não resolvido significam **NO-GO**, não permissão para reduzir o padrão. Adições de testes se justificam por lacunas reais; não adicionar testes é correto quando a cobertura existente é adequada. + +## Levar estes hábitos adiante + +- Forneça ao Copilot a issue, o motivo da alteração e limites claros. +- Revise os planos antes de aprovar trabalho autônomo. +- Examine instruções, skills e perfis gerados antes de executá-los. +- Saiba a qual cópia de trabalho, branch, servidor e revisão um resultado se refere. +- Use a menor correção justificada e atualize as evidências após alterações. +- Mantenha explícitas as instalações, ações destrutivas, compartilhamentos e merges de PR. + +## Continuar aprendendo + +O [workshop do aplicativo Copilot][app-workshop] alcança os resultados compartilhados por sua interface gráfica e adiciona um marco de canvas. O [workshop do VS Code][vscode-workshop] e o [workshop do agente de nuvem][cloud-workshop] exploram outras formas de trabalhar com agentes. + +Use o [Awesome Copilot][awesome-copilot] para encontrar exemplos de instruções, skills e agentes personalizados. Os [exemplos de skills da Lição 5][skill-examples] incluem fluxos de contribuição, documentos de requisitos, diagramas e testes de navegador. Revise os pré-requisitos e o comportamento antes de adotar conteúdo da comunidade. + +Para referência diária, consulte a [referência de comandos da CLI][cli-reference], a [documentação de skills de agente][agent-skills] e a [documentação de agentes personalizados][custom-agents]. Continue experimentando em tarefas delimitadas e compartilhe apenas material revisado por canais aprovados. + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#mais-exemplos-de-skills +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/pt-br/cli/2-add-star-rating.md b/docs/pt-br/cli/2-add-star-rating.md new file mode 100644 index 00000000..53f7a879 --- /dev/null +++ b/docs/pt-br/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "Lição 2 - Adicionar avaliações por estrelas: uma melhoria rápida" +description: "Exiba as avaliações existentes dos jogos, revise e valide a alteração e integre seu primeiro pull request." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Comece com uma pequena alteração que você possa entender e verificar. O Tailspin Toys já armazena o `starRating` de cada jogo e o mostra na página de detalhes. Você exibirá esse valor existente nos cards dos jogos, incluindo uma mensagem clara quando um jogo não tiver avaliação. + +Nesta lição, você vai: + +- solicitar uma alteração específica em uma sessão Interactive da CLI. +- examinar o diff e verificar cards com e sem avaliação. +- fazer commit, abrir, revisar e integrar o PR 1. + +## Cenário + +Os visitantes podem ver as avaliações na página de detalhes de um jogo, mas não compará-las ao explorar o catálogo. A Tailspin Toys quer exibir as avaliações existentes nos cartões, com um estado claro para jogos sem avaliação. Essa pequena alteração permite praticar como solicitar, revisar e entregar trabalho antes de enfrentar um recurso maior. + +## Iniciar o primeiro marco + +Na raiz do repositório do participante, confirme que a árvore de trabalho está limpa, atualize `main` e crie uma branch. Se `git status` mostrar alterações inesperadas, resolva-as antes de mudar de branch; não as descarte. + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +Confie no repositório quando solicitado. Verifique se está no modo **Interactive** e use `/model` para examinar os modelos disponíveis ou selecionar **Auto**. Revise as aprovações de ferramentas conforme aparecerem. + +## Solicitar a alteração + +Envie este prompt: + +```plaintext +Nos cards dos jogos, mostre a avaliação por estrelas de cada jogo. O tipo Game já inclui um campo starRating: um número em uma escala de cinco, ou null quando o jogo ainda não foi avaliado. Exiba-o em cada card em src/components/GameCard.astro e, quando starRating for null, mostre "No rating yet". Mantenha a alteração pequena e não reestruture o layout do card. + +Examine e siga as instruções do repositório. Use o modelo de dados existente; não adicione uma API de avaliações, um novo esquema ou um recurso não relacionado. Adicione ou atualize os testes adequados para os casos com e sem avaliação. Não faça commit, push nem abra um pull request ainda. +``` + +O Copilot deve examinar o tipo e o componente existentes antes de editar. Leia a atividade das ferramentas, além da resposta final. Um resumo confiante não comprova que a implementação está correta. + +## Revisar e validar + +1. Digite `/diff` e examine todos os arquivos alterados no editor ou na visualização de diff. +2. Confirme que o card usa o `starRating` existente, exibe um valor em uma escala de cinco e mostra `No rating yet` para `null`. Uma verificação baseada apenas na conversão do valor para verdadeiro ou falso pode tratar incorretamente o zero numérico como ausência de avaliação. +3. Verifique se a alteração preserva o layout do card e dá à avaliação um rótulo de texto significativo, em vez de depender apenas de uma estrela ou cor. +4. Peça ao Copilot que verifique a alteração usando as verificações existentes: + + ```plaintext + Examine package.json e a configuração de testes e execute lint, verificações de tipos e os testes de unidade ou E2E existentes adequados a esta alteração de card. Verifique tanto as avaliações numéricas quanto a alternativa para null; relate os comandos exatos e os resultados, incluindo lacunas de cobertura ou verificações bloqueadas. Não instale nada, não mude de branch, não faça commit, push nem abra um PR. + ``` + +5. Revise a saída dos comandos e as alterações de testes. Resolva falhas antes da entrega; pergunte antes de instalar pré-requisitos ausentes. + +Para observar o card em um navegador, abra um segundo terminal nesta mesma cópia de trabalho e execute: + +```bash +npm run dev +``` + +Abra a porta encaminhada no painel **Ports** do codespace. Examine os cards avaliados na página inicial. Se os dados iniciais atuais não tiverem exemplo sem avaliação, exija um teste automatizado com dados que cubram `null`; não afirme que observou um card sem avaliação. Pare o servidor de desenvolvimento com Ctrl+C no terminal dele antes de verificações E2E ou de sair da lição. Os testes automatizados do Playwright não devem reutilizar um servidor de outra cópia de trabalho. + +## Criar e integrar o PR 1 + +Após revisar a alteração e passar nas verificações, autorize este marco separadamente: + +```plaintext +Revise o diff atual e os resultados das verificações. Faça commit apenas da alteração revisada de avaliações por estrelas e seus testes, envie a branch atual e crie um pull request para main usando o modelo de PR deste repositório, se existir. Inclua o resumo da alteração e os resultados reais de verificação. Não integre o PR nem comece outra tarefa. +``` + +Abra a URL retornada do PR. Examine **Files changed** e os resultados das verificações, não apenas o resumo do agente. Revise as definições dos fluxos de trabalho do repositório Tailspin ao interpretar a CI; ela não substitui sua observação no navegador. Resolva falhas e verifique novamente o código alterado. + +Quando o PR atender aos requisitos de revisão e verificação do repositório, selecione **Merge pull request** e confirme o merge no GitHub. Se a proteção de branch exigir outro revisor, aguarde essa aprovação. Confirme que o PR está **Merged** antes de continuar. + +Saia da sessão do Copilot com `/exit`. Na próxima lição, você atualizará o `main` local antes de criar a branch de instruções; não a inicie a partir desta branch de recurso ainda não integrada. + +## Resumo e próximos passos + +Você concluiu o primeiro ciclo: um prompt com escopo limitado, código revisado, evidências de verificação e um PR integrado. Em seguida, [oriente o Copilot com instruções personalizadas][next-lesson] e demonstre uma convenção de documentação em um segundo PR pequeno. + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/pt-br/cli/2-custom-instructions.md b/docs/pt-br/cli/2-custom-instructions.md deleted file mode 100644 index 20837dcf..00000000 --- a/docs/pt-br/cli/2-custom-instructions.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -title: "Lição 2 - Instruções personalizadas (Copilot CLI)" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[Lição anterior: Instalar o Copilot CLI ←][previous-lesson] · [Próxima lição: Gerar código com a CLI →][next-lesson] - -O contexto é essencial ao trabalhar com IA generativa. Se uma tarefa precisar ser executada de uma maneira específica — ou se houver informações de contexto que o Copilot deva conhecer — você deve garantir que esse contexto esteja disponível. Há várias ferramentas para ajudar o Copilot, e você as explorará ao longo deste workshop. Vamos começar pelos [arquivos de instruções][instruction-files], que normalmente se concentram em como o próprio código deve ser estruturado. Isso ajuda o Copilot a entender não apenas *o que* você quer, mas também *como* o código deve ser organizado. - -Nesta lição, você irá: - -- explorar como o contexto específico do projeto, as diretrizes de programação e os padrões de documentação chegam ao Copilot por meio de instruções personalizadas do repositório e de arquivos de instrução com escopo por caminho, -- gerar a primeira parte dos dados de filtragem (um helper de editoras) com as instruções *atuais* em vigor, -- adicionar um novo padrão válido para todo o repositório em `.github/copilot-instructions.md`, -- executar um prompt de acompanhamento e observar o código regenerado adotar o novo padrão, -- fazer commit das atualizações de instruções e do helper para que a próxima lição possa se apoiar nelas. - -> [!CAUTION] -> O código gerado pode divergir de alguns dos padrões que você definir. O Copilot é não determinístico. O objetivo é observar a *tendência* de mudança de comportamento após atualizar as instruções, e não reproduzir a saída caractere por caractere. - -## Arquivos de instruções - -### Cenário - -Como toda boa equipe de desenvolvimento, a Tailspin Toys tem um conjunto de diretrizes e requisitos para as práticas de desenvolvimento. Entre eles: - -- A camada de dados sempre precisa de testes unitários. -- A interface do usuário deve usar modo escuro e ter um visual moderno. -- A documentação deve ser adicionada ao código na forma de comentários TSDoc. -- Um bloco de comentários deve ser adicionado ao início de cada arquivo para descrever o que ele faz. - -Com o uso de arquivos de instruções, você garantirá que o Copilot tenha as informações corretas para executar as tarefas de acordo com as práticas destacadas. - -### Instruções personalizadas - -As instruções personalizadas permitem fornecer contexto e preferências ao Copilot, para que ele entenda melhor seu estilo de programação e seus requisitos. Esse é um recurso poderoso para orientar o Copilot a gerar sugestões e trechos de código mais relevantes. Você pode especificar suas convenções de programação preferidas, bibliotecas e até os tipos de comentários que gosta de incluir no código. É possível criar instruções para todo o repositório ou para tipos específicos de arquivo, oferecendo contexto no nível da tarefa. - -Há dois tipos de arquivos de instruções: - -- `.github/copilot-instructions.md`, um único arquivo de instruções enviado ao Copilot em **toda** solicitação do repositório. Esse arquivo deve conter informações no nível do projeto — contexto relevante para a maioria das solicitações enviadas ao Copilot por chat ou pela CLI. Isso pode incluir a stack usada, uma visão geral do que está sendo criado, boas práticas e outras orientações globais. -- Arquivos `.github/instructions/*.instructions.md` podem ser criados para tarefas ou tipos de arquivo específicos. Você pode usá-los para fornecer orientações para determinadas linguagens, como TypeScript ou Astro, ou para tarefas como criar um componente de UI ou um novo conjunto de testes unitários. - -> [!NOTE] -> Ao trabalhar no IDE, os arquivos de instruções são usados apenas para geração de código no Copilot Chat — não para autocompletar nem para sugestões da próxima edição. -> -> O Copilot Chat, o Copilot CLI e o agente de nuvem do Copilot usam tanto os arquivos no nível do repositório quanto os arquivos `*.instructions.md` (com frontmatter `applyTo`) ao gerar código. -> -> Por fim, o Copilot [também oferece suporte a arquivos de instruções que seguem outros padrões][custom-instructions-support], incluindo arquivos `AGENTS.md` e `CLAUDE.md`. - -### Boas práticas para gerenciar arquivos de instruções - -Uma discussão completa sobre como criar arquivos de instruções está além do escopo deste workshop. Ainda assim, os exemplos fornecidos no projeto de exemplo mostram uma abordagem representativa. Em alto nível: - -- Mantenha as instruções em `copilot-instructions.md` focadas em orientações no nível do projeto, como uma descrição do que está sendo criado, a estrutura do projeto e padrões globais de programação. -- Use arquivos `*.instructions.md` para fornecer instruções específicas para tipos de arquivo (testes unitários, componentes Astro, a camada de dados) ou para tarefas específicas. -- Use linguagem natural. Mantenha as orientações claras. Forneça exemplos de como o código deve — e não deve — ser escrito. - -Não existe uma forma única de criar arquivos de instruções, assim como não existe uma forma única de usar IA. Com experimentação, você descobrirá o que funciona melhor para o seu projeto. - -> [!TIP] -> Todo projeto que usa o GitHub Copilot deveria ter uma coleção robusta de arquivos de instruções. Ao explorar os arquivos deste projeto, você pode notar que há instruções para vários tipos de tarefas, incluindo [atualizações de UI][ui-instructions] e [Astro][astro-instructions]. -> -> O Copilot também pode ajudar a gerar arquivos de instruções para você. Cada superfície expõe isso de uma forma diferente, por exemplo **Configure Chat → Generate Agent Instructions** no VS Code ou `/init` no Copilot CLI — a lição do ambiente em que você está destacará isso quando for relevante. -> -> Procura modelos ou um ponto de partida? Explore o [awesome-copilot][awesome-copilot], um repositório repleto de arquivos de instruções, agentes personalizados e outros recursos. - -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support - -## Explorar os arquivos de instruções personalizadas deste projeto - -Reserve um momento para ler os arquivos de instruções incluídos neste repositório — há um `copilot-instructions.md` principal e uma coleção de arquivos `*.instructions.md` para várias tarefas. Abra-os no editor ou na interface web do GitHub. - -1. Abra `.github/copilot-instructions.md`. -2. Explore o arquivo e observe a breve descrição do projeto, além de seções como **Agent notes**, **Code standards**, **Scripts** e **Repository Structure**. Em **Code standards**, observe a orientação aninhada de **GitHub Actions Workflows**. Tudo isso se aplica a qualquer interação sua com o Copilot. -3. Abra a pasta `.github/instructions` e explore seu conteúdo. Observe que há instruções para arquivos Astro, para a camada de dados com Drizzle, para testes e muito mais. -4. Abra `.github/instructions/unit-tests.instructions.md`. Observe o campo `applyTo` no topo — ele define um glob (relativo à raiz do repositório) que determina a quais arquivos as instruções se aplicam. Aqui, qualquer arquivo de teste TypeScript, por exemplo um que corresponda a `**/*.test.ts`, será incluído. -5. Observe as instruções específicas para criar testes unitários neste projeto. -6. Por fim, abra `.github/instructions/drizzle.instructions.md` e role até o final. Observe os links para outros arquivos de instruções, como `unit-tests.instructions.md`, e para arquivos existentes no projeto. Isso permite dividir conjuntos maiores de instruções em arquivos menores e reutilizáveis, além de apontar o Copilot para exemplos a serem seguidos na geração de código. (Nesse caso, os caminhos são relativos ao arquivo de instruções, e não à raiz do repositório.) - -> [!NOTE] -> A seção **Code formatting requirements** em `copilot-instructions.md` documenta os padrões de programação do projeto, mas ainda não exige documentação no código. Nas próximas etapas, você adicionará regras para comentários TSDoc e cabeçalhos de comentário no nível do arquivo. - -## Criar uma branch - -Você fará alterações no código, então crie uma branch para trabalhar. - -1. No terminal do codespace, crie e troque para uma nova branch: - - ```bash - git checkout -b update-custom-instructions - ``` - -2. Confirme que o Copilot CLI está instalado e autenticado: - - ```bash - copilot --version - ``` - - Se o comando não for encontrado ou se você ainda não tiver feito login, volte para a [Lição 1 - Instalar o GitHub Copilot CLI](../1-install-copilot-cli/). - -## Usar o Copilot CLI *antes* de atualizar as instruções - -Para ver o impacto das instruções personalizadas, comece gerando código com as instruções atuais em vigor. Mais tarde, você atualizará o arquivo e executará um prompt de acompanhamento. - -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. - -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Verifique se a sessão do Copilot CLI está em execução a partir da **raiz do repositório**, para que ela carregue `.github/copilot-instructions.md` automaticamente. -2. No prompt do Copilot CLI, peça que ele gere o helper de editoras que a UI de filtragem usará: - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -3. O Copilot CLI explorará o projeto, proporá um plano e escreverá o arquivo nesta sessão com `--yolo`. Acompanhe as alterações na saída do terminal e depois revise o resultado no editor. -4. Abra no editor o arquivo gerado `src/lib/publishers.ts`. -5. Observe que o helper é uma função tipada que recebe um cliente `db` como primeiro argumento e retorna um array tipado de editoras — isso vem das convenções da camada de dados em `.github/instructions/drizzle.instructions.md` (que se aplica a `src/lib/*.ts`). -6. Observe que no código gerado **faltam** comentários TSDoc e um cabeçalho de comentário no nível do arquivo. - -> [!CAUTION] -> O Copilot é probabilístico — há uma chance de ele adicionar comentários de documentação mesmo sem receber essa instrução. Se isso acontecer, tudo bem. O principal aprendizado continua sendo a melhora de *consistência* depois da atualização das instruções. - -## Adicionar um novo padrão ao repositório - -Como destacado anteriormente, `.github/copilot-instructions.md` foi criado para fornecer informações no nível do projeto ao Copilot. Vamos garantir que os padrões de programação do repositório estejam documentados para melhorar as sugestões de código. - -1. Abra novamente `.github/copilot-instructions.md`. -2. Localize a seção **Code formatting requirements**, que deve estar perto da linha 27. Observe como ela documenta os padrões de programação do projeto, mas ainda não traz nenhuma regra para documentação no código, e é por isso que o helper gerado não tinha comentários de documentação. -3. Adicione as linhas de markdown a seguir logo abaixo dos padrões existentes para instruir o Copilot a incluir cabeçalhos de comentário no arquivo e comentários TSDoc: - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. Salve `copilot-instructions.md`. - -> [!TIP] -> Como você viu na lição anterior, arquivos de instruções podem ser criados no nível do repositório (`.github/copilot-instructions.md`) para orientações globais, ou como arquivos `*.instructions.md` para linguagens, tipos de arquivo ou tarefas específicas. O arquivo do repositório é o local certo para padrões válidos em todo o projeto, como a regra de comentários de documentação que você acabou de adicionar. - -## Executar o prompt novamente e observar a mudança - -Agora que as instruções incluem uma regra para comentários de documentação, peça ao Copilot CLI para atualizar o arquivo de editoras que você acabou de gerar. A mesma diretriz de padrões orientará a reescrita. - -1. Envie `/clear` na sessão do Copilot CLI para começar com uma conversa limpa. -2. Envie o prompt a seguir: - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. Aguarde a edição terminar e depois abra novamente `src/lib/publishers.ts`. -4. Observe que o arquivo agora começa com um bloco de comentários parecido com este: - - ```typescript - /** - * Helpers de acesso a dados de editoras para a plataforma de financiamento coletivo Tailspin Toys. - * Fornece funções para recuperar informações de editoras do banco de dados. - */ - ``` - -5. Observe que a função gerada agora inclui um comentário TSDoc parecido com este: - - ```typescript - /** - * Retorna uma lista de todas as editoras com id e nome. - * - * @param db - O cliente de banco de dados Drizzle. - * @returns Uma promessa que resolve para um array de objetos de editora. - */ - ``` - -6. Mantenha esse arquivo atualizado como está. Essa é a primeira parte dos dados em que você se apoiará na próxima lição. - -## Fazer commit e push desta primeira parte da filtragem - -1. No terminal, verifique os arquivos alterados: - - ```bash - git status - ``` - -2. Adicione a atualização das instruções e o helper à área de stage: - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. Faça commit das alterações: - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. Envie a branch: - - ```bash - git push -u origin update-custom-instructions - ``` - -## Resumo e próximos passos - -Você explorou como o Copilot recebe contexto dos arquivos de instruções deste projeto e depois usou o Copilot CLI para: - -- gerar a base de um helper de acesso a dados de editoras para a filtragem com as instruções *existentes*, -- adicionar um novo padrão válido para todo o repositório em `.github/copilot-instructions.md`, -- executar um prompt de acompanhamento e observar o código regenerado adotar o novo padrão, -- fazer commit e push tanto da atualização das instruções quanto da base do helper. - -Em seguida, você aplicará essas instruções ao implementar trabalho do backlog na [lição de geração de código][next-lesson]. - -## Recursos - -- [Arquivos de instruções para personalização do GitHub Copilot][instruction-files] -- [Boas práticas para criar instruções personalizadas][instructions-best-practices] -- [5 dicas para escrever instruções personalizadas melhores para o Copilot][copilot-instructions-five-tips] -- [Awesome Copilot — uma coleção de arquivos de instruções e outros recursos][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ diff --git a/docs/pt-br/cli/3-custom-instructions.md b/docs/pt-br/cli/3-custom-instructions.md new file mode 100644 index 00000000..8192969f --- /dev/null +++ b/docs/pt-br/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "Lição 3 - Orientar o Copilot com instruções personalizadas" +description: "Adicione uma convenção de documentação específica, demonstre-a em código existente e integre o segundo pull request." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +O contexto ajuda o Copilot a entender não apenas *o que* criar, mas *como* sua equipe espera que o código seja escrito. Você adicionará uma convenção de documentação específica, observará seu efeito em código real e integrará as instruções e a demonstração juntas como PR 2. + +Nesta lição, você vai: + +- explorar instruções gerais do repositório e com escopo de caminho. +- adicionar um padrão de documentação sem implementar a filtragem antes da hora. +- demonstrar o padrão em uma pequena função auxiliar ou componente existente. +- validar e integrar o marco de instruções. + +## Cenário + +A equipe da Tailspin Toys quer que a documentação útil do código seja uma convenção repetível, não uma solicitação que alguém precise lembrar em cada conversa. Você adicionará o padrão às instruções do repositório e o demonstrará no código existente, sem mudar o comportamento nem começar a filtragem antes da hora. + +## Explorar as instruções + +O repositório já contém dois tipos úteis de instruções: + +- `.github/copilot-instructions.md` fornece contexto geral do repositório, como tecnologias, estrutura e práticas comuns. +- `.github/instructions/*.instructions.md` fornece orientações de escopo limitado. Um glob `applyTo` no frontmatter identifica os arquivos aos quais as instruções se aplicam. + +Abra estes arquivos no editor: + +1. Leia `.github/copilot-instructions.md` e localize os padrões atuais de código e verificação. +2. Explore `.github/instructions/`, incluindo as orientações de Astro, camada de dados e testes. +3. Em `unit-tests.instructions.md`, examine o padrão `applyTo` e as convenções de teste. +4. Em `drizzle.instructions.md`, examine os padrões de acesso a dados e as referências a exemplos. + +Mantenha as instruções gerais concisas, coloque detalhes específicos de arquivos no arquivo de escopo relevante e evite cópias conflitantes da mesma regra. A [referência de suporte a instruções do GitHub][instruction-support] explica quais formatos cada ambiente suporta. + +> [!NOTE] +> As instruções influenciam a geração; elas não garantem conformidade. Sua revisão verificará tanto o texto das instruções quanto seu efeito no código. Se o Copilot já produzir bons comentários, o objetivo da lição é tornar a convenção explícita e repetível, não forçar uma falha para comparar antes e depois. + +## Partir do PR 1 integrado + +Confirme que o PR de avaliações por estrelas foi integrado. No terminal do repositório do participante, inicie o próximo marco a partir de `main` atualizado: + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +Se a árvore de trabalho não estiver limpa ou a atualização falhar, resolva esse estado antes de continuar. Permaneça no modo **Interactive**. + +Na aba **Issues** do repositório, encontre **Update our repository coding standards** e copie sua URL real. A issue fornece o contexto mais amplo: explicar a intenção, documentar funções exportadas da camada de dados e contratos de componentes e manter os comentários atualizados. Esta lição aborda uma parte limitada da documentação, não uma refatoração de todo o repositório ou a promessa de concluir todos os critérios da issue. + +## Adicionar a convenção de documentação + +Substitua o marcador pela URL real da issue e envie: + +```plaintext +Leia esta issue de padrões de código como contexto: . Examine as instruções existentes do repositório e de escopo limitado. Adicione uma convenção de documentação específica: explique a intenção em vez de repetir o código, documente funções exportadas em db/ e src/lib/ com TSDoc/JSDoc cobrindo propósito, parâmetros e valores de retorno, documente os contratos de Props dos componentes reutilizáveis de Astro e mantenha os comentários atualizados quando o código relacionado mudar. + +Coloque cada regra no arquivo de instruções existente adequado e evite duplicações ou contradições. Preserve os padrões existentes de formatação e lint; inclua um link ou resumo da convenção de documentação em README quando apropriado. Limite esta alteração ao padrão de documentação, não a uma migração de ferramentas de formatação ou reescrita de todo o repositório. Não crie uma skill ou agente, não implemente a filtragem, não faça commit, push nem abra um PR. Pare para que eu possa examinar as instruções antes da demonstração. +``` + +Examine o diff. A convenção deve incentivar comentários úteis, não exigir um cabeçalho genérico em todos os arquivos ou comentários que apenas repitam código óbvio. Peça correções antes de prosseguir. + +## Demonstrar a convenção em código real + +Escolha uma pequena função auxiliar exportada ou um componente reutilizável existente após examinar o repositório. Não precisa ser uma função auxiliar de distribuidoras, e não há exigência de que `src/lib/publishers.ts` já exista. + +Envie: + +```plaintext +Usando as instruções atualizadas, selecione uma pequena função auxiliar exportada ou componente reutilizável de Astro existente que se beneficiaria de uma documentação mais clara. Aplique a convenção diretamente a esse arquivo sem mudar o comportamento em execução ou adicionar filtragem. Explique qual instrução orientou a alteração e pare antes de fazer commit ou abrir um PR. +``` + +Abra o arquivo real alterado. Para uma função auxiliar, verifique se os comentários descrevem corretamente os parâmetros, o valor de retorno e qualquer argumento de banco de dados injetado. Para um componente, verifique se seu contrato de `Props` está documentado. Confirme que a explicação corresponde ao código, em vez de apenas procurar um bloco de comentários. + +> [!TIP] +> Um trecho ilustrativo no chat não é a demonstração: examine uma alteração real do repositório. Se o código selecionado já atender à convenção, escolha outro alvo pequeno existente em que uma melhoria seja justificada, em vez de adicionar comentários redundantes. + +## Validar e integrar o PR 2 + +Peça ao Copilot que valide as alterações revisadas: + +```plaintext +Revise as alterações de instruções e a pequena demonstração de documentação. Confirme que o comportamento em execução não mudou. Examine package.json, execute npm run lint e npm run typecheck:all e execute os testes existentes afetados quando a alteração de código justificar. Relate os comandos exatos e os resultados. Não instale nada, não crie uma skill, não faça commit, push nem abra um PR ainda. +``` + +Resolva falhas e examine o diff final. Depois, autorize o marco: + +```plaintext +Faça commit apenas das instruções de documentação revisadas, da atualização diretamente relacionada de README e da pequena demonstração de código. Envie a branch atual e crie um PR para main seguindo o modelo de PR do repositório. Inclua os resultados de verificação e referencie a issue de padrões de código como contribuição parcial; não use uma palavra-chave de fechamento, a menos que todos os critérios da issue estejam realmente satisfeitos. Não faça o merge nem comece a filtragem. +``` + +Abra a URL do PR, examine **Files changed** e revise a CI. Depois que todas as verificações e revisões obrigatórias passarem, faça o merge no GitHub e confirme que o PR 2 está **Merged**. Saia da sessão da CLI com `/exit`. Não inicie o próximo marco até este PR ser integrado. + +## Resumo e próximos passos + +A convenção de documentação e uma demonstração real agora estão em `main`. Em seguida, você [criará a filtragem com Plan e Autopilot][next-lesson] em uma branch nova baseada nesse estado integrado. + +## Recursos + +- [Adicionar instruções personalizadas ao repositório][repository-instructions] explica orientações gerais e com escopo de caminho. +- [Awesome Copilot][awesome-copilot] oferece exemplos para revisar e adaptar, não adotar cegamente. + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/pt-br/cli/3-generating-code.md b/docs/pt-br/cli/3-generating-code.md deleted file mode 100644 index a2427acd..00000000 --- a/docs/pt-br/cli/3-generating-code.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "Lição 3 - Adicionar recursos ao projeto com o GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Como você pode imaginar, uma das principais tarefas realizadas com o GitHub Copilot CLI é adicionar recursos, funcionalidades e código a um projeto. Vamos pegar uma das issues do seu backlog e pedir ao Copilot que ajude a implementá-la. - -## Cenário - -Chegou a hora de concluir a filtragem no projeto. Você já tem a issue de filtragem no backlog e um helper de base da lição anterior. Vamos fazer o Copilot recuperar os detalhes da issue, considerar o trabalho existente e criar a funcionalidade restante. - -Nesta lição, você irá: - -- usar o modo plan para gerar um plano de implementação da funcionalidade de filtragem. -- gerar o código necessário para adicionar a filtragem ao site com o Copilot. - -Ao final desta lição, você terá adicionado uma nova funcionalidade ao projeto. - -## Usar o modo plan - -Um dos melhores usos da IA é o planejamento. Muitas vezes, você tem uma boa ideia do que quer criar, mas só precisa trocar algumas ideias. Ferramentas de IA podem ajudar a organizar melhor o raciocínio ao fazer perguntas de acompanhamento e analisar diferentes armadilhas ou componentes ausentes. Para apoiar esse processo, o Copilot CLI oferece um modo plan. Além disso, o tempo dedicado ao planejamento ajudará o Copilot a gerar um código que corresponda melhor aos requisitos definidos. - -Você iniciará o processo de criação da nova funcionalidade usando o modo plan no Copilot CLI. - -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. - -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Digite o prompt a seguir no Copilot CLI para criar um plano com base na issue de filtragem: - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -2. O Copilot pode fazer perguntas de acompanhamento enquanto monta o plano. Quando isso acontecer, responda com base em como você implementaria a funcionalidade. -3. Quando o plano for gerado, revise o esboço. Você deverá notar que ele recomenda as mudanças restantes na camada de dados e na interface, além da geração de testes. -4. O Copilot CLI oferecerá a opção de fornecer feedback adicional sobre o plano. Você pode mover o cursor para baixo até a seção indicada e então digitar suas sugestões. O Copilot incorporará suas observações em uma nova versão do plano. -5. Quando estiver satisfeito, selecione a opção oferecida pelo Copilot para começar a criar o novo recurso. - -> [!NOTE] -> Como o Copilot é probabilístico, o texto exato e as opções apresentadas variam. Ainda assim, você verá uma opção para iniciar a implementação semelhante a: -> -> `Yes, and switch to autopilot mode`. -> -> O Copilot pode oferecer a opção de habilitar o [autopilot mode](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot), como mostrado no exemplo acima. O modo autopilot permite que o Copilot CLI avance em uma tarefa sem esperar sua entrada após cada etapa. Depois que você fornece a instrução inicial, o Copilot CLI trabalha de forma autônoma em cada etapa até considerar a tarefa concluída. Como estamos em um ambiente isolado, não há problema em usar o autopilot e permitir todas as ferramentas. - -6. O Copilot começará a gerar os arquivos. - -> [!NOTE] -> Essa operação provavelmente levará vários minutos. Você verá o Copilot editar e criar arquivos, atualizar e gerar testes e executar todos os testes para garantir que tudo funcione. Este é um bom momento para refletir sobre o que você explorou até aqui ou aproveitar uma bebida. - -## Revisar o código - -Todo código gerado por IA deve ser revisado antes de ser enviado para produção. Vamos aproveitar este momento para explorar os arquivos que o Copilot criou e modificou ao implementar o novo recurso. - -1. Use o Copilot CLI para exibir o diff ou as alterações de código usando o comando a seguir no Copilot CLI: - - ``` - /diff - ``` - -2. Observe quais arquivos foram alterados. Use as setas do teclado para alternar entre eles. Você deverá ver atualizações em arquivos como a página de listagem de jogos, onde ficam os novos controles de filtro e a filtragem no cliente, além de `src/lib/games.ts` e testes como `games.test.ts`. Também pode haver atualizações em `publishers.ts` se o Copilot refinar o helper existente para alinhá-lo à implementação completa. - -## Resumo e próximos passos - -Agora você adicionou a funcionalidade de filtragem ao site com a ajuda do Copilot CLI. Em especial, você: - -- usou o modo plan para gerar um plano de implementação da funcionalidade de filtragem. -- gerou o código necessário para adicionar a filtragem ao site com o Copilot. - -Claro, o próximo passo é garantir que tudo funcione. Vamos [testar o recurso com o servidor MCP do Playwright][next-lesson] antes de abrir um pull request. - -## Recursos - -- [Usar o Copilot CLI][using-copilot-cli] -- [Sobre o Copilot CLI][about-copilot-cli] -- [Gerenciamento de contexto no Copilot CLI][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/pt-br/cli/4-build-filtering.md b/docs/pt-br/cli/4-build-filtering.md new file mode 100644 index 00000000..7f541970 --- /dev/null +++ b/docs/pt-br/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "Lição 4 - Criar a filtragem com Plan e Autopilot" +description: "Acorde os requisitos de filtragem, aprove um plano de implementação, valide o código e salve um checkpoint na branch do recurso." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Agora crie o recurso maior: permitir que os usuários filtrem jogos por categoria e distribuidora. Você planejará antes de programar, autorizará explicitamente o **Autopilot**, revisará e testará a implementação e salvará um checkpoint. Esta lição não cria a skill, o agente de QA ou o PR do recurso. + +Nesta lição, você vai: + +- ler a issue de filtragem e esclarecer requisitos ambíguos no modo Plan. +- aprovar explicitamente uma implementação delimitada com Autopilot. +- revisar o diff e os resultados das quatro verificações e salvar um checkpoint. + +## Cenário + +O catálogo da Tailspin Toys está crescendo, e os visitantes precisam filtrar os jogos por categoria e editora. A issue do backlog descreve o recurso, mas detalhes como a combinação de categorias precisam ser acordados antes de programar. Você usará o modo Plan para resolver essas decisões e depois autorizará uma implementação delimitada com Autopilot. + +## Iniciar o marco de filtragem + +Confirme que os PRs 1 e 2 estão integrados. No terminal do repositório do participante: + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +Continue apenas com uma árvore de trabalho limpa e uma atualização bem-sucedida a partir de `main`. As Lições 4–8 usam esta mesma branch e cópia de trabalho. Os próximos commits de checkpoint adicionarão a skill e o perfil de QA; não crie uma branch por lição. + +## Recuperar a issue real + +Encontre **Allow users to filter games by category and publisher** na aba **Issues** do repositório e copie a URL. Não presuma que o nome de arquivo do modelo ou um número de issue identifica a issue na sua cópia. + +A issue atual exige: + +- selecionar uma ou mais categorias. +- filtrar por distribuidora e combinar com as categorias. +- funções auxiliares de acesso a dados em `src/lib/` que suportem ambos os filtros. +- controles acessíveis com navegação por teclado, ARIA apropriado, estados de foco visíveis e atributos `data-testid`. +- cobertura unitária com Vitest para as funções auxiliares e cobertura E2E com Playwright para o comportamento de filtragem. + +Leia a issue atual como fonte de verdade. Mantenha sua URL e todos os esclarecimentos aprovados disponíveis para o prompt de QA da Lição 7. + +## Planejar antes de programar + +Use Shift+Tab para selecionar o modo **Plan**, ou comece com `/plan`. Substitua o marcador da issue e envie: + +```plaintext +Planeje o recurso de filtragem descrito nesta issue: . Leia a issue, as instruções do repositório, as funções auxiliares de acesso a dados existentes, a interface e os testes antes de propor alterações. Trate a cópia de trabalho atual como ponto de partida; não presuma que uma função auxiliar de distribuidoras já foi criada. + +Cubra seleção de múltiplas categorias, filtragem por distribuidora, sua combinação, suporte de acesso a dados, controles acessíveis e cobertura unitária/E2E. Peça que eu esclareça comportamentos não especificados, como a combinação de múltiplas categorias, a limpeza de filtros e resultados vazios; registre as decisões com o plano aprovado. Preserve a arquitetura estática do Astro em vez de introduzir uma API de servidor desnecessária. + +Planeje a implementação na branch atual, incluindo os testes de unidade e E2E necessários e a verificação com npm run lint, npm run test:unit, npm run test:e2e e npm run typecheck:all. Examine primeiro os pré-requisitos e a quem pertence o servidor; relate bloqueios em vez de instalar software ou parar processos não relacionados. + +Inclua estes limites de execução no plano: depois que eu aprovar, implemente apenas o recurso de filtragem e os testes necessários, execute as verificações e pare para que eu possa revisar. Não crie a skill quality-checks, um agente de QA ou outros ativos de lições posteriores. Não mude de branch, não faça commit, push nem abra ou integre um PR. + +Não edite código da aplicação nem comece a implementação até eu aprovar o plano. +``` + +Responda às perguntas de acompanhamento. Não adicione critérios de aceitação ocultos depois: salve as respostas acordadas com a URL da issue para que implementação, verificações no navegador e QA usem os mesmos requisitos. + +Revise se o plano inclui alterações na camada de dados e na interface, testes, controles acessíveis e a convenção de documentação integrada. Confirme que inclui explicitamente as quatro verificações, a parada para revisão e as proibições de criar ativos posteriores do workshop, mudar de branch, fazer commits, pushes e operações de PR. Peça revisões antes da aprovação se faltar algum limite ou critério ou se o plano propuser trabalho fora da issue. + +## Aprovar explicitamente o Autopilot + +Somente depois que o plano incluir o escopo e os limites de execução revisados, use a opção de aprovação **Accept plan and build on autopilot**. Se a sua versão usar outro texto, selecione explicitamente a opção que muda para **Autopilot** e verifique o indicador de modo. A aprovação inicia a execução do plano delimitado; não dependa de um prompt posterior para adicionar limites depois que o trabalho começar. + +> [!CAUTION] +> O Autopilot controla a continuidade do trabalho, não apenas as permissões de ferramentas. Revise a caixa de diálogo de permissões antes de escolher. Permissões completas permitem acesso a ferramentas, caminhos e URLs; permissões limitadas podem bloquear ações que exigem aprovação. Um codespace não dá permissão para expor segredos ou alterar recursos não relacionados. Resolva deliberadamente o acesso bloqueado em vez de tratar verificações ignoradas como aprovadas. + +Monitore o trabalho e os resultados dos comandos. O Autopilot pode pausar em um limite de continuação ou relatar um bloqueio antes de concluir o plano. Revise esse estado antes de autorizar a continuação, preservando o mesmo escopo. + +## Voltar a Interactive e revisar + +Quando a implementação parar, use Shift+Tab para voltar ao modo **Interactive** antes de enviar outros prompts. O Autopilot pode continuar ativo após uma tarefa; não presuma que voltou automaticamente. + +Digite `/diff` e examine todos os arquivos alterados. Compare a implementação com a issue e os esclarecimentos aprovados: + +- Os usuários conseguem selecionar múltiplas categorias, filtrar por distribuidora e combiná-las conforme acordado? +- As funções auxiliares de acesso a dados realmente suportam os filtros, em vez de mudar apenas a interface? +- Os controles têm rótulos significativos, suporte de teclado, foco visível e identificadores de teste estáveis? +- Os testes verificam comportamento, incluindo os casos acordados de limpeza e resultados vazios, sem enfraquecer as asserções existentes? +- O código segue a convenção de documentação e preserva a arquitetura estática da aplicação? + +Revise as evidências das quatro verificações npm. Você ainda não criou `quality-checks`, então essas verificações são executadas diretamente. A configuração E2E do Playwright compila e serve uma prévia; antes de executar a suíte, pare apenas um servidor de desenvolvimento que você iniciou para impedir a reutilização de conteúdo desatualizado. Um conflito de porta ou navegador ausente é um bloqueio a resolver, não motivo para encerrar outro processo ou afirmar que uma verificação passou. + +Peça correções específicas se necessário, execute novamente as verificações afetadas e garanta que a implementação final tenha verificação completa. A observação direta no navegador vem na Lição 6; ela tem uma finalidade diferente desta verificação automatizada. + +## Salvar o checkpoint de implementação + +Quando o diff e os resultados forem satisfatórios, autorize um checkpoint local: + +```plaintext +Revise o diff atual e os resultados de verificação. Crie um commit de checkpoint contendo apenas a implementação de filtragem revisada e seus testes. Mantenha a branch e a cópia de trabalho de filtragem atuais. Não faça push, não abra um PR nem crie a skill ou o agente de QA ainda. +``` + +## Resumo e próximos passos + +Você acordou os requisitos de filtragem, revisou a implementação e os testes e salvou um checkpoint. Registre a revisão testada e mantenha a URL da issue e os esclarecimentos aprovados. Permaneça em **Interactive** e continue nesta mesma cópia de trabalho com a [Lição 5 - Criar e usar uma skill quality-checks][next-lesson]. + +## Recursos + +- [Modo Autopilot e permissões][autopilot] explica a continuação autônoma e a volta a Interactive. +- [Referência de comandos do Copilot CLI][cli-reference] lista os controles de modo e comandos atuais. + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/pt-br/cli/4-mcp.md b/docs/pt-br/cli/4-mcp.md deleted file mode 100644 index a644eecc..00000000 --- a/docs/pt-br/cli/4-mcp.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: "Lição 4 - Testar seu recurso com o servidor MCP do Playwright" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Você acabou de gerar o recurso de filtragem com o Copilot CLI. Antes de abrir um pull request, confirme que tudo funciona no navegador. Em vez de testar o aplicativo manualmente, você conectará o **servidor MCP do Playwright** e deixará o Copilot controlar um navegador real para testar o recurso. - -Nesta lição, você irá: - -- entender o que é o Model Context Protocol (MCP) e como os servidores MCP ampliam o Copilot CLI. -- adicionar o servidor MCP do Playwright ao Copilot CLI. -- pedir ao Copilot que o use para testar manualmente o recurso de filtragem em um navegador. - -## O que é o Model Context Protocol (MCP)? - -O [Model Context Protocol (MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/) fornece aos agentes de IA uma maneira de se comunicar com ferramentas e serviços externos. Ao usar o MCP, agentes de IA podem se comunicar com ferramentas e serviços externos em tempo real. Isso permite acessar informações atualizadas, por meio de recursos, e executar ações em seu nome, por meio de ferramentas. - -Essas ferramentas e esses recursos são acessados por um servidor MCP, que atua como ponte entre o agente de IA e as ferramentas e serviços externos. O servidor MCP é responsável por gerenciar a comunicação entre o agente de IA e as ferramentas externas, como APIs existentes ou ferramentas locais, como pacotes NPM. Cada servidor MCP representa um conjunto diferente de ferramentas e recursos que o agente de IA pode acessar. - -Alguns servidores MCP populares são: - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**: este servidor fornece acesso a um conjunto de APIs para gerenciar seus repositórios do GitHub. Ele permite que o agente de IA execute ações como criar novos repositórios, atualizar os existentes e gerenciar issues e pull requests. -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**: este servidor fornece automação de navegador com Playwright. Ele permite que o agente de IA execute ações como navegar por páginas web, preencher formulários e selecionar botões. - -Há muitos outros servidores MCP disponíveis que fornecem acesso a diferentes ferramentas e recursos. O GitHub mantém um [registro MCP](https://github.com/mcp) para facilitar a descoberta e a contribuição para o ecossistema. - -> [!CAUTION] -> Em termos de segurança, trate servidores MCP como qualquer outra dependência do projeto. Antes de usar um servidor MCP, revise o código-fonte com cuidado, verifique quem o publicou e considere as implicações de segurança. Use apenas servidores MCP em que você confie e tenha cautela ao conceder acesso a recursos ou operações sensíveis. - -> [!NOTE] -> O [GitHub MCP server][github-mcp-server] já vem **integrado** ao Copilot CLI — ele já está disponível sem configuração, e é assim que o Copilot vem lendo e escrevendo no seu repositório ao longo do workshop. Nesta lição, você adicionará um *segundo* servidor, o Playwright, para dar ao Copilot acesso a um navegador. - -## Adicionar o servidor MCP do Playwright - -A forma mais rápida de adicionar um servidor é com o comando interativo `/mcp add`. Você registrará o [Playwright MCP server][playwright-mcp-server], que dá ao Copilot um navegador que ele pode controlar. - -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. - -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Na sua sessão do Copilot CLI, digite: - - ```text - /mcp add - ``` - -2. Um formulário de configuração será exibido. Use Tab para mover entre os campos e preencha-o assim: - - - **Server Name**: `playwright` - - **Server Type**: selecione **Local** (também rotulado como **STDIO**) - - **Command**: `npx @playwright/mcp@latest --headless` - - **Tools**: deixe `*` para permitir todas as ferramentas do servidor - -3. Pressione Ctrl+S para salvar. O servidor será adicionado e ficará disponível imediatamente — não é necessário reiniciar. - -A flag `--headless` instrui o Playwright a executar o navegador sem janela visível, o que é necessário em um codespace, onde não existe uma área de trabalho para exibição. Nos bastidores, isso grava o servidor no arquivo `~/.copilot/mcp-config.json`: - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -4. Confirme que o servidor está registrado e ativo listando seus servidores MCP: - - ```text - /mcp show - ``` - -5. Você deverá ver `playwright` listado ao lado do servidor interno `github`. - -> [!NOTE] -> O projeto Tailspin Toys já usa o Playwright para testes de ponta a ponta, então o navegador de que o Playwright precisa normalmente já está instalado. Se mais tarde o Copilot informar que falta um navegador, peça que ele execute `npx playwright install chromium` e tente novamente. - -## Iniciar o site - -O servidor MCP do Playwright precisa de um aplicativo em execução para testar. Inicie o servidor de desenvolvimento do Astro em um **terminal separado** para que ele continue em execução enquanto você trabalha no Copilot CLI. - -1. Abra um novo terminal no codespace pressionando Ctrl+`. -2. Inicie o site: - - ```bash - npm run dev - ``` - -3. Deixe esse terminal em execução. Quando você vir o banner `Astro server: http://localhost:4321`, o aplicativo estará pronto. - -## Testar o recurso de filtragem - -Volte à sessão do Copilot CLI e peça ao Copilot para testar o recurso. - -O [Playwright MCP server][playwright-mcp-server] dá ao Copilot um navegador real para controlar. Em vez de você verificar manualmente o aplicativo, o agente pode abrir uma página, navegar, aplicar filtros e informar o resultado — depois resumir o que viu. Essa é a maneira mais rápida de confirmar que um recurso se comporta como esperado sem sair da conversa. - -Internamente, o servidor MCP do Playwright trabalha a partir da [árvore de acessibilidade][playwright-mcp-server] da página, em vez de usar capturas de tela. Isso significa que o agente raciocina sobre elementos estruturados e rotulados, como botões, links e itens de lista, da mesma forma que tecnologias assistivas fazem. Assim, uma verificação funcional rápida também funciona como uma checagem básica de acessibilidade. - -Com o servidor conectado e o aplicativo em execução, peça ao Copilot para exercitar o recurso de filtragem que você acabou de criar: - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -O Copilot iniciará um navegador por meio do servidor MCP do Playwright, executará cada etapa e informará o que encontrou. Leia o resumo em comparação com os critérios de aceitação da issue. Se algo parecer incorreto, faça perguntas de acompanhamento ou peça que ele corrija o código antes de abrir um pull request. - -> [!NOTE] -> O aplicativo precisa estar em execução em `http://localhost:4321` para este teste. Se você tiver parado o servidor de desenvolvimento, inicie-o novamente antes de enviar o prompt. Na primeira vez em que o Copilot usar o servidor MCP do Playwright, talvez seja necessário baixar um navegador. Se ele informar que falta um navegador, peça que execute `npx playwright install chromium` e tente novamente. - -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp - -## Resumo e próximos passos - -Parabéns, você usou o servidor MCP do Playwright para testar manualmente o recurso com o Copilot CLI. Para recapitular, você: - -- aprendeu o que é o Model Context Protocol (MCP) e como os servidores MCP ampliam o Copilot CLI. -- adicionou o servidor MCP do Playwright com `/mcp add`. -- pediu ao Copilot que controlasse um navegador e verificasse o recurso de filtragem antes da entrega. - -Agora que você confirmou que o recurso funciona, pode continuar para a próxima lição, na qual [abrirá um pull request com a ajuda de uma skill de agente][next-lesson]. - -## Recursos - -- [O que é MCP e por que todo mundo está falando sobre isso?][mcp-blog-post] -- [Servidor MCP do Microsoft Playwright][playwright-mcp-server] -- [Adicionar servidores MCP ao Copilot CLI][cli-add-mcp] -- [Servidor MCP do GitHub][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers diff --git a/docs/pt-br/cli/5-agent-skills.md b/docs/pt-br/cli/5-agent-skills.md index 058c1cd4..0c3f1468 100644 --- a/docs/pt-br/cli/5-agent-skills.md +++ b/docs/pt-br/cli/5-agent-skills.md @@ -1,121 +1,99 @@ --- -title: "Lição 5 - Usar skills de agente" +title: "Lição 5 - Criar e usar uma skill quality-checks" +description: "Peça ao Copilot que crie verificações de qualidade reutilizáveis com scripts de shell incluídos, examine a skill e execute-a na branch de filtragem." authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -No desenvolvimento de aplicativos, é comum lidar com tarefas repetíveis, como gerar builds, executar testes ou criar pull requests. **Agent Skills** permitem orientar o Copilot — e outros agentes de IA — sobre como executar essas tarefas. Uma skill é uma pasta de instruções, scripts e recursos que o agente pode carregar sob demanda. O [Agent Skills][agent-skills-repo] é um padrão aberto usado por uma variedade de agentes, portanto a mesma skill pode funcionar no Copilot Chat em modo agente, no agente de nuvem do Copilot, no Copilot CLI e no aplicativo GitHub Copilot. +Seu recurso de filtragem está implementado e verificado com os comandos npm existentes. Agora você reunirá essas verificações em uma **skill de agente** reutilizável. Permaneça na mesma sessão e branch de filtragem durante as Lições 4–8; esta lição não cria um pull request. -As skills ficam na pasta `.github/skills` de um projeto, ou globalmente em `~/.copilot/skills`. Cada skill é uma pasta que contém um arquivo `SKILL.md` com frontmatter YAML, incluindo `name` e `description`, seguido das instruções em markdown: +Nesta lição, você vai: -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +- voltar ao modo **Interactive** antes de criar personalizações. +- pedir ao Copilot que crie `quality-checks` e pare para você examiná-la. +- executar as quatro verificações pelos scripts incluídos e comprovar que um argumento que indica um único arquivo de teste seleciona apenas esse arquivo. +- salvar um checkpoint da skill junto com o recurso de filtragem. -As skills também podem incluir subpastas com scripts, assets e material de referência. A estrutura completa é abordada na [especificação de Agent Skills][agent-skills-spec]. +## Cenário -> [!TIP] -> As skills são carregadas dinamicamente. O agente decide qual skill se aplica com base no campo `description` — uma descrição clara e específica para o cenário é o que diferencia uma skill usada de uma skill ignorada. +A Tailspin Toys precisa das mesmas verificações de qualidade sempre que a filtragem muda. Em vez de explicar os comandos e pré-requisitos em cada conversa, a equipe quer uma skill reutilizável. Você vai criá-la, examinar seus scripts e verificar se outra solicitação consegue executar as verificações corretamente. -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification +## Instruções, scripts e recursos -Vamos explorar como uma skill pode garantir que pull requests sigam as especificações definidas pela equipe. +Skills reúnem instruções de tarefas reutilizáveis, scripts executáveis e recursos de apoio que um agente carrega sob demanda. Agentes personalizados definem papéis especializados, instruções e ferramentas disponíveis. Eles são complementares: um agente personalizado pode executar scripts, incluindo os fornecidos com uma skill. -## Cenário +Uma skill do repositório fica em `.github/skills//SKILL.md`, com `name` e `description` no frontmatter e instruções em Markdown. Scripts e outros recursos ficam ao lado desse arquivo. Você pedirá ao Copilot que gere `.github/skills/quality-checks/SKILL.md` e seus scripts incluídos, em vez de copiar uma solução pronta. A [especificação de Agent Skills][skill-spec] descreve o formato. -A equipe tem um conjunto de requisitos para pull requests (PR): +O Copilot usa a descrição de uma skill descoberta para decidir quando carregá-la. Não presuma que uma skill nova seja descoberta imediatamente em uma sessão já aberta; a seção de execução inclui uma alternativa de leitura explícita. Um formato portável não elimina os pré-requisitos do shell ou do projeto. -- mensagens de commit claras, com arquivos agrupados de forma lógica. -- todos os testes devem passar antes da criação de um PR. -- cada PR deve conter as seções a seguir: - - uma descrição do motivo das alterações. - - uma visão geral dos arquivos alterados. - - trechos de blocos de código importantes. - - detalhes das alterações agrupados de forma coerente. +## Criar a skill -Como a equipe está usando o Copilot para gerar código e PRs, ela quer garantir que as ferramentas de IA sigam esses requisitos. +Volte ao modo **Interactive** antes de enviar o prompt. Mantenha a cópia de trabalho e a branch atuais. Se você começou com um modelo antigo que já tem essa skill, examine-a e amplie-a em vez de sobrescrever suas personalizações. -Nesta lição, você irá: +```plaintext +Crie .github/skills/quality-checks/SKILL.md e quatro scripts que encapsulem npm run lint, npm run test:unit, npm run test:e2e e npm run typecheck:all. Leia primeiro package.json, README, a configuração de testes e as instruções do repositório. -- explorar uma skill existente para criar pull requests. -- aprender como as skills são usadas pelo agente de IA. -- criar um PR que siga as diretrizes com a ajuda da skill. +Detecte este ambiente. Crie SOMENTE scripts Bash .sh para macOS/Linux/WSL OU scripts PowerShell .ps1 para Windows nativo; pergunte se houver dúvida. Não crie ambos. Limite os wrappers a resolver a raiz do repositório a partir da própria localização, verificar se o package.json deste projeto está lá e invocar npm. Falhe com uma mensagem clara se a raiz for inválida. Suporte qualquer diretório de trabalho e caminhos com espaços. Preserve a saída e os códigos de saída de falhas, incluindo falhas de comandos nativos do PowerShell. Insira o separador -- do npm exatamente uma vez; quem invocar os scripts deve fornecer os argumentos da ferramenta diretamente, sem outro --. Não gerencie portas nem processos. -## Executar skills +Inclua em SKILL.md um frontmatter com name e description, instruções para executar os quatro wrappers, pré-requisitos, solução de problemas e exemplos portáveis que incluam um arquivo existente de testes de unidade. Todos os exemplos de Bash devem invocar bash explicitamente; nunca contorne a política de execução do PowerShell. Explique a reutilização de servidores do Playwright: pare apenas servidores que você realmente iniciou; caso contrário, pergunte. -As skills são carregadas dinamicamente quando o agente determina que elas são necessárias. A decisão sobre quais skills usar é guiada pela descrição no arquivo `SKILL.md`. Por isso, é importante ter descrições claras que definam o caso de uso da skill. - -## Explorar a skill de PR +Crie apenas a skill e os scripts necessários. Não execute verificações nem sondagens, não instale nada, não altere código da aplicação, não faça commit nem abra um PR. Pare para que eu possa examinar os arquivos. +``` -Como a Tailspin Toys tem um conjunto de requisitos para criar PRs, ela criou uma skill para ajudar ferramentas de IA a gerar PRs que sigam essas diretrizes. Vamos explorar a skill para entender o que ela fará. +## Examinar a skill -1. Abra `.github/skills/make-contribution/SKILL.md`. -2. Observe o nome e a descrição. Perceba como a descrição destaca o cenário em que a skill deve ser usada, isto é, sempre que houver uma solicitação para criar um pull request ou fazer commit de código. -3. Leia a skill inteira. Observe como as regras definem a criação de branches, a geração de commits e o conteúdo do pull request. +1. Abra `.github/skills/quality-checks/SKILL.md` e seus scripts incluídos no editor e examine o diff. +2. Verifique se `name` e `description` descrevem a skill e quando ela se aplica. Leia as instruções, não apenas os metadados. +3. Confirme que a sequência de execução realmente invoca os scripts incluídos em `.github/skills/quality-checks/` para lint, testes de unidade, E2E e verificação de tipos. +4. Examine em cada wrapper a resolução da raiz relativa ao script e uma verificação explícita de que o diretório calculado contém o `package.json` pretendido desta cópia de trabalho. Um comando bem-sucedido porque o npm pesquisa em diretórios ancestrais não comprova que a raiz está correta. Verifique caminhos entre aspas, encaminhamento de argumentos, saída visível e códigos de saída em caso de falha; o PowerShell precisa propagar falhas nativas do npm. +5. Verifique o exemplo documentado de um único arquivo de testes de unidade. O wrapper insere o separador `--` do npm, então quem o invoca passa os argumentos da ferramenta de destino diretamente, sem outro separador. Mantenha as instruções reutilizáveis sem caminhos absolutos da cópia de trabalho específicos de uma máquina. Peça ao Copilot que corrija as lacunas antes de executar qualquer coisa. +6. Limite os scripts à validação da raiz e do manifesto e à execução das verificações npm existentes. As decisões sobre portas e processos pertencem a SKILL.md, não a código de gerenciamento de processos em shell. Confirme que apenas servidores realmente iniciados pelo agente podem ser parados; a correspondência do diretório de trabalho ou do nome do processo não determina a quem ele pertence. Os arquivos entregues devem conter apenas a skill, os wrappers necessários e qualquer helper compartilhado necessário, sem arquivos temporários de sondagem ou depuração. -## Usar a skill +> [!NOTE] +> O Tailspin Toys atualmente exige Node.js 22.13 ou posterior, as dependências do projeto e o Chromium do Playwright para verificações E2E. Confirme os pré-requisitos em README e `package.json` da sua cópia de trabalho. Pré-requisitos ausentes ou uma política de execução do PowerShell que bloqueie a execução precisam de uma resolução aprovada, não de instalação automática, de contorno da política ou de troca silenciosa para npm direto. -Como destacado anteriormente, as skills são invocadas automaticamente pelo Copilot CLI. Portanto, basta pedir que o Copilot crie um PR. +## Executar a skill -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. +Confirme que o servidor de desenvolvimento da lição anterior parou. O Playwright compila e serve uma prévia para E2E, mas sua configuração local pode reutilizar um servidor na porta `4321`. Um servidor de outra cópia de trabalho não é evidência válida para seu recurso. -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. +Se o Copilot CLI oferecer `/quality-checks`, selecione-o para invocar explicitamente a skill descoberta e inclua a solicitação abaixo. Se ela não tiver sido descoberta, envie a mesma solicitação diretamente nesta sessão; ler a skill é uma alternativa suportada nesta lição. -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools +```plaintext +Leia .github/skills/quality-checks/SKILL.md e siga as instruções para validar o recurso de filtragem nesta cópia de trabalho. Primeiro examine o código de cada wrapper para verificar se ele calcula o diretório que contém o package.json pretendido desta cópia de trabalho e falha explicitamente para uma raiz inválida, em vez de depender da descoberta de pacotes em diretórios ancestrais pelo npm. Não mova, renomeie, exclua nem modifique arquivos do repositório para simular falhas. Execute realmente os scripts incluídos para lint, testes de unidade, testes de ponta a ponta e verificações de tipos. Execute também o exemplo documentado de um único arquivo de testes de unidade, passando os argumentos da ferramenta de destino diretamente porque o wrapper é responsável pelo separador -- do npm. Verifique nos resultados do executor de testes se APENAS o arquivo indicado foi executado e relate o nome desse arquivo e a quantidade de arquivos de teste executados. Exibir os argumentos ou retornar o código de saída 0 não comprova, por si só, que a seleção está correta. -1. Peça que o Copilot crie um PR usando o prompt a seguir: +Relate cada invocação de script e seu resultado, incluindo falhas, verificações ignoradas ou pré-requisitos ausentes. Não substitua silenciosamente um script inutilizável da skill por comandos npm diretos. Identifique a cópia de trabalho e o servidor em teste, pare apenas os servidores que você iniciou e pergunte antes de instalar algo ou parar outro processo. Não altere código da aplicação, não mude de branch, não faça commit, push nem abra um pull request. +``` - ``` - Can you please create a pull request for me! - ``` +Examine as chamadas de ferramentas e a saída. Os quatro scripts precisam realmente executar; uma descrição das verificações ou uma verificação ignorada não equivale à aprovação. Para o exemplo de um único arquivo, compare o nome do arquivo solicitado com os resultados reais por arquivo do executor e a quantidade relatada: apenas esse arquivo deve executar. Exibir os argumentos ou retornar o código de saída 0 é insuficiente se outros arquivos também executaram. Uma falha é evidência útil: corrija a skill ou resolva o bloqueio de configuração com aprovação e execute novamente as verificações afetadas. Não pare processos não relacionados nem force a resolução de um conflito de porta. -2. O Copilot reconhecerá a solicitação. Após alguns instantes, você verá o Copilot indicar que está usando a skill **make-contribution**. +## Salvar um checkpoint -3. O Copilot seguirá as instruções da skill. Ele começará executando os testes, depois criará uma branch, fará commits e, por fim, abrirá o PR. -4. Quando o PR for criado, volte ao repositório e abra-o. Observe como as seções seguem as diretrizes definidas na skill e atendem aos requisitos da equipe. -5. Antes de passar para a próxima lição, redefina seu workspace local para uma branch nova criada a partir de `main`, para manter o trabalho de acessibilidade separado deste PR de filtragem: +Após revisar a skill e seus resultados, autorize um checkpoint local: - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +```plaintext +Revise o diff atual e crie um commit de checkpoint apenas para os arquivos da skill quality-checks. Mantenha a branch de filtragem existente. Não faça push nem crie um pull request. +``` ## Resumo e próximos passos -Com a ajuda de uma skill de agente, você criou um novo PR que segue requisitos documentados. Você: +Você criou, examinou e executou uma skill quality-checks reutilizável, incluindo seu exemplo de teste de um único arquivo. Os arquivos da skill acompanharão a filtragem, o perfil de QA e os testes associados no PR do recurso na Lição 8. Continue nesta mesma cópia de trabalho com a [Lição 6 - Validar a funcionalidade com o MCP do Playwright][next-lesson]. -- explorou uma skill existente para criar pull requests. -- aprendeu como as skills são usadas pelo agente de IA. -- criou um PR que segue as diretrizes com a ajuda da skill. +## Mais exemplos de skills -As skills são perfeitas para tarefas, mas, para operações mais robustas, vale aproveitar [agentes personalizados][next-lesson], que serão o próximo tópico. +Estes exemplos da comunidade são referências, não tarefas adicionais. Revise seus pré-requisitos e comportamento antes de adotá-los: -## Recursos +- [Fluxo de contribuição: `make-repo-contribution`][contribution-example]. +- [Documentos de requisitos: `prd`][prd-example]. +- [Diagramas e um script de exportação incluído: `drawio`][drawio-example]. +- [Testes de navegador: `webapp-testing`][browser-example]. -- [Sobre Agent Skills][about-agent-skills] -- [Especificação de Agent Skills][agent-skills-spec] -- [Repositório Agent Skills][agent-skills-repo] -- [Agent Skills no awesome-copilot][awesome-copilot-skills] +O exemplo original de contribuição se chama `make-repo-contribution`; modelos antigos do Tailspin usavam outro nome, `make-contribution`. Este workshop não depende de nenhuma dessas skills de contribuição. -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/pt-br/cli/6-custom-agents.md b/docs/pt-br/cli/6-custom-agents.md deleted file mode 100644 index e4705cfc..00000000 --- a/docs/pt-br/cli/6-custom-agents.md +++ /dev/null @@ -1,116 +0,0 @@ ---- -title: "Lição 6 - Agentes personalizados com o GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## O que são agentes personalizados? - -[Agentes personalizados][custom-agents-concept] no GitHub Copilot permitem criar assistentes de IA especializados e adaptados a tarefas ou domínios específicos do seu fluxo de desenvolvimento. Ao definir agentes por meio de arquivos markdown na pasta `.github/agents` do repositório, você fornece ao Copilot instruções direcionadas, boas práticas, padrões de código e conhecimento específico do domínio para orientá-lo a executar determinados tipos de trabalho com mais eficácia. As equipes podem transformar sua experiência em agentes reutilizáveis — um agente de acessibilidade que aplica conformidade com a [WCAG][wcag], um agente de segurança que segue práticas de programação segura ou um agente de testes que mantém padrões consistentes. - -Agentes personalizados são definidos por arquivos markdown na pasta `.github/agents` do projeto, ou globalmente em `~/.copilot/agents`. Cada arquivo tem frontmatter YAML com pelo menos `name` e `description`, seguido de um prompt em markdown que define o comportamento, a especialização e as instruções do agente. - -### Agentes personalizados em comparação com skills de agente - -Há alguma sobreposição lógica entre agentes personalizados e [skills de agente][agent-skills-concept]. Ambos são definidos principalmente com arquivos markdown e dizem à IA como executar operações. A forma mais clara de diferenciá-los é: um **agente personalizado** é o executor, e as **skills** são ferramentas. - -Agentes personalizados têm sua própria janela de contexto e são criados para orquestrar skills, e até outros agentes, como parte do trabalho. Neste laboratório, o agente personalizado de acessibilidade revisa e atualiza o site com base em diretrizes de acessibilidade; como parte desse trabalho, ele poderia chamar skills como uma skill de fluxo de pull request ou outra que execute e gerencie testes. - -> [!NOTE] -> Não existe uma única forma "correta" de criar um agente personalizado. Como em qualquer coisa relacionada à IA, teste e itere para descobrir o que funciona melhor nos seus ambientes e cenários. - -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ - -## Cenário - -Muitos aplicativos web ainda não são acessíveis para todas as pessoas usuárias, e o site em que você está trabalhando não é exceção. Você usará um agente personalizado para identificar e corrigir problemas de acessibilidade. - -A Tailspin Toys está comprometida em garantir que sua plataforma de financiamento coletivo seja acessível a todas as pessoas usuárias, independentemente de suas capacidades visuais ou preferências. Comentários recentes de usuários destacaram que algumas pessoas têm dificuldade para ler o tema escuro atual por causa do contraste insuficiente entre as cores de texto e de fundo. Para tratar essa preocupação de acessibilidade, a equipe de design solicitou a implementação de um modo de alto contraste que usuários possam ativar e desativar. - -Como a acessibilidade é crítica, você quer garantir que isso seja implementado o mais rápido possível. Você usará um agente personalizado para gerar essa funcionalidade. - -Nesta lição, você irá: - -- explorar agentes personalizados. -- habilitar um agente personalizado e atribuir uma tarefa a ele usando o Copilot CLI. - -## Revisar o agente personalizado de acessibilidade - -Um agente personalizado de acessibilidade já foi criado para você. Vamos revisar o conteúdo para entender como ele orientará o Copilot. - -1. Abra `.github/agents/accessibility.md`. -2. Observe o frontmatter YAML com os campos `name` e `description`. - -> [!CAUTION] -> O frontmatter com `name` e `description` é obrigatório para agentes personalizados. - -3. A partir daí, revise as seções seguintes, que destacam: - - responsabilidades principais ao gerar código para um site acessível. - - boas práticas de acessibilidade. - - exemplos de código em HTML, CSS e JavaScript. - - uma lista de armadilhas e erros comuns. - -## Usar um agente personalizado no Copilot CLI - -Você pode iniciar um agente personalizado no Copilot CLI com o comando `/agent`. Vamos fazer uma revisão de acessibilidade no site. - -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. - -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Abra a lista de agentes digitando `/agent` na janela de prompt do Copilot CLI e pressionando Enter. -2. Selecione o **Accessibility agent** na lista de agentes disponíveis. -3. Use o prompt a seguir para pedir que o agente de acessibilidade faça uma revisão e gere correções para o item de backlog relacionado à acessibilidade: - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -4. O Copilot começará a trabalhar na tarefa. Ele recuperará a issue, fará a revisão, gerará as atualizações e, por fim, criará o PR. Você também deve notar que, ao criar o PR, ele usa a skill do projeto voltada a pull requests. - -> [!NOTE] -> Esse processo provavelmente levará alguns minutos. É um bom momento para refletir sobre tudo o que você aprendeu, aproveitar uma bebida ou adiantar a próxima lição, que apresenta alguns comandos adicionais disponíveis no Copilot CLI. - -## Resumo e próximos passos - -Esta lição explorou [agentes personalizados][custom-agents] no GitHub Copilot, assistentes de IA especializados e adaptados a tarefas e domínios específicos. Com agentes personalizados, você pode transformar a experiência e os padrões da sua equipe em agentes reutilizáveis que orientam o Copilot a executar determinados tipos de trabalho com mais eficácia. - -Você explorou estes conceitos: - -- como agentes personalizados são definidos. -- usar um agente personalizado no Copilot CLI. - -Em seguida, vamos explorar [alguns comandos de barra][next-lesson] para aprender outros truques do Copilot CLI. - -## Recursos - -- [Agentes personalizados][custom-agents] -- [Criar agentes personalizados para um repositório][creating-custom-agents] -- [Agentes personalizados no awesome-copilot][awesome-copilot-agents] -- [Preparar o uso de agentes personalizados na sua organização][org-custom-agents] -- [Preparar o uso de agentes personalizados na sua empresa][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents diff --git a/docs/pt-br/cli/6-mcp-playwright.md b/docs/pt-br/cli/6-mcp-playwright.md new file mode 100644 index 00000000..70e53ea0 --- /dev/null +++ b/docs/pt-br/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "Lição 6 - Validar a funcionalidade com o MCP do Playwright" +description: "Conecte um navegador via MCP e compare o comportamento observado da filtragem com a issue e o plano aprovado." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Sua implementação de filtragem e a skill quality-checks já têm verificação automatizada. Agora dê um navegador ao Copilot e peça que observe a funcionalidade diretamente. Esta lição demonstra a interação por **Model Context Protocol (MCP)**, não outra execução completa da suíte de testes. + +Permaneça no modo **Interactive** na mesma cópia de trabalho e branch de filtragem. A configuração do MCP não inicia um novo marco de recurso. + +Nesta lição, você vai: + +- conectar o MCP do Playwright e confirmar que suas ferramentas de navegador estão disponíveis. +- comparar o comportamento real da filtragem com a issue e os critérios aprovados. +- revisar as observações e parar o servidor de desenvolvimento que iniciou. + +## Cenário + +As verificações automatizadas passaram, mas a Tailspin Toys também precisa de evidências da experiência dos visitantes. Você dará ao Copilot ferramentas de navegador para exercitar os filtros e comparar os jogos exibidos com o comportamento acordado, em vez de considerar que um controle que responde prova que a filtragem funciona. + +## O que o MCP acrescenta + +O [MCP][mcp-overview] conecta um agente a ferramentas e contexto externos por meio de servidores. O servidor MCP do GitHub integrado permite ao Copilot trabalhar com issues e PRs. O [servidor MCP do Playwright][playwright-mcp] fornece ferramentas de navegador para abrir páginas, examinar elementos acessíveis, navegar e interagir com controles. + +O snapshot de acessibilidade do navegador ajuda o agente a identificar controles, mas não comprova conformidade completa de acessibilidade. Compare ações e observações reais com os requisitos da issue em vez de aceitar um “parece bom” genérico. + +> [!CAUTION] +> Trate um servidor MCP como uma dependência do projeto: revise o publicador, o código-fonte, as permissões e qualquer download de pacote antes de habilitá-lo. Políticas da organização podem restringir quais servidores podem executar. Não coloque credenciais em configurações versionadas nem aprove ferramentas desconhecidas apenas para concluir a lição. + +## Configurar o MCP do Playwright + +1. Na sessão existente da CLI, digite `/mcp` para examinar os servidores configurados. Reutilize uma configuração funcional do Playwright em vez de adicionar uma duplicada. +2. Se necessário, digite `/mcp add` e use Tab para percorrer o formulário. +3. Defina **Server Name** como `playwright`, **Server Type** como **STDIO** (ou **Local**) e **Command** como `npx @playwright/mcp@latest --headless`. +4. Defina **Tools** como `*` para este servidor de navegador revisado. Isso disponibiliza suas ferramentas; não substitui os controles de permissão da CLI. +5. Depois de revisar o pacote e seu comando de inicialização, pressione Ctrl+S para salvar. O registro inicia o servidor e pode baixar o pacote; aprove essa configuração deliberadamente e responda a qualquer solicitação do pacote. +6. Digite `/mcp show playwright` e confirme que o servidor está conectado e suas ferramentas de navegador estão disponíveis. + +O navegador headless não precisa de uma janela de desktop, o que é adequado ao Codespaces. O fluxo interativo de adição salva a configuração em `~/.copilot/mcp-config.json` e disponibiliza o servidor sem reiniciar a CLI. Essa é uma configuração do usuário, não um arquivo para incluir no PR do recurso. O [guia de configuração do MCP][mcp-setup] documenta os campos e as fontes de configuração. + +> [!NOTE] +> As dependências E2E do projeto e o navegador do MCP estão relacionados, mas podem exigir configurações diferentes. Se faltar um navegador ou uma dependência do sistema, examine o erro real e resolva o pré-requisito específico com aprovação. Não instale navegadores automaticamente nem presuma que um servidor conectado comprova que ele pode iniciar um. + +## Iniciar a aplicação correta + +Abra outro terminal nesta mesma cópia de trabalho de filtragem. Confirme o diretório e a branch e depois inicie a aplicação: + +```bash +pwd +git branch --show-current +npm run dev +``` + +Leia a URL local real na saída do servidor. No codespace, o servidor MCP e a aplicação executam no mesmo ambiente, então use essa URL local, normalmente `http://localhost:4321`, em vez de presumir que uma URL de navegador encaminhada seja necessária. + +Se a porta estiver ocupada ou o Astro escolher outra porta, identifique a quem pertence o servidor antes de continuar. Não reutilize um servidor desconhecido nem o encerre. Use a URL do processo que você acabou de iniciar e mantenha esse terminal aberto durante os testes. + +## Observar o comportamento de filtragem + +Substitua os marcadores pela URL real da issue, os esclarecimentos aprovados na Lição 4 e a URL da aplicação: + +```plaintext +Use o servidor MCP do Playwright configurado para validar o recurso de filtragem em relação a esta issue: . Estes são os esclarecimentos aprovados durante o planejamento: . A aplicação desta cópia de trabalho está executando em . Confirme a cópia de trabalho, a branch e o servidor em teste antes de confiar nos resultados. + +Abra a página de jogos, observe o estado sem filtros, selecione uma e depois múltiplas categorias, aplique um filtro de distribuidora e combine as seleções de categoria e distribuidora. Exercite a limpeza e os resultados vazios conforme os critérios aprovados. Verifique os rótulos dos controles, a operação por teclado e o foco visível. Compare os resultados exibidos com os filtros selecionados e os dados de origem; não deduza sucesso apenas porque um controle mudou. + +Use ações reais das ferramentas de navegador e relate o que observou para cada critério, marcando claramente falhas ou evidências ausentes. Não execute outra suíte completa de testes apenas por esta lição de navegador, não altere código da aplicação, não crie testes ou personalizações, não mude de branch, não faça commit, push nem abra um PR. Pergunte antes de instalar algo ou parar outro processo. +``` + +Examine as chamadas de ferramentas do navegador e o relatório. O Copilot realmente selecionou múltiplas categorias e as combinou com uma distribuidora? Os jogos retornados correspondem ao comportamento acordado? O relatório distingue o comportamento observável no navegador da cobertura da camada de dados e dos testes automatizados? + +Se algo falhar, registre o comportamento observado. Autorize separadamente qualquer correção específica da aplicação e depois repita as verificações de navegador e automatizadas afetadas. Não altere os critérios de aceitação para corresponder à implementação nem conte evidências antigas como verificação de código alterado. + +## Parar o próprio servidor e continuar + +Pare o servidor de desenvolvimento com Ctrl+C no terminal em que o iniciou. Mantenha a configuração do MCP do Playwright disponível. A Lição 7 coordenará novas observações no navegador e verificações E2E automatizadas, que não devem reutilizar um servidor de desenvolvimento desatualizado nem a aplicação de outra cópia de trabalho. + +## Resumo e próximos passos + +Permaneça em **Interactive** antes de criar o perfil de QA. Você observou o comportamento no navegador sem criar outro PR ou branch; em seguida, [crie e use um agente de QA][next-lesson] para combinar requisitos, cobertura, a skill e as evidências finais. + +## Recursos + +- [Adicionar servidores MCP ao Copilot CLI][mcp-setup] documenta configuração e gerenciamento. +- [Microsoft Playwright MCP][playwright-mcp] documenta a configuração e as ferramentas de navegador. +- [Registro MCP do GitHub][mcp-registry] lista outros servidores para avaliar. + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/pt-br/cli/7-qa-agent.md b/docs/pt-br/cli/7-qa-agent.md new file mode 100644 index 00000000..116a50f8 --- /dev/null +++ b/docs/pt-br/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "Lição 7 - Criar e usar um agente de QA" +description: "Crie um perfil de QA que parta dos requisitos e combine cobertura de testes, a skill quality-checks e evidências diretas do navegador." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Você executou verificações repetíveis e explorou a filtragem pelo MCP do Playwright. Agora crie um **agente personalizado de QA** para reunir os requisitos, a cobertura e as evidências do navegador. Mantenha a sessão, a cópia de trabalho e a branch de filtragem; o PR do recurso vem na Lição 8. + +Nesta lição, você vai: + +- criar e examinar um perfil de QA que parte dos requisitos. +- selecionar o perfil e revisar a cobertura, os resultados das verificações e as evidências do navegador. +- voltar ao agente comum e salvar um checkpoint do perfil com os testes cuja inclusão seja justificada. + +## Cenário + +A Tailspin Toys está se preparando para entregar a filtragem. Testes aprovados, por si só, não mostram se todos os requisitos acordados estão cobertos. A equipe precisa de uma revisão focada que compare a issue com a implementação, identifique lacunas e explique se o recurso está pronto para revisão. Seu perfil de QA orientará essa avaliação sem substituir o julgamento humano. + +## Criar o perfil de QA + +Permaneça no modo **Interactive**. Um perfil define o papel e as instruções de um especialista; uma skill reúne instruções de tarefas reutilizáveis, scripts e recursos. O agente de QA usará sua skill e as ferramentas MCP configuradas em vez de substituí-las. + +Envie este prompt e examine a definição antes de executá-la: + +```plaintext +Crie um agente personalizado de QA reutilizável em .github/agents/qa.agent.md. Primeiro examine as instruções do repositório, package.json, a configuração de testes e .github/skills/quality-checks/SKILL.md. Forneça ao perfil um frontmatter YAML válido com name definido como QA e uma description que explique quando usá-lo. Não fixe um modelo nem adicione uma lista tools; herde as ferramentas e permissões disponíveis no ambiente. Crie apenas a definição do agente e pare para que eu possa examiná-la antes de executá-lo. + +Nas instruções do agente, exija que toda tarefa de QA comece pela issue e por quaisquer critérios de aceitação aprovados fornecidos pelo usuário. Trate esses requisitos como fonte de verdade, não a implementação. Pergunte quando faltarem requisitos ou eles forem ambíguos. Examine o recurso e os testes existentes e mapeie cada critério à cobertura automatizada adequada e ao comportamento observável. + +Exija validação direta no navegador pelo servidor MCP do Playwright configurado e execução de lint, testes de unidade, testes de ponta a ponta e verificações de tipos pela skill quality-checks existente e seus scripts incluídos. Leia a skill explicitamente se ela não tiver sido descoberta automaticamente. Relate skills, ferramentas MCP, pré-requisitos ou acesso ausentes como bloqueios; não substitua silenciosamente o fluxo por outro nem rotule verificações ignoradas como aprovadas. Identifique a cópia de trabalho e o servidor em teste, evite reutilizar o servidor de outro worktree, pare apenas os servidores iniciados pelo agente e pergunte antes de qualquer instalação ou de parar outro processo. + +Permita que o agente de QA adicione os menores testes necessários para lacunas reais de cobertura, seguindo as instruções do repositório; não adicionar testes é válido quando a cobertura já é adequada. Não enfraqueça asserções, não desative testes com falha, não altere critérios de aceitação para corresponder ao código nem modifique código da aplicação sem minha aprovação. Após alterações, execute novamente as verificações afetadas e conclua a verificação final da revisão resultante. Exija um relatório conciso que mapeie critérios a evidências e ao status aprovado/reprovado/bloqueado, liste os testes adicionados ou explique por que nenhum foi necessário, relate os resultados das quatro verificações e identifique defeitos não resolvidos. GO exige todas as verificações e evidências obrigatórias; caso contrário, relate NO-GO e o motivo. Não mude de branch, não faça commit, push, não abra ou integre PRs nem crie agentes ou skills adicionais durante QA. +``` + +## Examinar o perfil + +Abra `.github/agents/qa.agent.md` no editor e examine o diff. `description` é obrigatório; esta lição também fornece `QA` como `name` legível. Confirme que não há um `model` fixado nem uma lista de ferramentas inventada. Omitir `tools` herda as ferramentas disponíveis; não contorna as permissões do ambiente. Perfis de produção podem restringir ferramentas deliberadamente. + +Confirme que as instruções começam pelos requisitos, exigem atividade real no navegador via MCP e scripts da skill, permitem apenas adições justificadas de testes e relatam bloqueios com veracidade. Nem um perfil especializado nem uma skill exige uma janela de contexto separada ou a orquestração de outros agentes. + +## Executar QA em relação à issue + +O prompt de execução é para o agente personalizado **QA** selecionado, não para o agente padrão lendo um perfil. Inicie uma conversa nova da CLI na mesma cópia de trabalho para carregar o novo perfil sem criar outra branch de recurso. + +1. Preserve a URL da issue de filtragem e os esclarecimentos aprovados. Aguarde o agente atual terminar e digite `/exit` para voltar ao terminal. +2. Confirme que você ainda está no diretório do repositório de filtragem e na mesma branch com `git branch --show-current` e `git status --short`. Não mude de branch nem crie um worktree. +3. Inicie a CLI com o perfil do repositório: + + ```shell + copilot --agent qa + ``` + +4. Verifique se a CLI identifica **QA** como agente selecionado antes de executá-lo. A [referência de comandos da CLI][cli-reference] documenta `--agent`; escrever ou ler o perfil não é, por si só, ativação. Se a seleção falhar ou o agente não conseguir acessar as ferramentas MCP do Playwright configuradas e a skill, pause e resolva esse bloqueio com a pessoa que conduz o workshop. + +Substitua os dois marcadores pela URL real da issue de filtragem e os esclarecimentos aprovados na Lição 4, ou por `none` quando a issue estiver completa. Não dependa da memória do agente anterior. + +```plaintext +Verifique o recurso de filtragem em relação a esta issue: . Estes são os critérios de aceitação adicionais que aprovei durante o planejamento: . + +Valide o comportamento com o servidor MCP do Playwright, examine a cobertura de testes, adicione testes apenas para lacunas de cobertura e execute a validação pela skill quality-checks. Relate evidências, resultados das verificações e bloqueios. Não altere código da aplicação sem minha aprovação, não crie um commit nem abra um pull request. +``` + +## Revisar as evidências + +Compare o relatório com a issue: cada critério precisa de cobertura automatizada adequada e comportamento observável. Examine a atividade real das ferramentas MCP do Playwright, a identidade da cópia de trabalho e do servidor e os resultados dos quatro scripts da skill. As verificações no navegador e E2E automatizadas não devem reutilizar um servidor desatualizado ou outra cópia de trabalho. + +Revise os testes adicionados: eles devem cobrir lacunas reais sem enfraquecer asserções. Não adicionar testes é correto quando a cobertura é adequada. Um parecer **NO-GO** por bloqueio ou falha é um resultado válido, não permissão para ignorar evidências. + +Se QA identificar um defeito na aplicação, aprove separadamente uma correção específica e execute novamente as verificações e observações no navegador afetadas na revisão resultante. Pré-requisitos ou ferramentas ausentes precisam de uma resolução explícita. Não trate evidências antigas como prova de código alterado. + +## Salvar um checkpoint + +Quando QA terminar, preserve o relatório com a URL da issue, os esclarecimentos aprovados, a revisão testada, as observações no navegador e os resultados das verificações. Digite `/exit` e inicie `copilot` sem `--agent` no mesmo diretório e branch para voltar a uma conversa normal. Forneça esse contexto novamente; a conversa nova não herda as evidências da conversa de QA. + +Após revisar o perfil, quaisquer alterações de testes e as evidências resultantes, envie a solicitação abaixo ao agente normal: + +```plaintext +Revise o diff atual e crie um commit de checkpoint para a definição do agente de QA e quaisquer alterações de testes aprovadas. Permaneça na branch de filtragem existente. Não faça push nem abra um pull request. +``` + +## Resumo e próximos passos + +Você criou e selecionou um perfil de QA, revisou suas evidências e salvou o perfil com os testes justificados. Leve adiante os achados não resolvidos; um veredito com falha ou bloqueado não autoriza a integração. Continue na [Lição 8 - Criar e integrar o PR do recurso][next-lesson] com o recurso de filtragem, a skill, o perfil de QA, os testes e as evidências atuais de verificação. + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/pt-br/cli/7-slash-commands.md b/docs/pt-br/cli/7-slash-commands.md deleted file mode 100644 index b37b4de0..00000000 --- a/docs/pt-br/cli/7-slash-commands.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "Lição 7 - Comandos de barra no GitHub Copilot CLI" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Como toda boa ferramenta de CLI, o GitHub Copilot CLI inclui vários comandos de barra para interação. Esses comandos expõem funcionalidades avançadas, informações de bastidores ou opções adicionais de configuração. Você já explorou alguns deles, como `/clear` para limpar o contexto e `/mcp` para inspecionar servidores MCP. Agora, vamos explorar outros comandos poderosos, incluindo `/context`, `/model`, `/share` e `/delegate`. - -## Cenário - -Você concluiu os fluxos centrais da CLI. Agora, vamos conhecer algumas capacidades adicionais — compartilhar sessões, trocar de modelo e delegar tarefas ao [agente de nuvem do Copilot][about-cloud-agent]. - -Nesta lição, você usará: - -- `/share` para criar uma GitHub gist e compartilhar sua sessão com a equipe. -- `/context` para ver o contexto que o Copilot CLI está usando no momento. -- `/model` para explorar a lista de modelos disponíveis e selecionar outro, se quiser. -- `/delegate` para, opcionalmente, encaminhar uma tarefa ao agente de nuvem. Isso requer o agente de nuvem, disponível nos planos Copilot Student, Pro, Pro+, Business ou Enterprise — todos, exceto Copilot Free. - -## Compartilhar uma sessão - -Usar qualquer ferramenta, inclusive uma ferramenta de IA, é uma habilidade. Trabalhar em equipe e compartilhar aprendizados é a melhor forma de melhorar a experiência de todas as pessoas e gerar código de maior qualidade. Para apoiar isso, o Copilot CLI oferece o comando `/share`. O comando `/share` pode gerar um arquivo markdown ou uma GitHub gist com os detalhes da sessão, incluindo os prompts usados e a lógica seguida pelo Copilot. - -Vamos criar uma GitHub gist que você poderia compartilhar com a equipe. - -> [!TIP] -> **Inicie uma sessão do Copilot CLI** -> -> Antes de iniciar os exercícios abaixo, volte ao codespace e abra um terminal (Ctrl+`, se ainda não houver um aberto). Em seguida, inicie o Copilot CLI com `--yolo` e `--enable-all-github-mcp-tools`: -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> Para retomar a sessão mais recente deste projeto em vez de iniciar uma nova, execute `copilot --yolo --enable-all-github-mcp-tools --continue`. Se o Copilot CLI já estiver em execução por causa de uma lição anterior, envie `/clear` para começar uma conversa limpa. -> -> `--enable-all-github-mcp-tools` habilita as ferramentas GitHub MCP de leitura e escrita para a sessão atual, para que o Copilot possa ler seu backlog e abrir pull requests durante o fluxo do workshop. - -> [!CAUTION] -> `--yolo` habilita permissões automáticas completas (`--allow-all-tools`, `--allow-all-paths` e `--allow-all-urls`). Use-o apenas em um ambiente isolado, como um Codespace ou uma VM, e nunca o defina como alias padrão no seu desenvolvimento diário. Consulte [Allowing and denying tool use][allow-all-warning] para saber mais. - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. Na janela de prompt do Copilot CLI, envie o comando a seguir: - - ``` - /share gist - ``` - -2. Em poucos instantes, o Copilot criará uma gist e exibirá o link. -3. Copie o texto do link. -4. Em uma nova guia do navegador, cole o link para explorar a gist. Observe como a gist destaca os prompts enviados, as skills e os agentes usados, o processo de raciocínio do Copilot e até o código e os resultados de comandos executados localmente. - -As gists e os arquivos markdown gerados por `/share` podem ser usados para documentar como o código foi criado ou para compartilhar com a equipe como determinadas ações foram executadas para obter os resultados desejados com o Copilot. - -## Explorar o contexto do Copilot CLI - -Ao trabalhar em tarefas maiores ou mais complexas, você pode atingir o limite da janela de contexto do modelo. O tamanho exato dessa janela varia de acordo com o modelo usado e a versão do Copilot CLI. Quando a janela de contexto fica cheia, o Copilot CLI a compacta automaticamente, resumindo as informações e removendo tudo o que considerar irrelevante para a tarefa atual. Você pode ver o estado atual do contexto e também compactá-lo manualmente com comandos de barra. Vamos explorar a janela de contexto. - -1. Na janela de prompt do Copilot CLI, envie o comando a seguir: - - ``` - /context - ``` - -2. Em poucos instantes, o Copilot CLI gerará uma representação visual do contexto atual: - - ![Captura de tela da janela de contexto do Copilot CLI](../../_images/cli-7-context-window.png) - -3. Observe o modelo exibido, que pode ser diferente do mostrado na imagem, e a porcentagem atual de tokens usados. O restante das informações destaca: - - | Título | Descrição | - | ------------ | ------------------------------------------------------ | - | System/Tools | Arquivos de instruções, conteúdo de arquivos e definições de ferramentas | - | Messages | Histórico da conversa entre você e o Copilot | - | Buffer | Espaço reservado pelo Copilot CLI para gerar respostas | - | Free space | Espaço livre restante | - -4. Compacte o histórico da conversa enviando o seguinte comando de barra ao Copilot CLI: - - ``` - /compact - ``` - -5. Quando a operação terminar, envie o comando a seguir para exibir novamente as estatísticas atuais do contexto: - - ``` - /context - ``` - -6. Observe a mudança no contexto. Talvez ela não seja drástica, já que a janela de contexto provavelmente ainda está relativamente pequena neste momento. - -> [!NOTE] -> O Copilot CLI compactará o contexto automaticamente quando ele estiver cheio. Ao se aproximar de 100% da capacidade, ele exibirá a porcentagem logo acima da janela de prompt. Normalmente, a compactação acontece de forma assíncrona, permitindo que você continue interagindo com o Copilot enquanto ele faz esse trabalho. No entanto, em alguns casos ele pode bloquear uma operação em andamento por vários segundos durante o processo. - -### Boas práticas com contexto - -Na maioria das sessões, o contexto será gerenciado com eficiência pelo próprio Copilot sem orientações específicas. Mesmo assim, pode haver situações em que você decida instruir manualmente o Copilot a limpar ou compactar o histórico: - -- Se você for mudar para outra parte do aplicativo ou para uma tarefa não relacionada, pode usar `/clear` para começar de novo e evitar confundir o Copilot com contexto antigo e irrelevante. -- Se você estiver se aproximando do limite máximo da janela de contexto, pode usar `/compact` manualmente para controlar quando a compactação acontecerá. - -> [!CAUTION] -> Novamente, na maior parte do tempo, o Copilot gerenciará o contexto sem interação direta sua. Se você perceber que o Copilot está um pouco confuso por causa de informações antigas, ou estiver prestes a mudar para uma tarefa sem relação com a atual, considere usar os comandos manuais. - -## Escolher seu modelo - -Modelos diferentes têm pontos fortes diferentes, e pessoas desenvolvedoras diferentes têm preferências diferentes. O Copilot CLI permite listar e selecionar o modelo que você quer usar. - -1. Exiba a lista de modelos enviando o comando de barra a seguir ao Copilot CLI: - - ``` - /model - ``` - -2. Observe a lista de modelos. Cada modelo exibirá tanto seu nome quanto o modificador de custo por solicitação. -3. Se quiser, selecione um novo modelo. Ou pressione Esc para sair da lista. - -> [!CAUTION] -> A seleção de modelo persiste no Copilot CLI. - -## Delegar ao agente de nuvem (opcional) - -Há situações em que você quer continuar trabalhando no terminal, mas precisa delegar uma tarefa mais demorada ao agente de nuvem do Copilot. O comando `/delegate` envia a sessão atual do Copilot CLI para o GitHub.com, onde o agente de nuvem a assume, trabalha de forma assíncrona e abre um pull request quando termina. - -> [!NOTE] -> `/delegate` requer o agente de nuvem, disponível nos planos Copilot Student, Pro, Pro+, Business ou Enterprise — todos, exceto Copilot Free. Se você não tiver acesso, leia esta seção e pule a parte prática. - -1. Primeiro, limpe a sessão atual para evitar delegar o contexto acumulado do workshop: - - ``` - /clear - ``` - -2. Envie um prompt pequeno e bem delimitado. Por exemplo, você pode delegar a meta extra de paginação do seu backlog: - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. Envie o comando de barra a seguir para entregar a sessão ao agente de nuvem e confirme o prompt que deseja delegar: - - ``` - /delegate - ``` - -4. Abra [Copilot agents](https://github.com/copilot/agents) no navegador para acompanhar o progresso. -5. Você não precisa esperar a conclusão do pull request neste percurso. Pode voltar a ele mais tarde. Se quiser se aprofundar no gerenciamento de trabalho assíncrono com agentes, continue no [percurso do agente de nuvem](../../cloud/). - -## Resumo e próximos passos - -Usar comandos de barra no Copilot CLI permite configurá-lo, compartilhar sessões e obter informações internas sobre como o Copilot está trabalhando. Nesta lição, você usou ou explorou: - -- `/share` para criar uma GitHub gist e compartilhar sua sessão com a equipe. -- `/context` para ver o contexto que o Copilot CLI está usando no momento. -- `/model` para explorar a lista de modelos disponíveis e selecionar outro, se quiser. -- `/delegate` como uma ponte opcional para o agente de nuvem. - -É claro que há mais comandos de barra disponíveis e muito mais para explorar no Copilot CLI. Vamos encerrar essa jornada [revendo o que aprendemos][next-lesson] e vendo alguns próximos passos para continuar aprendendo. - -## Recursos - -- [Usar o Copilot CLI][using-copilot-cli] -- [Sobre o Copilot CLI][about-copilot-cli] -- [Gerenciamento de contexto no Copilot CLI][context-management] -- [Compartilhar sessões com o Copilot CLI][share-sessions] -- [Selecionar modelos no Copilot CLI][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm diff --git a/docs/pt-br/cli/8-create-pull-request.md b/docs/pt-br/cli/8-create-pull-request.md new file mode 100644 index 00000000..5c5d961f --- /dev/null +++ b/docs/pt-br/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "Lição 8 - Criar e integrar o PR do recurso" +description: "Revise todo o marco de filtragem, reutilize as evidências atuais de QA e integre o terceiro pull request após a CI e a revisão." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Agora reúna o marco de filtragem no PR 3. Permaneça na branch e na cópia de trabalho usadas nas Lições 4–7. Elas contêm a implementação de filtragem, a skill quality-checks e seus scripts, o perfil de QA e os testes associados. + +Nesta lição, você vai: + +- revisar o diff do marco completo e as evidências atuais de QA. +- solicitar um PR de recurso e examinar suas verificações e comentários de revisão. +- integrar explicitamente o PR revisado e atualizar o `main` local. + +## Cenário + +O trabalho de filtragem está distribuído em vários checkpoints, mas os revisores precisam avaliar um recurso completo. A Tailspin Toys quer um PR que conecte os requisitos, a implementação, as verificações reutilizáveis e os achados de QA. Você preparará essa entrega e resolverá os bloqueios antes de integrar. + +Esta é uma solicitação normal de PR com escopo delimitado que usa as convenções do repositório. Ela não exige uma skill de contribuição. + +> [!NOTE] +> Uma equipe de produção poderia separar um recurso da infraestrutura de qualidade reutilizável. Este workshop os combina deliberadamente para mostrar o fluxo completo em um único PR de recurso. Os PRs anteriores de avaliações por estrelas e instruções já devem estar integrados em `main`, não aparecer novamente como trabalho não relacionado. + +## Verificar prontidão e evidências + +1. Revise o parecer de QA e o mapeamento entre requisitos e evidências. Um **NO-GO**, evidências de navegador ausentes ou uma verificação obrigatória ignorada é um bloqueio a resolver antes do merge. +2. Confirme que as quatro verificações realmente foram executadas pela skill quality-checks: lint, testes de unidade, E2E e verificações de tipos. +3. Revise a revisão testada e quaisquer alterações posteriores às verificações. Reutilize as evidências atuais de QA apenas enquanto o código testado, os testes e os scripts de verificação permanecerem inalterados. Um commit de checkpoint por si só não invalida conteúdos idênticos dos arquivos, mas alterações de código invalidam. +4. Se a implementação ou as entradas testadas mudaram, execute novamente as verificações relevantes da skill e as observações no navegador e atualize as evidências. Não repita toda a suíte apenas porque está abrindo um PR quando os resultados atuais de QA ainda se aplicam. +5. Examine o diff completo da branch, não apenas o último checkpoint ou as alterações sem commit. + +Em outro terminal na mesma cópia de trabalho: + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +A comparação com três pontos mostra as alterações desta branch desde o ancestral comum com `origin/main`, incluindo checkpoints anteriores. Verifique se inclui apenas o marco de filtragem pretendido. Examine também os arquivos novos; arquivos inesperados não rastreados ou sem commit precisam ser revisados antes de adicioná-los à área de preparação. + +## Solicitar o PR 3 + +A Lição 7 retornou você a uma sessão **Interactive** normal antes do checkpoint. Continue nessa sessão estabelecida se o perfil de QA não estiver mais ativo e a cópia de trabalho e a branch de filtragem estiverem inalteradas. Mantenha disponíveis a URL da issue, os esclarecimentos aprovados no planejamento e o relatório atual de QA, incluindo a revisão testada e os resultados das verificações. + +O perfil de QA proíbe ações de commit e PR durante QA. Se ele ainda estiver ativo, volte a uma sessão normal antes de solicitar o PR: + +1. Aguarde QA ficar ocioso e digite `/exit` no prompt da CLI. Se a CLI continuar aberta porque outra sessão está ativa, conclua ou preserve esse trabalho antes de voltar ao prompt normal e pressionar Ctrl+D para encerrar esta instância da CLI. +2. No prompt do shell, permaneça na mesma cópia de trabalho e branch de filtragem. Confirme sua identidade e inicie uma sessão normal nova sem `--agent qa` nem uma opção de retomada: + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. Confirme que você está no modo **Interactive** e que o perfil de QA não está mais ativo. Não crie outro worktree, não mude de branch nem retome a sessão de QA. + +Substitua todos os marcadores abaixo pela URL real da issue, os esclarecimentos aprovados e as evidências atuais de QA. Forneça-os explicitamente mesmo se tiver permanecido na sessão normal da Lição 7; uma conversa nova não deve depender da memória da sessão de QA. + +```plaintext +Prepare o PR do recurso de filtragem para esta issue: . Estes são os critérios de aceitação adicionais que aprovei durante o planejamento: . Estas são as evidências atuais de QA: . + +Confirme a cópia de trabalho e a branch de filtragem atual. Examine o diff completo em relação a main, todos os commits de checkpoint do marco, git status, o modelo de PR do repositório e as evidências de QA fornecidas. Inclua apenas a implementação de filtragem revisada, a skill quality-checks e os scripts incluídos, a definição do agente de QA e os testes associados. + +Reutilize os resultados de QA enquanto eles ainda descreverem o conteúdo final dos arquivos. Se código, testes ou scripts de verificação mudaram depois, relate isso e execute as verificações relevantes pela skill e a validação de navegador afetada antes de apresentá-los como atuais. Não rotule verificações com falha, bloqueadas ou ignoradas como aprovadas. + +Faça commit de quaisquer alterações revisadas restantes do marco, se necessário, envie esta branch atual e crie um único PR para main seguindo as convenções do repositório. Inclua a issue e os critérios aprovados, o resumo da implementação, os testes adicionados ou por que nenhum foi necessário, as observações no navegador, os resultados das quatro verificações e as limitações restantes. Não faça o merge, não crie outra branch, não invoque uma skill de contribuição nem comece outro recurso. +``` + +## Revisar o PR e a CI + +Abra a URL retornada e examine **Files changed** em todo o PR. Verifique se os scripts da skill e o perfil de QA estão incluídos e se nenhuma credencial, configuração local do MCP, arquivo não relacionado, relatório gerado ou instalação de dependência entrou no diff. + +Use a aba **Checks** do PR ou execute estes comandos no terminal na branch do recurso: + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +Examine `.github/workflows/` no seu repositório em vez de presumir que um indicador verde cobre todos os tipos de verificação. O fluxo atual **Run tests** do Tailspin executa lint, verificações de tipos, testes de unidade do Vitest e testes E2E do Playwright contra o site estático compilado. Ele não substitui as observações diretas no navegador via MCP do relatório de QA. A compilação Astro e as verificações de links do site do workshop validam outro repositório. + +Se uma verificação falhar, examine os logs e resolva a causa. Uma correção específica precisa ser revisada e verificada novamente na revisão atualizada antes do push. Se `main` mudar e a resolução de um conflito alterar o recurso, atualize também as evidências afetadas. Aguarde qualquer revisão humana obrigatória; a aprovação do próprio agente não substitui a proteção de branch. + +## Integrar e atualizar o main local + +Quando o PR atender a todos os requisitos de revisão e verificação, escolha explicitamente **Merge pull request** no GitHub e confirme o merge. Verifique se o PR 3 está **Merged**. + +Saia da sessão da CLI com `/exit`. Com a árvore de trabalho limpa, atualize a cópia local: + +```bash +git status +git switch main +git pull --ff-only +``` + +## Resumo e próximos passos + +Não é necessária uma branch nova para a próxima lição. Você integrou exatamente três PRs do workshop: avaliações por estrelas; instruções e uma demonstração; e filtragem com a skill de qualidade, o perfil de QA e os testes. + +Continue na [Lição 9 - Explorar comandos de barra e opções da CLI][next-lesson] para um percurso delimitado pelos controles da CLI, não outra tarefa de implementação. + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/pt-br/cli/8-review.md b/docs/pt-br/cli/8-review.md deleted file mode 100644 index fe6450da..00000000 --- a/docs/pt-br/cli/8-review.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "Lição 8 - Revisão e próximos passos" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -Ao longo das últimas lições, você explorou alguns dos casos de uso mais comuns do GitHub Copilot CLI, incluindo: - -- interagir com o GitHub e outros servidores MCP. -- usar arquivos de instruções para orientar a geração de código. -- implementar skills para adicionar ferramentas ao conjunto de recursos do Copilot CLI. -- chamar agentes personalizados para tarefas avançadas e mais complexas. -- usar comandos de barra para gerenciar sua sessão e, opcionalmente, voltar ao agente de nuvem por meio de `/delegate`. - -Vamos falar sobre alguns comandos de barra, boas práticas e próximos passos. - -## Comandos de barra - -O Copilot CLI oferece uma série de comandos de barra para interação, inclusive aqueles que permitem configurá-lo ou ver o que acontece nos bastidores. Você já usou `/clear` para iniciar um novo chat, limpando o contexto atual, e `/mcp` para inspecionar e gerenciar servidores MCP. Alguns outros que podem ser úteis são: - -| Comando | Descrição | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | Adicionar um diretório à lista de confiança do Copilot | -| `/clear`, `/new` | Limpar o histórico da conversa e começar de novo | -| `/compact` | Resumir o histórico da conversa para reduzir o uso da janela de contexto | -| `/context` | Mostrar o uso de tokens da janela de contexto e sua visualização | -| `/diff` | Revisar as alterações feitas no diretório atual | -| `/model` | Selecionar o modelo de IA a usar (Claude Sonnet, GPT-5 etc.) | -| `/plan ` | Criar um plano de implementação antes de programar | -| `/review ` | Executar o agente de revisão de código para analisar alterações | -| `/delegate` | Delegar a tarefa ao agente de nuvem do Copilot para processamento assíncrono | -| `/session` | Mostrar informações da sessão e um resumo do workspace | -| `/share` | Compartilhar a sessão em um arquivo markdown ou em uma GitHub gist | -| `/skills` | Gerenciar skills para ampliar recursos | -| `/usage` | Exibir métricas e estatísticas de uso da sessão | - -> [!TIP] -> Use `/help` para ver a lista completa de comandos disponíveis e atalhos de teclado. - -## Boas práticas - -Ao usar qualquer ferramenta de IA, a infraestrutura por trás dela influencia a qualidade do que você recebe. Arquivos de instruções robustos, agentes personalizados e skills de agente fazem parte dessa base — e você explorou cada um deles neste workshop. O [awesome-copilot][awesome-copilot] é uma boa fonte de modelos, e o próprio Copilot pode gerar essas estruturas para você como ponto de partida. - -O contexto continua sendo tão importante quanto a infraestrutura. Descrever com clareza *o que* você quer criar, *por que* e *como* muda significativamente a saída. Se alguma informação puder ajudar o Copilot, forneça-a. - -## Próximos passos - -A melhor forma de melhorar suas habilidades com qualquer ferramenta é continuar usando essa ferramenta. Use-a em código de produção, em projetos pessoais, naquele pequeno aplicativo em que você pensa há anos mas nunca parou para criar. Compartilhe seus aprendizados com a equipe e aprenda com ela. E, como sempre, explore a documentação. - -Se quiser explorar mais do ecossistema do GitHub Copilot, confira o [percurso do VS Code](../../vscode/) ou o [percurso do agente de nuvem](../../cloud/). - -## Recursos - -- [Sobre o Copilot CLI][about-copilot-cli] -- [Usar o Copilot CLI][using-copilot-cli] -- [Repositório Awesome Copilot][awesome-copilot] -- [Guia de instruções personalizadas][repo-instructions] -- [Documentação de Agent Skills][agent-skills] -- [Documentação de agentes personalizados][custom-agents] -- [Especificação do MCP][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ diff --git a/docs/pt-br/cli/9-slash-commands.md b/docs/pt-br/cli/9-slash-commands.md new file mode 100644 index 00000000..885bbc93 --- /dev/null +++ b/docs/pt-br/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "Lição 9 - Explorar comandos de barra e opções da CLI" +description: "Examine contexto e controles de modelo e sessão, revise destinos de compartilhamento e explore opções da CLI sem iniciar outro recurso." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Os três marcos de PR estão completos. Agora explore os controles da CLI que ajudam a entender e gerenciar uma sessão. Esta lição não implementa outro recurso, não delega trabalho nem abre outro PR. + +Nesta lição, você vai: + +- examinar os controles de contexto, uso, modelo e modo. +- comparar as opções de linha de comando com a ajuda da versão instalada. +- exportar uma sessão localmente e revisá-la antes de compartilhar qualquer conteúdo. + +## Cenário + +Com o recurso entregue, você quer entender os controles da CLI que usará no dia a dia. Examinará uma sessão e suas opções de compartilhamento sem iniciar outra tarefa, para que gerenciar contexto ou exportar uma conversa não autorize trabalho nem divulgue informações do projeto por acidente. + +Na cópia de trabalho atualizada do participante, inicie `copilot` no modo **Interactive**. Use `/help` e a [referência de comandos][cli-reference] para confirmar quais comandos a versão instalada suporta; a documentação atual pode descrever controles mais novos do que a sua instalação. + +## Examinar contexto e informações da sessão + +1. Envie uma solicitação delimitada, somente de leitura: + + ```plaintext + Resuma os arquivos de instruções do repositório, a skill quality-checks e o perfil de QA. Explique como eles apoiam a verificação da filtragem. Não modifique arquivos, não execute verificações, não delegue trabalho, não faça commit nem abra um PR. + ``` + +2. Digite `/context` para examinar o uso da janela de contexto. Observe como mensagens, instruções e definições de ferramentas consomem contexto. +3. Digite `/compact` e depois `/context` novamente. A compactação resume o histórico para reduzir seu tamanho; uma sessão curta pode mostrar pouca mudança. +4. Digite `/session` para examinar a sessão atual e `/usage` para consultar informações de uso. + +A compactação não substitui o fornecimento de requisitos. Ao mudar de tarefa ou agente, forneça explicitamente a URL da issue, os critérios aprovados, a identidade da cópia de trabalho e as evidências relevantes. + +`/clear` inicia uma conversa nova; não desfaz arquivos nem muda de branch Git. `/resume` abre o seletor de sessões para retornar a trabalhos anteriores. Explore o seletor e pressione Esc para sair sem retomar outra tarefa. Não apague a única cópia dos critérios de aceitação nem presuma que retomar uma conversa significa que sua verificação antiga ainda está atualizada. + +## Examinar modelos e modos + +Digite `/model` para examinar os modelos disponíveis para sua conta, incluindo **Auto** onde for oferecido. Leia os detalhes de seleção e as informações de uso; a disponibilidade e os preços dos modelos podem mudar. Pressione Esc para sair do seletor sem mudar o modelo. Se você o alterar, confirme a seleção exibida e o escopo que sua versão da CLI aplica. + +Use Shift+Tab para examinar o indicador de modo ao alternar entre **Interactive**, **Plan** e **Autopilot** e volte a **Interactive** sem enviar um prompt de implementação. Lembre-se da distinção: + +- Plan serve para acordar o trabalho antes de programar. +- Autopilot continua uma tarefa aprovada e delimitada. +- Interactive oferece pontos deliberados de revisão e decisão. +- As permissões controlam separadamente quais ações de ferramentas são permitidas. + +## Examinar opções de linha de comando + +Em outro terminal, execute: + +```bash +copilot --help +``` + +Compare estas opções documentadas com a ajuda da versão instalada: + +| Opção | Finalidade | +| --- | --- | +| `--model MODEL` | Escolher o modelo para uma invocação; confirme a disponibilidade primeiro | +| `--agent AGENT` | Selecionar um agente personalizado para uma invocação | +| `-p PROMPT` | Executar um prompt programaticamente e sair quando ele terminar | +| `--output-format json` | Emitir saída JSONL estruturada, um objeto JSON por linha | +| `--resume` | Retomar uma sessão existente | +| `--enable-all-github-mcp-tools` | Expor o conjunto completo de ferramentas MCP do GitHub integradas | + +São controles para entender, não outra tarefa para iniciar. O modo programático pode executar ações reais de ferramentas; um formato de saída JSON não torna uma solicitação somente de leitura. A seleção de agente segue o fluxo verificado da [Lição 7][qa-lesson], não é motivo para substituir a ativação do agente personalizado por um pedido ao agente padrão para ler o perfil. As permissões e o acesso continuam se aplicando. + +## Revisar antes de compartilhar + +`/share` pode enviar o conteúdo da sessão a diferentes destinos. A [referência de comandos da CLI][cli-reference] documenta `/share file [session|research] [PATH]` para exportação Markdown e `/share gist [session|research]` para publicar gists. Sem subcomando, o comportamento documentado atualmente cria um link compartilhável do GitHub quando você está conectado e sincronizado e recorre à exportação Markdown caso contrário. Não execute o comando sem argumentos presumindo que ele apenas exibe uma prévia. + +Neste workshop, selecione explicitamente uma exportação local da sessão e um nome de arquivo em vez de publicar: + +```text +/share file session cli-session-review.md +``` + +Abra o arquivo exportado no editor e examine o que ele realmente contém. Revise prompts, respostas, saída de ferramentas, caminhos de arquivos, dados do repositório e quaisquer credenciais ou informações pessoais. Não presuma que a exportação contém todos os passos internos ou que removeu automaticamente o conteúdo sensível. + +> [!CAUTION] +> Um gist ou link compartilhado é uma divulgação externa. Um gist secreto não é controle de acesso privado: qualquer pessoa com sua URL pode vê-lo. Confirme o destino, os destinatários, as permissões e a política da organização antes de compartilhar. Se precisar ocultar informações, compartilhe apenas o arquivo revisado e sanitizado por um canal aprovado; não publique a sessão original depois. + +Mantenha essa exportação fora do PR do recurso e do histórico do repositório. Após examiná-la, remova o arquivo que acabou de gerar ou mova-o para seu local aprovado de notas locais. Não remova arquivos não relacionados. + +A delegação para a nuvem pode criar trabalho remoto e um PR adicional, então não execute `/delegate` aqui. O [workshop do agente de nuvem][cloud-workshop] cobre esse fluxo separado. + +## Resumo e próximos passos + +Você examinou contexto, uso, controles de modelos e modos, opções de linha de comando e destinos de compartilhamento sem iniciar outro recurso. Continue na [Lição 10 - Revisão e próximos passos][next-lesson] para revisar o fluxo e os ativos que criou. + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/pt-br/cli/README.md b/docs/pt-br/cli/README.md index 0844114e..3733fc89 100644 --- a/docs/pt-br/cli/README.md +++ b/docs/pt-br/cli/README.md @@ -3,12 +3,12 @@ slug: pt-br/cli title: "CLI do GitHub Copilot" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- O **[GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)** coloca o GitHub Copilot no seu terminal como um assistente de programação baseado em agentes. Ele explora bases de código, gera código, executa comandos e se conecta a ferramentas externas — tudo pela linha de comando, para que você mantenha o foco sem trocar para um editor gráfico. -Ao longo destas lições, você instalará e autenticará o Copilot CLI, depois fornecerá contexto do projeto com instruções personalizadas antes de usar o modo plan para gerar um recurso de forma deliberada. Você conectará o servidor MCP do Playwright para testar esse recurso em um navegador real e, em seguida, ampliará o Copilot com skills de agente reutilizáveis e agentes personalizados. Por fim, você explorará comandos de barra para gerenciar contexto, modelos e compartilhamento, e concluirá com uma revisão do que criou. +Após a configuração nas Lições 0–1, você concluirá nove módulos principais nas Lições 2–10. Comece com uma melhoria rápida de avaliações por estrelas, estabeleça instruções de documentação e crie a filtragem com os modos **Plan** e **Autopilot**. Depois, crie uma skill quality-checks reutilizável, valide o comportamento com o MCP do Playwright, crie um agente de QA e entregue o recurso. Termine explorando os controles da CLI e revisando o que criou. ## Lições @@ -16,13 +16,21 @@ Ao longo destas lições, você instalará e autenticará o Copilot CLI, depois |----------|-------|-------------| | [0. Pré-requisitos][ex0] | Configuração | Crie seu repositório e seu codespace | | [1. Instalar o Copilot CLI][ex1] | Instalação | Instale e autentique o Copilot CLI | -| [2. Instruções personalizadas][ex2] | Contexto | Adicione uma instrução e veja como o Copilot CLI a segue | -| [3. Geração de código][ex3] | Geração de código | Use o modo plan e gere recursos | -| [4. Testar com o MCP do Playwright][ex4] | Ferramentas externas | Adicione o servidor MCP do Playwright e teste seu recurso em um navegador | -| [5. Skills de agente][ex5] | Skills | Aprimore o Copilot com skills especializadas | -| [6. Agentes personalizados][ex6] | Agentes | Revise e use agentes personalizados | -| [7. Comandos de barra][ex7] | Recursos da CLI | Explore contexto, modelos, compartilhamento e a delegação opcional para o agente de nuvem | -| [8. Revisão][ex8] | Resumo | Revise os principais conceitos e os próximos passos | +| [2. Adicionar avaliações por estrelas: uma melhoria rápida][ex2] | Primeira alteração | Exiba avaliações existentes, valide e integre o PR 1 | +| [3. Orientar o Copilot com instruções personalizadas][ex3] | Contexto | Adicione uma convenção de documentação, demonstre-a e integre o PR 2 | +| [4. Criar a filtragem com Plan e Autopilot][ex4] | Implementação | Revise um plano, aprove o Autopilot, teste e salve um checkpoint | +| [5. Criar e usar uma skill quality-checks][ex5] | Skills | Gere, examine e execute verificações com scripts de shell incluídos | +| [6. Validar a funcionalidade com o MCP do Playwright][ex6] | Ferramentas de navegador | Observe o comportamento de filtragem em um navegador real | +| [7. Criar e usar um agente de QA][ex7] | Agentes | Audite requisitos e cobertura e reúna as evidências finais | +| [8. Criar e integrar o PR do recurso][ex8] | Entrega | Revise a filtragem e as personalizações reutilizáveis juntas no PR 3 | +| [9. Explorar comandos de barra e opções da CLI][ex9] | Controles da CLI | Examine contexto, modelos, sessões e destinos de compartilhamento | +| [10. Revisão e próximos passos][ex10] | Resumo | Revise os ativos comuns e os três marcos de PR | + +## Branches e pull requests + +Você integrará três pull requests: avaliações por estrelas; instruções e uma pequena demonstração; e filtragem com a skill quality-checks, o perfil de QA e os testes associados. Integre cada um dos dois primeiros PRs antes de iniciar o próximo marco a partir de `main` atualizado. + +As Lições 4–8 compartilham uma branch de recurso e uma cópia de trabalho. Salve commits de checkpoint ao longo do caminho; criar a skill, configurar o MCP e selecionar QA não inicia novas branches de recurso. A Lição 9 explora os controles sem iniciar outro recurso ou PR. ## Pré-requisitos @@ -44,11 +52,13 @@ Antes de participar deste workshop, verifique se você tem: [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ [callout-student-plan-education]: https://github.com/education/students diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 9c9f0788..6768ade9 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -3,7 +3,7 @@ slug: zh-cn title: "动手实践 GitHub Copilot 智能体" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- GitHub Copilot 最近新增的功能为开发人员提供了贯穿整个软件开发生命周期 (SDLC) 的强大工具，包括处理 GitHub 上的议题和拉取请求、与外部服务交互，当然也包括创建代码。本实验将探索这些功能，并通过实际用例和技巧，帮助你充分发挥这些工具的价值。 @@ -23,7 +23,7 @@ GitHub Copilot 最近新增的功能为开发人员提供了贯穿整个软件 ### 💻 [Copilot CLI](cli/) -**GitHub Copilot CLI** 是一款在终端中运行的智能体助手。安装后，可以连接 MCP 服务器、使用计划模式生成代码，还能完全通过命令行构建自己的技能、自定义智能体和斜杠命令。 +**GitHub Copilot CLI** 是一款在终端中运行的智能体助手。完成设置后，学习九个核心模块：添加星级评分快速上手，建立指令，规划并构建筛选功能，创建 quality-checks 技能，通过 Playwright MCP 验证，创建 QA 智能体，再合并功能。最后探索 CLI 控件并进行总结。整个流程有三个拉取请求里程碑。 ### 🤖 [Copilot App](app/) diff --git a/docs/zh-cn/cli/0-prerequisites.md b/docs/zh-cn/cli/0-prerequisites.md index 0bc2d6a8..a7480db0 100644 --- a/docs/zh-cn/cli/0-prerequisites.md +++ b/docs/zh-cn/cli/0-prerequisites.md @@ -2,15 +2,22 @@ title: "练习 0：先决条件" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- 开始 Copilot CLI 练习前，需要先完成环境准备。将先创建 Tailspin Toys 存储库的个人副本，再启动一个 [codespace][codespaces]。下一节练习会使用其中集成的终端来安装并运行 Copilot CLI。 +在本练习中，你将： + +- 从 Tailspin Toys 模板创建自己的存储库。 +- 打开 codespace，确认工作区已准备好进行 CLI 设置。 + ## 设置实验存储库 为了给即将编写的代码创建一份存储库副本，需要基于 [模板][template-repository] 创建一个实例。这个新实例会包含实验所需的全部文件，后续练习都会在其中完成。 +使用模板的新副本。其中包含存储库指令、应用代码、测试和 CI，但不附带自定义智能体或技能。你将自行创建这些资产。如果回到旧副本，应先检查现有自定义配置再修改，不要覆盖自己的工作。 + 1. 在新的浏览器窗口中，访问本实验的 GitHub 存储库：`https://github.com/github-samples/tailspin-toys`。 2. 在实验存储库页面上，选择 **Use this template** 按钮创建自己的存储库副本。然后选择 **Create a new repository**。 @@ -27,6 +34,8 @@ lastUpdated: 2026-06-30 > > 通过模板创建存储库时，系统会自动创建一组 GitHub issue 作为积压工作。整个工作坊都会围绕这些 issue 展开，无需手动新建。 +等待议题初始化工作流完成，再到 **Issues** 选项卡中查找 **Allow users to filter games by category and publisher** 和 **Update our repository coding standards**。课程中使用它们的实际标题和 URL，不要假设议题编号。如果待办事项缺失，应先检查工作流结果再继续。 + ## 创建 codespace 接下来，将使用 codespace 完成实验练习。 @@ -50,8 +59,7 @@ codespace 的创建需要几分钟，但仍然比手动安装所有服务快得 > [!NOTE] > 本工作坊设计为在 codespace 或本地 [dev container][dev-containers] 中运行。这两种方式都能确保环境已安装顺畅体验所需的全部先决条件。如果更希望在本地运行，请在 VS Code 中打开克隆后的存储库，并在出现提示时选择 **Reopen in Container**——VS Code 会构建与 codespace 相同的 dev container。 -[codespaces]: https://github.com/features/codespaces -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers +codespace 准备就绪后，[练习 1][next-lesson]将打开其终端，在安装 Copilot CLI 前检查存储库、运行时和身份验证。 ## 总结 @@ -70,3 +78,5 @@ codespace 的创建需要几分钟，但仍然比手动安装所有服务快得 [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [codespaces-quickstart]: https://docs.github.com/codespaces/getting-started/quickstart [next-lesson]: ../1-install-copilot-cli/ +[codespaces]: https://github.com/features/codespaces +[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers diff --git a/docs/zh-cn/cli/1-install-copilot-cli.md b/docs/zh-cn/cli/1-install-copilot-cli.md index 31795df0..1990f5d4 100644 --- a/docs/zh-cn/cli/1-install-copilot-cli.md +++ b/docs/zh-cn/cli/1-install-copilot-cli.md @@ -2,7 +2,7 @@ title: "练习 1 - 安装 GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [GitHub Copilot CLI][about-copilot-cli] 是一个功能强大的代理式编码助手，可在终端中运行，让开发者通过命令行探索代码库、生成代码、运行命令并与外部工具交互。它可以帮助分担任务、请求变更，并保持专注。第一步自然是安装这个工具，好在可以使用已经熟悉的工具来完成。 @@ -21,10 +21,25 @@ lastUpdated: 2026-06-30 安装 Copilot CLI 前，需要先在 codespace 中打开终端窗口。 -1. 如果当前不在 codespace 中，请先返回。 +1. 返回 codespace，等待设置完成。 2. 按 Ctrl+\` 打开终端窗口。 3. 应该会在 VS Code 窗口底部看到终端面板。 +## 确认练习环境 + +在 codespace 终端中，确认当前位于自己的 Tailspin Toys 存储库，而不是研讨会内容存储库。阅读其中的 `README.md` 和 `package.json`，了解设置和检查命令。当前 Tailspin Toys 需要 Node.js 22.13 或更高版本、项目依赖项，以及用于 E2E 测试的 Playwright Chromium。 + +```bash +pwd +git remote -v +node --version +gh auth status +``` + +GitHub CLI（`gh`）可帮助检查 PR 和 CI。如果尚未完成身份验证，使用 `gh auth login` 并遵循浏览器指引。确认当前账户能够在此存储库中推送分支、创建及合并 PR；组织策略可能要求其他审查者参与。开始代码更改前，按存储库设置说明解决缺失的先决条件，并在授权安装前进行审查。 + +CLI 使用启动时所在的检出目录；开始对话不会自动创建隔离的工作树。本研讨会为每个 PR 里程碑使用一个分支。先合并星级评分和指令示例，再在练习 4–8 中保持同一筛选分支。 + ## 安装 Copilot CLI 可以通过 [npm][install-npm]、[WinGet][install-winget] 和 [Homebrew][install-homebrew] 安装 Copilot CLI。由于 GitHub Codespaces 已预装 Node.js，本练习使用 npm 安装 Copilot CLI。 @@ -35,7 +50,7 @@ lastUpdated: 2026-06-30 node --version ``` - 应看到版本 22 或更高（例如 `v22.x.x`）。 + Tailspin Toys 需要 22.13 或更高版本，即使 CLI 自身的要求有所不同。如果版本过旧，请遵循练习存储库的设置说明。 2. 使用 npm 在 codespace 中全局安装 Copilot CLI： @@ -51,8 +66,8 @@ lastUpdated: 2026-06-30 应看到显示的版本号（例如 `v1.0.XX`）。 -> [!TIP] -> 如果遇到权限错误，在某些系统中可能需要使用 `sudo npm install -g @github/copilot`。不过在 GitHub Codespaces 中通常不需要这样做。 +> [!NOTE] +> 如果安装因权限错误而失败，应检查 npm 配置或向研讨会导师求助，而不是提升权限后重新运行不熟悉的命令。 ## 使用 GitHub 完成验证 @@ -85,22 +100,39 @@ lastUpdated: 2026-06-30 2. 对于本工作坊，请选择 **Yes, and remember this folder for future sessions**，因为后续会持续在这个存储库中工作。 3. 向 Copilot 提一个简单问题，确认它运行正常： - ``` - What files are in this project? + ```plaintext + 这个项目中有哪些文件？ ``` 4. Copilot 应该会探索存储库，并给出项目结构摘要。 5. 试用 `/help` 命令查看可用的斜杠命令： - ``` + ```text /help ``` -6. 在终端中输入以下命令退出 Copilot CLI。后续练习还会回到 Copilot CLI。 +6. 在 Copilot 提示符处输入以下命令，退出此会话。你将为第一次更改启动新会话。 + ```text + /exit ``` - exit - ``` + +## 了解模式和权限 + +Copilot CLI 在启动时所在的目录和 Git 分支中工作。信任目录使其能够使用存储库上下文，但不等于批准所有工具操作。应审查文件更改、shell 命令和 GitHub 操作的权限请求。 + +从练习存储库根目录启动代码练习： + +```bash +copilot --enable-all-github-mcp-tools +``` + +GitHub MCP 服务器是内置的。此标志提供完整工具集，供处理议题和 PR；身份验证、存储库权限和工具批准仍然适用。该标志本身并不授权提交或创建 PR。 + +使用 Shift+Tab 在标准 **Interactive**、**Plan** 和 **Autopilot** 模式之间切换。发送请求前检查模式指示器。早期更改保持 Interactive，构建筛选功能前先规划，创建和审查自定义配置前明确切回 Interactive。 + +> [!CAUTION] +> 模式和权限设置是两回事。Autopilot 会自主持续工作；`--allow-all` 及其别名 `--yolo` 则授予全部工具、路径和 URL 权限。本研讨会不要求每个会话都使用无限制权限启动。即使在 codespace 中，授予访问权限前也应审查范围。 ## 总结和后续步骤 @@ -111,7 +143,7 @@ lastUpdated: 2026-06-30 - 信任一个目录，以便 Copilot CLI 可以处理其中内容。 - 确认安装运行正常。 -现在 Copilot CLI 已安装完成，接下来为 Copilot 提供一些项目上下文。继续前往[练习 2 - 通过 CLI 使用自定义说明][next-lesson]。 +现在 Copilot CLI 已安装完成，前往[练习 2 - 添加星级评分：快速上手][next-lesson]，完成一项便于审查的小改动。 ## 资源 @@ -120,7 +152,7 @@ lastUpdated: 2026-06-30 - [使用 Copilot CLI][using-copilot-cli] [previous-lesson]: ../0-prerequisites/ -[next-lesson]: ../2-custom-instructions/ +[next-lesson]: ../2-add-star-rating/ [install-copilot-cli]: https://docs.github.com/copilot/how-tos/set-up/install-copilot-cli [install-npm]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-npm-all-platforms [install-winget]: https://docs.github.com/copilot/how-tos/copilot-cli/set-up-copilot-cli/install-copilot-cli#installing-with-winget-windows diff --git a/docs/zh-cn/cli/10-review.md b/docs/zh-cn/cli/10-review.md new file mode 100644 index 00000000..0c1e0d82 --- /dev/null +++ b/docs/zh-cn/cli/10-review.md @@ -0,0 +1,67 @@ +--- +title: "练习 10 - 总结与后续步骤" +description: "回顾共同的开发工作流、可复用产出和 CLI 的三个拉取请求里程碑。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +你已使用 Copilot CLI，从一个小改动推进到经过规划、具有可复用验证方式的功能。练习 0–1 的设置准备了环境；练习 2–10 的九个核心模块展示了完整开发工作流。 + +## 回顾三个 PR 里程碑 + +| 里程碑 | 合并后的结果 | 审查习惯 | +| --- | --- | --- | +| PR 1：星级评分 | 在游戏卡片上显示现有 `starRating`，包括在 `null` 时显示 `No rating yet` | 保持改动范围明确，验证两种情况 | +| PR 2：自定义指令 | 范围明确的文档约定和小型真实代码示例 | 检查指令是否改善实际代码，而不只是聊天示例 | +| PR 3：筛选功能及验证 | 筛选功能、quality-checks 技能、QA 配置文件和相关测试 | 合并前审查全部检查点、当前 QA 证据和 CI | + +前两个 PR 都在下一个里程碑从更新后的 `main` 开始之前完成了合并。练习 4–8 共用一个分支和检出目录。检查点提交保留进度，无需为每个模块创建 PR。控件练习没有启动其他功能或 PR。 + +## 回顾共同产出 + +这些与 [Copilot app 研讨会][app-workshop]的核心成果相同，只是通过终端界面完成： + +- **存储库指令**说明项目上下文和标准；路径范围指令为相关文件补充细节。 +- **筛选实现和测试**满足议题及规划时批准的澄清内容。 +- **quality-checks 技能**封装可复用指令和实际 shell 脚本，用于运行项目的四项检查。 +- **Playwright MCP 配置**提供直接观察所需的浏览器工具。在此 CLI 流程中，它属于用户配置，而不是功能 PR。 +- **QA 自定义智能体**定义可复用角色：从需求出发，检查覆盖情况，使用技能和浏览器工具，并如实报告结果。 +- **PR 和验证证据**将已审查的更改与测试结果、浏览器观察、限制和 CI 联系起来。 + +技能不只是一份命令列表，配置文件也不只是一个文件名。在依赖报告前，你检查了生成的资产、确认了实际执行，并选择了自定义智能体。 + +## 区分各阶段的验证目的 + +规划在实现前明确了需求。Autopilot 执行范围明确的计划；切回 Interactive，则在编写自定义配置前恢复了明确的审查节点。 + +实现阶段在任何技能存在之前使用现有 npm 检查。技能练习证明了随附脚本和参数转发可用。MCP 展示直接浏览器交互，而不是重复完整套件。QA 将标准、覆盖情况、浏览器证据和全部四项技能驱动的检查结合起来。PR 复用当前 QA 结果，同时由 CI 检查提交的修订版本。 + +失败和阻塞项都是有用的结果。缺少浏览器工具、跳过测试、服务器内容过时或需求未明确，都意味着 **NO-GO**，而不是允许降低标准。新增测试必须针对真实缺口；现有覆盖充分时，不添加测试才是正确做法。 + +## 延续这些习惯 + +- 向 Copilot 提供议题、更改原因和明确边界。 +- 批准自主工作前审查计划。 +- 运行前检查生成的指令、技能和配置文件。 +- 清楚结果对应哪个检出目录、分支、服务器和修订版本。 +- 采用确有必要的最小修正，并在更改后更新证据。 +- 明确授权安装、破坏性操作、共享和 PR 合并。 + +## 继续学习 + +[Copilot app 研讨会][app-workshop]通过图形界面实现共同成果，并增加画布里程碑。[VS Code 研讨会][vscode-workshop]和 [Cloud agent 研讨会][cloud-workshop]探索与智能体协作的其他方式。 + +使用 [Awesome Copilot][awesome-copilot] 查找指令、技能和自定义智能体示例。[练习 5 中的技能示例][skill-examples]包括贡献工作流、需求文档、图表和浏览器测试。采用社区内容前，审查先决条件和行为。 + +日常使用时可查阅 [CLI 命令参考][cli-reference]、[智能体技能文档][agent-skills]和[自定义智能体文档][custom-agents]。继续在范围明确的任务中尝试，并仅通过批准的渠道共享已审查材料。 + +[previous-lesson]: ../9-slash-commands/ +[app-workshop]: ../../app/ +[vscode-workshop]: ../../vscode/ +[cloud-workshop]: ../../cloud/ +[skill-examples]: ../5-agent-skills/#更多技能示例 +[awesome-copilot]: https://github.com/github/awesome-copilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference +[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills +[custom-agents]: https://docs.github.com/copilot/concepts/agents/copilot-cli/about-custom-agents diff --git a/docs/zh-cn/cli/2-add-star-rating.md b/docs/zh-cn/cli/2-add-star-rating.md new file mode 100644 index 00000000..4c0a5d9a --- /dev/null +++ b/docs/zh-cn/cli/2-add-star-rating.md @@ -0,0 +1,87 @@ +--- +title: "练习 2 - 添加星级评分：快速上手" +description: "显示现有游戏评分，审查并验证更改，再合并第一个拉取请求。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +从一个容易理解和验证的小改动开始。Tailspin Toys 已存储每款游戏的 `starRating`，并在详情页上显示。你将在游戏卡片上显示这个现有值，并在游戏没有评分时给出明确提示。 + +在本练习中，将： + +- 在 Interactive CLI 会话中请求范围明确的更改。 +- 检查差异，验证已评分和未评分的卡片。 +- 提交、打开、审查并合并 PR 1。 + +## 场景 + +访客可以在游戏详情页查看评分，却无法在浏览目录时比较评分。Tailspin Toys 希望在游戏卡片上展示已有评分，并明确标示未评分状态。这个小改动让你在处理更大功能前，练习如何请求、审查和交付工作。 + +## 开始第一个里程碑 + +在练习存储库根目录中，确认工作树干净，更新 `main`，再创建分支。如果 `git status` 显示意外更改，应先解决再切换，不要丢弃这些更改。 + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-star-rating +copilot --enable-all-github-mcp-tools +``` + +出现提示时信任存储库。确认处于 **Interactive** 模式，并使用 `/model` 查看可用模型或选择 **Auto**。工具批准请求出现时，逐一审查。 + +## 请求更改 + +发送以下提示词： + +```plaintext +在游戏卡片上显示每款游戏的星级评分。Game 类型已包含 starRating 字段，表示满分为 5 的评分，游戏尚未评分时为 null。在 src/components/GameCard.astro 的每张卡片上显示评分；当 starRating 为 null 时，改为显示 "No rating yet"。保持改动小，不要重构卡片布局。 + +检查并遵循存储库指令。使用现有数据模型，不要添加评分 API、新的数据库模式或无关功能。为已评分和未评分情况添加或更新适当的测试。暂时不要提交、推送或打开拉取请求。 +``` + +Copilot 应先检查现有类型和组件，再进行编辑。除了最终回复，也要阅读工具活动。充满信心的摘要并不能证明实现正确。 + +## 审查并验证 + +1. 输入 `/diff`，在编辑器或差异视图中检查每个更改的文件。 +2. 确认卡片使用现有的 `starRating`，显示满分为 5 的评分值，并在 `null` 时显示 `No rating yet`。仅使用真值判断可能将数值零误判为未评分。 +3. 检查更改是否保留卡片布局，并为评分提供有意义的文本标签，而不只依赖星形符号或颜色。 +4. 让 Copilot 使用现有检查验证更改： + + ```plaintext + 检查 package.json 和测试配置，然后运行适合此次卡片改动的 lint、类型检查，以及现有单元测试或 E2E 测试。验证数值评分和 null 回退状态；报告确切命令和结果，包括覆盖缺口或受阻的检查。不要安装任何内容、更改分支、提交、推送或打开 PR。 + ``` + +5. 审查命令输出和测试更改。交付前解决失败项；安装缺失的先决条件前先询问。 + +要在浏览器中观察卡片，在同一检出目录中打开第二个终端并运行： + +```bash +npm run dev +``` + +在 codespace 的 **Ports** 面板中打开转发的端口。检查主页上的已评分卡片。如果当前种子数据中没有未评分示例，应要求使用自动化测试夹具覆盖 `null`，不要声称已观察到未评分卡片。运行 E2E 检查或离开本练习前，在开发服务器所在终端按 Ctrl+C 停止它。Playwright 自动化测试不得复用其他检出目录的服务器。 + +## 创建并合并 PR 1 + +审查更改且检查通过后，单独授权此里程碑： + +```plaintext +审查当前差异和检查结果。仅提交已审查的星级评分改动及其测试，推送当前分支，并创建以 main 为目标的拉取请求；如果存储库有 PR 模板，使用该模板。包含更改摘要和实际验证结果。不要合并 PR 或开始其他任务。 +``` + +打开返回的 PR URL。检查 **Files changed** 和检查结果，而不只是智能体的摘要。解读 CI 时，阅读 Tailspin 存储库的工作流定义；CI 不能替代浏览器观察。解决失败项，并重新验证更改后的代码。 + +PR 满足存储库的审查和检查要求后，选择 **Merge pull request** 并在 GitHub 上确认合并。如果分支保护要求其他审查者参与，等待其批准。确认 PR 为 **Merged** 后再继续。 + +使用 `/exit` 退出 Copilot 会话。下一练习会先更新本地 `main`，再创建指令分支；不要从这个尚未合并的功能分支开始。 + +## 总结与后续步骤 + +你已完成第一个循环：范围明确的提示词、已审查的代码、验证证据和已合并的 PR。接下来，[使用自定义指令引导 Copilot][next-lesson]，并在第二个小型 PR 中展示文档约定的效果。 + +[previous-lesson]: ../1-install-copilot-cli/ +[next-lesson]: ../3-custom-instructions/ diff --git a/docs/zh-cn/cli/2-custom-instructions.md b/docs/zh-cn/cli/2-custom-instructions.md deleted file mode 100644 index 81464ddd..00000000 --- a/docs/zh-cn/cli/2-custom-instructions.md +++ /dev/null @@ -1,243 +0,0 @@ ---- -title: "练习 2 - 自定义说明（Copilot CLI）" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -[← 上一课：安装 Copilot CLI][previous-lesson] · [下一课：使用 CLI 生成代码 →][next-lesson] - -使用生成式 AI 时，上下文至关重要。如果某项任务需要按特定方式完成，或者存在 Copilot 应该知道的背景信息，就需要确保这些上下文可用。本工作坊会探索几种帮助 Copilot 的工具。这里先从[说明文件][instruction-files]开始，它们通常关注代码本身应如何组织。这能帮助 Copilot 不仅理解想要*什么*代码，也理解代码应当*如何*组织。 - -在本练习中，将： - -- 了解项目专属上下文、编码准则和文档标准如何通过存储库自定义说明及按路径限定范围的说明文件传递给 Copilot； -- 在当前说明已生效的前提下，生成过滤功能的第一块数据切片（publisher helper）； -- 向 `.github/copilot-instructions.md` 添加一项新的全库标准； -- 运行后续提示，观察重新生成的代码如何采用这项新标准； -- 提交说明更新和 helper，为下一节练习做好准备。 - -> [!CAUTION] -> 生成的代码可能与设定的某些标准不完全一致。Copilot 是非确定性的。这里的目标是观察更新说明后行为变化的*趋势*，而不是逐字符匹配输出。 - -## 说明文件 - -### 场景 - -和优秀的开发团队一样，Tailspin Toys 也有一套开发实践准则和要求，包括： - -- 数据层始终需要单元测试。 -- UI 应使用深色模式，并具有现代感。 -- 应以 TSDoc 文档注释的形式为代码添加文档。 -- 每个文件顶部都应添加一段注释，说明该文件的作用。 - -通过使用说明文件，可以确保 Copilot 拥有正确的信息，从而按照这些实践要求完成任务。 - -### 自定义说明 - -自定义说明可用于向 Copilot 提供上下文和偏好，帮助它更好地理解编码风格和需求。这是一项非常强大的功能，能够引导 Copilot 给出更相关的建议和代码片段。可以指定偏好的编码约定、库，甚至希望包含的注释类型。既可以为整个存储库创建说明，也可以为特定文件类型创建说明，以提供任务级上下文。 - -说明文件分为两类： - -- `.github/copilot-instructions.md`：这是一个针对整个存储库**每次**请求都会发送给 Copilot 的单一说明文件。这个文件应包含项目级信息——也就是大多数发送给 Copilot 的聊天或 CLI 请求都会用到的上下文。可以包括所用技术栈、构建内容概览、最佳实践以及其他全局指导。 -- `.github/instructions/*.instructions.md`：可针对特定任务或文件类型创建。可以用来为特定语言（如 TypeScript 或 Astro）提供指导，也可以针对创建 UI 组件或新增一组单元测试等任务提供指导。 - -> [!NOTE] -> 在 IDE 中工作时，说明文件仅用于 Copilot Chat 的代码生成——不会用于代码补全或下一次编辑建议。 -> -> Copilot Chat、Copilot CLI 和 Copilot cloud agent 在生成代码时都会使用存储库级说明文件以及 `*.instructions.md` 文件（带 `applyTo` front matter）。 -> -> 此外，Copilot [还支持采用其他标准的说明文件][custom-instructions-support]，包括 `AGENTS.md` 和 `CLAUDE.md` 文件。 - -### 管理说明文件的最佳实践 - -关于如何创建说明文件的完整讨论超出了本工作坊范围。不过，示例项目中的例子展示了一种具有代表性的做法。从高层来看： - -- 将 `copilot-instructions.md` 中的说明聚焦于项目级指导，例如构建内容说明、项目结构和全局编码标准。 -- 使用 `*.instructions.md` 文件为特定文件类型（单元测试、Astro 组件、数据层）或特定任务提供具体说明。 -- 使用自然语言。保持指导清晰。提供代码应该如何写以及不应该如何写的示例。 - -创建说明文件没有唯一正确的方法，就像使用 AI 也没有唯一正确的方法一样。通过不断实验，会逐渐找到最适合项目的方式。 - -> [!TIP] -> 每个使用 GitHub Copilot 的项目都应该具备一套完善的说明文件。查看本项目中的这些文件时，可能会注意到其中覆盖了许多任务类型，包括 [UI 更新][ui-instructions] 和 [Astro][astro-instructions]。 -> -> Copilot 也可以帮助生成说明文件。不同界面对这一功能的暴露方式不同（例如 VS Code 中的 **Configure Chat → Generate Agent Instructions**，或 Copilot CLI 中的 `/init`）——所在路径的课程会在相关位置指出。 -> -> 想找模板或起点？可以看看 [awesome-copilot][awesome-copilot]，这是一个汇集说明文件、自定义智能体和其他资源的存储库。 - -[ui-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/ui.instructions.md -[astro-instructions]: https://github.com/github-samples/tailspin-toys/blob/main/.github/instructions/astro.instructions.md -[awesome-copilot]: https://github.com/github/awesome-copilot -[custom-instructions-support]: https://docs.github.com/copilot/reference/custom-instructions-support - -## 探索本项目中的自定义说明文件 - -花一点时间阅读此存储库随附的说明文件——其中包含一个核心 `copilot-instructions.md`，以及一组面向不同任务的 `*.instructions.md` 文件。可以在编辑器中打开它们，也可以在 GitHub Web UI 中查看。 - -1. 打开 `.github/copilot-instructions.md`。 -2. 浏览该文件，注意其中对项目的简要说明，以及 **Agent notes**、**Code standards**、**Scripts** 和 **Repository Structure** 等部分。在 **Code standards** 下，还要注意嵌套的 **GitHub Actions Workflows** 指导。这些内容适用于与 Copilot 的任何交互。 -3. 打开 `.github/instructions` 文件夹并浏览。可以看到其中包含针对 Astro 文件、Drizzle 数据层、测试等内容的说明。 -4. 打开 `.github/instructions/unit-tests.instructions.md`。注意顶部的 `applyTo` 字段——它设置了一个相对于存储库根目录的 glob，用于决定这些说明适用于哪些文件。在这里，任何 TypeScript 测试文件（例如匹配 `**/*.test.ts` 的文件）都会匹配。 -5. 注意其中针对为本项目创建单元测试的专门说明。 -6. 最后，打开 `.github/instructions/drizzle.instructions.md` 并滚动到底部。注意其中链接到了其他说明文件（如 `unit-tests.instructions.md`）以及项目中的现有文件。这样可以把较大的说明集拆分为更小、可复用的文件，并在生成代码时为 Copilot 指出可参考的示例。（其中路径是相对于说明文件本身，而不是存储库根目录。） - -> [!NOTE] -> `copilot-instructions.md` 中的 **Code formatting requirements** 部分记录了项目的编码标准，但目前还没有要求在代码中编写文档。接下来的步骤会添加 TSDoc 文档注释和文件注释头规则。 - -## 创建分支 - -接下来会修改代码，因此先创建一个分支来工作。 - -1. 在 codespace 终端中，创建并切换到新分支： - - ```bash - git checkout -b update-custom-instructions - ``` - -2. 确认 Copilot CLI 已安装并完成验证： - - ```bash - copilot --version - ``` - - 如果找不到该命令，或者尚未登录，请返回[练习 1 - 安装 GitHub Copilot CLI](../1-install-copilot-cli/)。 - -## 在更新说明*之前*使用 Copilot CLI - -为了看清自定义说明的影响，先在当前说明生效的情况下生成代码。稍后会更新该文件，并再次运行后续提示。 - -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 - -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. 确保 Copilot CLI 会话从**存储库根目录**启动，这样它才能自动读取 `.github/copilot-instructions.md`。 -2. 在 Copilot CLI 提示符中，请它生成过滤 UI 将要使用的 publishers helper： - - ```plaintext - Create a new data-access helper at src/lib/publishers.ts to return a list of all publishers. It should return the name and id for all publishers. Do not run the tests yet. - ``` - -3. Copilot CLI 会探索项目、提出计划，并在这个 `--yolo` 会话中写入文件。观察终端输出中的变更，然后在编辑器中查看结果。 -4. 在编辑器中打开生成的 `src/lib/publishers.ts`。 -5. 注意，这个 helper 是一个带类型的函数，第一参数接收 `db` 客户端，并返回一个带类型的 publishers 数组——这来自 `.github/instructions/drizzle.instructions.md` 中的数据层约定（该文件适用于 `src/lib/*.ts`）。 -6. 注意，生成的代码**缺少** TSDoc 文档注释和文件级注释头。 - -> [!CAUTION] -> Copilot 是概率性的——即使没有明确要求，它也有可能会添加文档注释。如果出现这种情况也没关系；更新说明后的*一致性*提升仍然是这里要观察的重点。 - -## 添加新的全库标准 - -如前所述，`.github/copilot-instructions.md` 旨在向 Copilot 提供项目级信息。现在为它补充存储库编码标准，以改善代码建议质量。 - -1. 重新打开 `.github/copilot-instructions.md`。 -2. 找到 **Code formatting requirements** 部分，应该在第 27 行附近。注意它已经记录了项目的编码标准——但尚未加入代码内文档规则，这就是生成的 helper 没有文档注释的原因。 -3. 在现有标准的正下方添加以下 markdown 行，指示 Copilot 添加文件注释头和 TSDoc 文档注释： - - ```markdown - - Every exported function should have a TSDoc comment describing its purpose, parameters, and return value. - - Before imports or any code, add a comment block to the file that explains its purpose. - ``` - -4. 保存 `copilot-instructions.md`。 - -> [!TIP] -> 正如上一课所示，说明文件既可以在存储库级别创建（`.github/copilot-instructions.md`）用于全局指导，也可以创建为 `*.instructions.md` 文件，用于特定语言、文件类型或任务。像刚刚添加的文档注释规则这类项目级标准，就应该放在存储库级文件中。 - -## 重新运行提示并观察变化 - -既然说明中已经加入文档注释规则，就请 Copilot CLI 更新刚刚生成的 publishers 文件。同一条标准指令会引导这次重写。 - -1. 在 Copilot CLI 会话中发送 `/clear`，以全新的对话开始。 -2. 发送以下提示： - - ```plaintext - Update src/lib/publishers.ts to follow the latest documentation conventions in .github/copilot-instructions.md. - ``` - -3. 等待编辑完成，然后重新打开 `src/lib/publishers.ts`。 -4. 注意，文件现在会以类似下面的注释块开头： - - ```typescript - /** - * Tailspin Toys Crowd Funding platform 的 publisher 数据访问辅助函数。 - * 提供从数据库检索 publisher 信息的函数。 - */ - ``` - -5. 注意，生成的函数现在会包含类似下面的 TSDoc 注释： - - ```typescript - /** - * 返回所有 publisher 的列表，包含其 id 和 name。 - * - * @param db - Drizzle 数据库客户端。 - * @returns 一个 Promise，解析为 publisher 对象数组。 - */ - ``` - -6. 保留这个更新后的文件。它是下一节练习将继续扩展的第一块数据切片。 - -## 提交并推送这第一块过滤功能 - -1. 在终端中确认已变更的文件： - - ```bash - git status - ``` - -2. 暂存说明更新和 helper： - - ```bash - git add .github/copilot-instructions.md src/lib/publishers.ts - ``` - -3. 提交变更： - - ```bash - git commit -m "Add doc comment standards and publishers helper foundation" - ``` - -4. 推送分支： - - ```bash - git push -u origin update-custom-instructions - ``` - -## 总结和后续步骤 - -已经了解了 Copilot 如何从本项目中的说明文件获取上下文，然后使用 Copilot CLI 完成了以下事项： - -- 在*现有*说明的基础上，生成了用于过滤功能的 publishers 数据访问 helper 基础； -- 向 `.github/copilot-instructions.md` 添加了一项新的全库标准； -- 运行后续提示，并观察重新生成的代码如何采用这项新标准； -- 提交并推送说明更新和 helper 基础。 - -下一步，将在[生成代码练习][next-lesson]中应用这些说明，实现积压工作中的功能。 - -## 资源 - -- [GitHub Copilot 自定义的说明文件][instruction-files] -- [创建自定义说明的最佳实践][instructions-best-practices] -- [为 Copilot 编写更好自定义说明的 5 个技巧][copilot-instructions-five-tips] -- [Awesome Copilot——说明文件及其他资源集合][awesome-copilot] - -[previous-lesson]: ../1-install-copilot-cli/ -[next-lesson]: ../3-generating-code/ -[instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses -[instructions-best-practices]: https://docs.github.com/enterprise-cloud@latest/copilot/using-github-copilot/coding-agent/best-practices-for-using-copilot-to-work-on-tasks#adding-custom-instructions-to-your-repository -[copilot-instructions-five-tips]: https://github.blog/ai-and-ml/github-copilot/5-tips-for-writing-better-custom-instructions-for-copilot/ diff --git a/docs/zh-cn/cli/3-custom-instructions.md b/docs/zh-cn/cli/3-custom-instructions.md new file mode 100644 index 00000000..5defd14a --- /dev/null +++ b/docs/zh-cn/cli/3-custom-instructions.md @@ -0,0 +1,113 @@ +--- +title: "练习 3 - 使用自定义指令引导 Copilot" +description: "添加范围明确的文档约定，在现有代码上展示其效果，并合并第二个拉取请求。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +上下文帮助 Copilot 不仅理解要构建*什么*，也理解团队期望*如何*编写代码。你将添加范围明确的文档约定，观察其对真实代码的影响，并将指令和示例改动通过 PR 2 一并合并。 + +在本练习中，将： + +- 探索存储库范围和路径范围的指令。 +- 添加文档标准，不提前实现筛选功能。 +- 在一个现有的小型辅助函数或组件上展示标准的效果。 +- 验证并合并指令里程碑。 + +## 场景 + +Tailspin Toys 团队希望将有用的代码文档变成可重复执行的约定，而不是每次对话都要有人记得提出的要求。你将在存储库指令中添加标准，并在现有代码上展示效果，不改变行为，也不提前开始筛选功能。 + +## 探索指令 + +存储库已包含两类有用的指令： + +- `.github/copilot-instructions.md` 提供存储库范围的上下文，例如技术栈、结构和通用实践。 +- `.github/instructions/*.instructions.md` 提供限定范围的指导。frontmatter 中的 `applyTo` glob 指明这些指令适用的文件。 + +在编辑器中打开这些文件： + +1. 阅读 `.github/copilot-instructions.md`，找到当前编码和验证标准。 +2. 探索 `.github/instructions/`，包括 Astro、数据层和测试指导。 +3. 在 `unit-tests.instructions.md` 中检查 `applyTo` 模式和测试约定。 +4. 在 `drizzle.instructions.md` 中检查数据访问模式及示例引用。 + +保持存储库范围指令简洁，将文件特定的细节放入相关范围指令文件，并避免同一规则的多个副本相互矛盾。[GitHub 指令支持参考][instruction-support]说明了各操作环境支持的指令格式。 + +> [!NOTE] +> 指令会影响生成结果，但不保证始终遵循。审查时既要检查指令文本，也要检查其对代码的影响。如果 Copilot 已生成良好注释，本课的目的就是让约定明确且可重复，而不是强行制造前后对比中的失败。 + +## 从已合并的 PR 1 开始 + +确认星级评分 PR 已合并。在练习存储库终端中，从更新后的 `main` 开始下一个里程碑： + +```bash +git status +git switch main +git pull --ff-only +git switch -c update-custom-instructions +copilot --enable-all-github-mcp-tools +``` + +如果工作树不干净或拉取失败，应先解决再继续。保持 **Interactive** 模式。 + +在存储库的 **Issues** 选项卡中，找到 **Update our repository coding standards**，复制其实际 URL。该议题提供更广泛的上下文：说明意图、记录导出的数据层函数和组件契约，并持续更新注释。本练习只处理其中范围明确的文档工作，不进行全库重构，也不承诺完成每项议题标准。 + +## 添加文档约定 + +将占位符替换为实际议题 URL，然后发送： + +```plaintext +阅读此编码标准议题以了解上下文：。检查现有存储库指令和范围指令。添加范围明确的文档约定：说明意图，而不是复述代码；使用 TSDoc/JSDoc 记录 db/ 和 src/lib/ 中导出函数的用途、参数和返回值；记录可复用 Astro 组件的 Props 契约；并在相关代码变化时同步更新注释。 + +将每条规则放入适当的现有指令文件，避免重复或矛盾。保留现有格式和 lint 标准；在适当位置从 README 链接到或概述该文档约定。将此次更改限定为文档标准，不要迁移格式工具或重写整个存储库。不要创建技能或智能体、实现筛选功能、提交、推送或打开 PR。停止，让我在进行示例改动前检查指令。 +``` + +检查差异。约定应鼓励有用的注释，而不是要求每个文件都有样板标头，或添加只重复显而易见代码的注释。继续前先请求修正。 + +## 在真实代码上展示约定 + +检查存储库后，选择一个现有的小型导出辅助函数或可复用组件。它不必是发行商辅助函数，也不要求 `src/lib/publishers.ts` 已存在。 + +发送： + +```plaintext +根据更新后的指令，选择一个文档可以更清晰的现有小型导出辅助函数或可复用 Astro 组件。直接在该文件中应用约定，不改变运行时行为，也不添加筛选功能。说明哪条指令指导了改动，并在提交或打开 PR 前停止。 +``` + +打开实际更改的文件。对于辅助函数，检查注释是否准确描述参数、返回值和注入的数据库参数；对于组件，检查是否记录了 `Props` 契约。确认说明与代码一致，而不只是寻找注释块。 + +> [!TIP] +> 聊天中的示意代码片段不算示例改动，应检查真实的存储库更改。如果所选代码已满足约定，应选择另一个确有改进必要的小型现有目标，而不是添加冗余注释。 + +## 验证并合并 PR 2 + +让 Copilot 验证已审查的更改： + +```plaintext +审查指令更改和小型文档示例改动。确认运行时行为未改变。检查 package.json，运行 npm run lint 和 npm run typecheck:all，并在代码改动确有需要时运行受影响的现有测试。报告确切命令和结果。暂时不要安装任何内容、创建技能、提交、推送或打开 PR。 +``` + +解决失败项，检查最终差异，然后授权此里程碑： + +```plaintext +仅提交已审查的文档指令、直接相关的 README 更新和小型代码示例。推送当前分支，并按照存储库的 PR 模板创建以 main 为目标的 PR。包含验证结果，并将编码标准议题作为部分贡献进行引用；除非确已满足每项议题标准，否则不要使用关闭议题的关键字。不要合并或开始筛选功能。 +``` + +打开 PR URL，检查 **Files changed** 并审查 CI。全部必需检查和审查通过后，在 GitHub 上合并，并确认 PR 2 为 **Merged**。使用 `/exit` 退出 CLI 会话。此 PR 合并前，不要开始下一个里程碑。 + +## 总结与后续步骤 + +文档约定和真实示例改动现已进入 `main`。接下来，在基于该合并状态的新分支中，[使用 Plan 和 Autopilot 构建筛选功能][next-lesson]。 + +## 资源 + +- [添加存储库自定义指令][repository-instructions]说明存储库范围和路径范围的指导。 +- [Awesome Copilot][awesome-copilot] 提供可审查并调整的示例，不应盲目采用。 + +[previous-lesson]: ../2-add-star-rating/ +[next-lesson]: ../4-build-filtering/ +[instruction-support]: https://docs.github.com/copilot/reference/custom-instructions-support +[repository-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions +[awesome-copilot]: https://github.com/github/awesome-copilot diff --git a/docs/zh-cn/cli/3-generating-code.md b/docs/zh-cn/cli/3-generating-code.md deleted file mode 100644 index f6e91d41..00000000 --- a/docs/zh-cn/cli/3-generating-code.md +++ /dev/null @@ -1,99 +0,0 @@ ---- -title: "练习 3 - 使用 GitHub Copilot CLI 添加项目功能" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -正如预期，使用 GitHub Copilot CLI 执行的核心任务之一，就是向项目添加功能、特性和代码。现在从积压工作中选取一个 issue，请 Copilot 帮助实现它。 - -## 场景 - -现在到了完成项目过滤功能的时候。积压工作中已经有这个过滤 issue，上一节练习还提供了一个基础 helper。接下来让 Copilot 获取 issue 详情，考虑现有工作，并补齐剩余功能。 - -在本练习中，将： - -- 使用计划模式生成实现过滤功能的计划。 -- 使用 Copilot 生成向网站添加过滤功能所需的代码。 - -完成本练习后，项目中将新增这项功能。 - -## 使用计划模式 - -AI 最适合做的事情之一就是规划。很多时候，对要构建的内容已经有大致想法，只是需要一个对象来帮助梳理思路。AI 工具可以通过追问和分析潜在问题或遗漏项，帮助把想法变得更清晰。为支持这一过程，Copilot CLI 提供了计划模式。此外，花在规划上的时间也会帮助 Copilot 生成更符合要求的代码。 - -接下来将通过 Copilot CLI 的计划模式，开始创建这项新功能。 - -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 - -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. 在 Copilot CLI 中输入以下提示，根据过滤 issue 创建计划： - - ``` - /plan Retrieve the issue on the repository related to adding filtering. We already added a publishers helper in src/lib/publishers.ts, so treat that as existing work and plan the remaining updates (games filtering logic, UI, and tests). - ``` - -2. Copilot 在生成计划时可能会提出后续问题。出现时，可根据希望实现功能的方式进行回答。 -3. 计划生成后，查看这份蓝图。应能看到它建议在数据层和 UI 中进行剩余变更，并生成测试。 -4. Copilot CLI 会提供继续反馈计划的能力。可将光标移到指定区域，然后输入建议。Copilot 会把这些建议整合进新版本计划。 -5. 满意后，选择 Copilot 提供的选项，开始构建这个新功能。 - -> [!NOTE] -> 由于 Copilot 是概率性的，提供的具体文本和选项会有所不同。但会看到一个开始构建的选项，内容大致类似： -> -> `Yes, and switch to autopilot mode`. -> -> Copilot 可能会像上面的示例一样，提供启用 [autopilot mode](https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot) 的选项。autopilot mode 允许 Copilot CLI 在每一步后无需等待输入，自主完成整个任务。给出初始指令后，Copilot CLI 会自动执行各个步骤，直到判断任务完成。由于当前运行在受控环境中，可以放心启用 autopilot 并允许所有工具。 - -6. Copilot 会开始生成文件。 - -> [!NOTE] -> 这个操作很可能需要几分钟。会看到 Copilot 编辑和创建文件、更新和生成测试，并运行全部测试以确保成功。此时可以顺便回顾前面学到的内容，或者喝点东西休息一下。 - -## 查看代码 - -所有 AI 生成的代码在合并到生产环境前都需要审查。现在就来查看 Copilot 为实现新功能而创建和修改的文件。 - -1. 在 Copilot CLI 中使用以下命令显示“diff”或代码变更： - - ``` - /diff - ``` - -2. 注意已更改的文件。使用方向键左右切换查看不同文件。应能看到游戏列表页面（新过滤控件和客户端过滤逻辑所在位置）、`src/lib/games.ts`，以及 `games.test.ts` 等测试文件的更新。如果 Copilot 为了与完整实现保持一致而优化了现有 helper，也可能会看到 `publishers.ts` 的更新。 - -## 总结和后续步骤 - -现在已经借助 Copilot CLI 为网站添加了过滤功能。具体来说，完成了以下事项： - -- 使用计划模式生成了实现过滤功能的计划。 -- 生成了向网站添加过滤功能所需的代码。 - -当然，下一步就是确认它确实可用。在打开 pull request 之前，先[使用 Playwright MCP 服务器测试这个功能][next-lesson]。 - -## 资源 - -- [使用 Copilot CLI][using-copilot-cli] -- [关于 Copilot CLI][about-copilot-cli] -- [Copilot CLI 中的上下文管理][context-management] - -[previous-lesson]: ../2-custom-instructions/ -[next-lesson]: ../4-mcp/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management diff --git a/docs/zh-cn/cli/4-build-filtering.md b/docs/zh-cn/cli/4-build-filtering.md new file mode 100644 index 00000000..2b1989ac --- /dev/null +++ b/docs/zh-cn/cli/4-build-filtering.md @@ -0,0 +1,114 @@ +--- +title: "练习 4 - 使用 Plan 和 Autopilot 构建筛选功能" +description: "明确筛选需求，批准实现计划，验证代码，并在功能分支上保存检查点。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +现在构建较大的功能：让用户按类别和发行商筛选游戏。你将在编码前规划，明确授权 **Autopilot**，审查并测试实现，再保存检查点。本练习不创建技能、QA 智能体或功能 PR。 + +在本练习中，你将： + +- 阅读筛选议题，在 Plan 模式中就不明确的需求达成共识。 +- 明确批准 Autopilot 在限定范围内实现功能。 +- 审查差异和全部四项检查结果，然后保存检查点。 + +## 场景 + +Tailspin Toys 的游戏目录不断扩大，访客需要按类别和发行商缩小游戏范围。待办 issue 描述了功能，但类别如何组合等细节需要在编码前达成共识。你将使用 Plan 模式确定这些决策，然后授权 Autopilot 在明确范围内实现功能。 + +## 开始筛选里程碑 + +确认 PR 1 和 PR 2 已合并。在练习存储库终端中运行： + +```bash +git status +git switch main +git pull --ff-only +git switch -c add-game-filtering +copilot --enable-all-github-mcp-tools +``` + +仅在工作树干净且已从 `main` 成功更新后继续。练习 4–8 使用同一分支和检出目录。后续检查点提交会添加技能和 QA 配置文件；不要为每项练习创建分支。 + +## 获取实际议题 + +在存储库的 **Issues** 选项卡中找到 **Allow users to filter games by category and publisher**，复制其 URL。不要假定模板中的文件名或某个议题编号就能标识个人副本中的议题。 + +当前议题要求： + +- 选择一个或多个类别。 +- 按发行商筛选，并与类别组合。 +- 在 `src/lib/` 中提供支持两种筛选的数据访问辅助函数。 +- 提供支持键盘导航、适当 ARIA、可见焦点状态和 `data-testid` 属性的无障碍控件。 +- 使用 Vitest 为辅助函数提供单元测试覆盖，使用 Playwright E2E 覆盖筛选行为。 + +以实际议题为准。保留其 URL 和批准的澄清内容，以供练习 7 的 QA 提示词使用。 + +## 编码前先规划 + +使用 Shift+Tab 选择 **Plan** 模式，或使用 `/plan` 开始。替换议题占位符后发送： + +```plaintext +规划此议题描述的筛选功能：。提出改动前，阅读议题、存储库指令、现有数据访问辅助函数、UI 和测试。以当前检出内容为基线，不要假设已创建发行商辅助函数。 + +涵盖多类别选择、发行商筛选、两者组合、数据访问支持、无障碍控件和单元/E2E 覆盖。对于未明确的行为，例如多个类别如何组合、清除筛选和空结果，请让我澄清；将决定与批准的计划一并记录。保留静态 Astro 架构，不要引入不必要的服务器 API。 + +规划在当前分支上的实现，包括所需的单元测试和 E2E 测试，以及通过 npm run lint、npm run test:unit、npm run test:e2e 和 npm run typecheck:all 进行验证。先检查先决条件和服务器归属；报告阻塞项，不要安装软件或停止无关进程。 + +将以下执行边界纳入计划：在我批准后，仅实现筛选功能和所需测试，运行检查，然后停止，供我审查。不要创建 quality-checks 技能、QA 智能体或后续研讨会产出。不要更改分支、提交、推送、打开或合并 PR。 + +在我批准计划前，不要编辑应用代码或开始实现。 +``` + +回答后续问题。不要在之后添加未公开的验收标准：将约定的答案与议题 URL 一并保存，让实现、浏览器检查和 QA 使用相同需求。 + +审查计划中的数据层和 UI 改动、测试、无障碍控件，以及已合并的文档约定。确认计划明确包含全部四项检查、停止供审查的边界，以及禁止提前创建后续研讨会产出、更改分支、提交、推送和执行 PR 操作的要求。如果缺少任何限制或标准，或提出议题范围之外的工作，应在批准前请求修订。 + +## 明确批准 Autopilot + +只有计划已包含审查后的范围和执行边界，才能使用计划批准选项 **Accept plan and build on autopilot**。如果当前版本措辞不同，明确选择切换到 **Autopilot** 的选项，再检查模式指示器。批准后即开始执行范围明确的计划；不要依赖工作开始后再通过后续提示词添加限制。 + +> [!CAUTION] +> Autopilot 控制持续工作，而不只是工具权限。选择前审查权限对话框。完整权限允许访问工具、路径和 URL；有限权限可能阻止需要批准的操作。codespace 并不代表允许泄露机密或更改无关资源。应审慎解决访问阻塞，不要把跳过的检查视为通过。 + +观察工作过程和命令结果。Autopilot 可能在完成计划前因持续执行限制而暂停，或报告阻塞项。授权继续前先审查该状态，并保持相同范围。 + +## 返回 Interactive 并审查 + +实现停止后，在发送任何后续提示词前，使用 Shift+Tab 返回 **Interactive** 模式。任务结束后 Autopilot 可能仍处于活动状态，不要假定它已自动切回。 + +输入 `/diff` 并检查所有更改的文件。对照议题和批准的澄清内容检查实现： + +- 用户能否按约定选择多个类别、按发行商筛选，并组合两者？ +- 数据访问辅助函数是否确实支持筛选，而不只是更改 UI？ +- 控件是否具有有意义的标签、键盘支持、可见焦点和稳定的测试标识符？ +- 测试是否断言了行为，包括约定的清除筛选和空结果情况，且未弱化现有断言？ +- 代码是否遵循文档约定，并保留静态应用架构？ + +审查全部四项 npm 检查的证据。尚未创建 `quality-checks`，因此直接运行这些检查。Playwright 的 E2E 配置会构建并提供预览服务；运行套件前，仅停止自己启动的开发服务器，避免复用过时内容。端口冲突或缺少浏览器是需要解决的阻塞项，不是终止其他进程或声称通过的理由。 + +必要时请求针对性修正，重新运行受影响的检查，并确保最终实现经过完整验证。练习 6 会进行直接浏览器观察，其目的与此处的自动化验证不同。 + +## 保存实现检查点 + +对差异和结果满意后，授权创建本地检查点： + +```plaintext +审查当前差异和验证结果。创建仅包含已审查的筛选实现及其测试的检查点提交。保持当前筛选分支和检出目录。暂时不要推送、打开 PR 或创建技能、QA 智能体。 +``` + +## 总结与后续步骤 + +你已明确筛选需求、审查实现和测试，并保存检查点。记录被测修订版本，保留议题 URL 和批准的澄清内容。保持 **Interactive**，在同一检出目录中继续学习[练习 5 - 创建并使用 quality-checks 技能][next-lesson]。 + +## 资源 + +- [Autopilot 模式和权限][autopilot]说明自主持续执行及如何切回 Interactive。 +- [Copilot CLI 命令参考][cli-reference]列出当前模式控件和命令。 + +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ +[autopilot]: https://docs.github.com/copilot/concepts/agents/copilot-cli/autopilot +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/zh-cn/cli/4-mcp.md b/docs/zh-cn/cli/4-mcp.md deleted file mode 100644 index d266de46..00000000 --- a/docs/zh-cn/cli/4-mcp.md +++ /dev/null @@ -1,160 +0,0 @@ ---- -title: "练习 4 - 使用 Playwright MCP 服务器测试功能" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -刚刚已经使用 Copilot CLI 生成了过滤功能。在打开 pull request 之前，应该先确认它在浏览器中能够正常工作。与其手动点选应用，不如连接 **Playwright MCP 服务器**，让 Copilot 驱动真实浏览器代为测试。 - -在本练习中，将： - -- 了解什么是 Model Context Protocol (MCP)，以及 MCP 服务器如何扩展 Copilot CLI。 -- 将 Playwright MCP 服务器添加到 Copilot CLI。 -- 要求 Copilot 使用它在浏览器中手动测试过滤功能。 - -## 什么是 Model Context Protocol (MCP)？ - -[Model Context Protocol (MCP)](https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/) 为 AI 智能体提供了一种与外部工具和服务通信的方式。借助 MCP，AI 智能体可以实时连接外部工具和服务，从而获取最新信息（通过资源），并代表执行操作（通过工具）。 - -这些工具和资源通过 MCP 服务器访问，它充当 AI 智能体与外部工具和服务之间的桥梁。MCP 服务器负责管理 AI 智能体与外部工具之间的通信（例如现有 API 或 NPM package 这类本地工具）。每个 MCP 服务器都代表一组不同的工具和资源，供 AI 智能体访问。 - -几个常见的 MCP 服务器包括： - -- **[GitHub MCP Server](https://github.com/github/github-mcp-server)**：该服务器提供一组 API，用于管理 GitHub 存储库。它允许 AI 智能体执行创建新存储库、更新现有存储库、管理 issue 和 pull request 等操作。 -- **[Playwright MCP Server](https://github.com/microsoft/playwright-mcp)**：该服务器提供基于 Playwright 的浏览器自动化能力。它允许 AI 智能体执行导航到网页、填写表单和选择按钮等操作。 - -还有许多其他 MCP 服务器可提供对不同工具和资源的访问。GitHub 托管了一个 [MCP registry](https://github.com/mcp)，以提升生态系统中的可发现性和协作贡献。 - -> [!CAUTION] -> 从安全角度看，应像对待项目中的其他依赖项一样对待 MCP 服务器。使用前，请仔细审查其源代码、验证发布者，并评估安全影响。只使用可信的 MCP 服务器，并谨慎授予对敏感资源或操作的访问权限。 - -> [!NOTE] -> [GitHub MCP 服务器][github-mcp-server] 是 Copilot CLI 的**内置**能力——无需任何设置即可使用，这也是为什么在整个工作坊中 Copilot 能持续读取和写入存储库。本练习将添加*第二个*服务器，即 Playwright，为 Copilot 提供浏览器能力。 - -## 添加 Playwright MCP 服务器 - -添加服务器最快的方法是使用交互式 `/mcp add` 命令。这里将注册 [Playwright MCP 服务器][playwright-mcp-server]，让 Copilot 获得一个可控浏览器。 - -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 - -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. 在 Copilot CLI 会话中输入： - - ```text - /mcp add - ``` - -2. 此时会出现一个配置表单。使用 Tab 在字段之间切换，并按如下内容填写： - - - **Server Name**：`playwright` - - **Server Type**：选择 **Local**（也标记为 **STDIO**） - - **Command**：`npx @playwright/mcp@latest --headless` - - **Tools**：保持为 `*`，允许使用该服务器的全部工具 - -3. 按 Ctrl+S 保存。服务器会立即添加并可用——无需重启。 - -`--headless` 标志表示让 Playwright 在无可见窗口的模式下运行，这对于没有桌面界面的 codespace 是必需的。在后台，这会把服务器写入 `~/.copilot/mcp-config.json` 文件： - -```json -{ - "mcpServers": { - "playwright": { - "type": "local", - "command": "npx", - "args": ["@playwright/mcp@latest", "--headless"], - "tools": ["*"] - } - } -} -``` - -4. 通过列出 MCP 服务器，确认该服务器已注册并处于活动状态： - - ```text - /mcp show - ``` - -5. 应该会看到 `playwright` 与内置的 `github` 服务器一起列出。 - -> [!NOTE] -> Tailspin Toys 项目本身已经使用 Playwright 进行端到端测试，因此 Playwright 所需的浏览器通常已经安装好。如果之后 Copilot 提示缺少浏览器，让它运行 `npx playwright install chromium`，然后重试。 - -## 启动网站 - -Playwright MCP 服务器需要一个正在运行的应用作为测试目标。请在**单独**的终端中启动 Astro 开发服务器，这样在使用 Copilot CLI 时它才能持续运行。 - -1. 在 codespace 中选择 Ctrl+\` 打开一个新终端。 -2. 启动网站： - - ```bash - npm run dev - ``` - -3. 保持这个终端持续运行。看到 `Astro server: http://localhost:4321` 横幅后，说明应用已就绪。 - -## 测试过滤功能 - -返回 Copilot CLI 会话，并请 Copilot 测试这个功能。 - -[Playwright MCP 服务器][playwright-mcp-server] 会为 Copilot 提供一个可以驱动的真实浏览器。无需手动点选应用来检查结果，智能体可以打开页面、导航、应用过滤条件，并把结果读回给你——然后总结其观察结果。这是在不离开当前对话的情况下，快速确认功能是否符合预期的最佳方式。 - -在底层，Playwright MCP 服务器依赖页面的[无障碍树][playwright-mcp-server]而不是截图来工作。这意味着智能体会基于结构化、带标签的元素（按钮、链接、列表项）进行推理，方式与辅助技术类似——因此一次快速的功能检查，也兼具轻量级的无障碍合理性检查。 - -在服务器已连接且应用已运行的情况下，请 Copilot 演练刚刚构建的过滤功能： - -```text -Using the Playwright MCP server, open a browser to the running app at http://localhost:4321 and verify the new game filtering feature: - -1. Go to the games page and note how many games are listed. -2. Apply a category filter and confirm the list updates to only show games in that category. -3. Clear it, then apply a publisher filter and confirm the list updates to that publisher. -4. Combine a category and a publisher filter and confirm the results respect both. - -Report what you observe at each step, and call out anything that does not behave as expected. -``` - -Copilot 会通过 Playwright MCP 服务器启动浏览器，依次执行每一步，并反馈它发现的内容。将它的总结与 issue 中的验收标准对照——如果有任何异常，可以继续追问，或在打开 pull request 之前让它回头修复代码。 - -> [!NOTE] -> 本测试要求应用运行在 `http://localhost:4321`。如果已经停止开发服务器，请在发送提示前重新启动。Copilot 第一次使用 Playwright MCP 服务器时，可能需要下载浏览器——如果提示缺少浏览器，让它运行 `npx playwright install chromium` 后再试一次。 - -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp - -## 总结和后续步骤 - -恭喜，已经使用 Playwright MCP 服务器配合 Copilot CLI 手动测试了这个功能。回顾一下，完成了以下事项： - -- 了解了什么是 Model Context Protocol (MCP)，以及 MCP 服务器如何扩展 Copilot CLI。 -- 使用 `/mcp add` 添加了 Playwright MCP 服务器。 -- 要求 Copilot 驱动浏览器，在发布前验证过滤功能。 - -现在既然已经确认功能正常，可以继续下一节练习，在那里将[借助智能体技能打开一个 pull request][next-lesson]。 - -## 资源 - -- [MCP 到底是什么，为什么大家都在讨论它？][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [为 Copilot CLI 添加 MCP 服务器][cli-add-mcp] -- [GitHub MCP Server][github-mcp-server] - -[previous-lesson]: ../3-generating-code/ -[next-lesson]: ../5-agent-skills/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[github-mcp-server]: https://github.com/github/github-mcp-server -[cli-add-mcp]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers diff --git a/docs/zh-cn/cli/5-agent-skills.md b/docs/zh-cn/cli/5-agent-skills.md index fce2b75f..3cc9b5ef 100644 --- a/docs/zh-cn/cli/5-agent-skills.md +++ b/docs/zh-cn/cli/5-agent-skills.md @@ -1,121 +1,99 @@ --- -title: "练习 5 - 使用智能体技能" +title: "练习 5 - 创建并使用 quality-checks 技能" +description: "让 Copilot 创建带有配套 shell 脚本的可复用质量检查技能，检查技能内容，并在筛选功能分支上执行。" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- -应用开发经常包含一些可重复的任务，例如生成构建、运行测试或创建 pull request。**智能体技能 (Agent skills)** 让你可以为 Copilot——以及其他 AI 智能体——提供执行这些任务的指导。一个技能是一个文件夹，其中包含说明、脚本和资源，智能体可以按需加载。[Agent Skills 是一项开放标准][agent-skills-repo]，被多种智能体采用，因此同一个技能可以同时在 agent mode 的 Copilot Chat、Copilot cloud agent、Copilot CLI 和 GitHub Copilot app 中使用。 +筛选功能已经实现，并已使用现有 npm 命令完成检查。现在，将这些检查封装为可复用的**智能体技能**。练习 4–8 始终使用同一个筛选功能会话和分支；本练习不创建 pull request。 -技能存放在项目的 `.github/skills` 文件夹中，也可以全局存放在 `~/.copilot/skills`。每个技能都是一个文件夹，其中包含一个 `SKILL.md` 文件。该文件具有 YAML frontmatter（至少包含 `name` 和 `description`），后面跟着 markdown 说明： +在本练习中，将： -```yaml ---- -name: make-contribution -description: All changes to code must follow the guidance documented in the repository. Before any issue is filed, branch is made, commits generated, or pull request (or PR) created, a search must be done to ensure the right steps are followed. Whenever asked to create an issue, commit messages, to push code, or create a PR, use this skill so everything is done correctly. ---- -``` +- 在创建自定义配置前返回 **Interactive** 模式。 +- 让 Copilot 创建 `quality-checks`，然后停下来供你检查。 +- 通过配套脚本执行全部四项检查，并证明单文件测试参数只会选中指定文件。 +- 在筛选功能分支上为技能创建检查点。 -技能还可以包含脚本、资源和参考资料等子文件夹。完整结构请参见[智能体技能规范][agent-skills-spec]。 +## 场景 -> [!TIP] -> 技能是动态加载的。智能体会根据 `description` 字段判断应使用哪个技能——清晰、针对场景的描述，是一个技能会被使用还是被忽略的关键区别。 +每次修改筛选功能，Tailspin Toys 都需要运行相同的质量检查。团队希望使用可复用的技能，而不是在每次对话中解释命令和前提条件。你将创建技能、检查脚本，并验证后续请求能否正确运行这些检查。 -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification +## 指令、脚本和资源 -接下来看看，一个技能如何确保 pull request 符合团队制定的规范。 +技能将可复用的任务指令、可执行脚本和辅助资源打包，供智能体按需加载。自定义智能体定义专业角色、指令和可用工具。两者相辅相成：自定义智能体可以执行脚本，包括技能附带的脚本。 -## 场景 +存储库技能位于 `.github/skills//SKILL.md`，包含带有 `name` 和 `description` 的 frontmatter 以及 Markdown 指令。脚本和其他资源存放在旁边。这里将让 Copilot 生成 `.github/skills/quality-checks/SKILL.md` 及其配套脚本，而不是复制现成答案。[Agent Skills 规范][skill-spec]介绍了这种格式。 -团队对 pull request（PR）有一组要求： +Copilot 根据已发现技能的描述，决定何时加载它。不要假定新技能会立即被已打开的会话发现；运行部分提供了明确读取技能的备用方式。格式可移植并不意味着无需满足 shell 或项目的前提条件。 -- 提交消息要清晰，文件分组要合理。 -- 创建 PR 之前，所有测试都必须通过。 -- 每个 PR 都必须包含以下部分： - - 说明为什么要进行这些更改。 - - 概述已更改的文件。 - - 重要代码块的片段。 - - 按组整理的更改详情。 +## 创建技能 -由于团队正在使用 Copilot 生成代码和 PR，因此希望确保 AI 工具也能遵循这些要求。 +发送提示前返回 **Interactive** 模式。保持当前检出目录和分支。如果使用的旧版模板已经包含此技能，应先检查并扩展它，而不是覆盖已有的自定义内容。 -在本练习中，将： - -- 探索一个现有的用于创建 pull request 的技能。 -- 了解 AI 智能体如何使用技能。 -- 在技能的帮助下，创建一个符合准则的 PR。 +```plaintext +创建 .github/skills/quality-checks/SKILL.md 和四个封装脚本，分别调用 npm run lint、npm run test:unit、npm run test:e2e 和 npm run typecheck:all。先阅读 package.json、README、测试配置和存储库指令。 -## 执行技能 +识别当前环境。macOS/Linux/WSL 只创建 Bash .sh 脚本，原生 Windows 只创建 PowerShell .ps1 脚本；如果无法确定，先询问。不要同时创建两种实现。封装脚本仅负责根据自身位置解析存储库根目录，验证该目录包含本项目的 package.json，然后调用 npm。根目录无效时，应明确报错并失败退出。支持任意工作目录和包含空格的路径。保留输出和失败退出代码，包括 PowerShell 原生命令的失败。npm 的 -- 分隔符只插入一次；调用方直接提供工具参数，不再添加 --。不要管理端口或进程。 -当智能体判断某个技能有必要时，会动态加载它。决定使用哪些技能的依据，就是 `SKILL.md` 文件中的描述。因此，使用场景清晰的描述非常重要。 +在 SKILL.md 中提供 name 和 description frontmatter、运行全部四个封装脚本的指令、前提条件、故障排查方法，以及包含一个现有单元测试文件的可移植调用示例。所有 Bash 示例都必须显式调用 bash；绝不绕过 PowerShell 执行策略。解释 Playwright 的服务器复用：只停止确实由自己启动的服务器，否则先询问。 -## 探索 PR 技能 +只创建技能和必需的脚本。不要运行检查或探测，不要安装任何内容、修改应用代码、提交或创建 PR。然后停止，等待检查。 +``` -由于 Tailspin Toys 对创建 PR 有一套要求，因此他们创建了一个技能，帮助 AI 工具生成符合这些准则的 PR。现在来看看这个技能，了解它会执行什么。 +## 检查技能 -1. 打开 `.github/skills/make-contribution/SKILL.md`。 -2. 注意其中的名称和描述。可以看到，描述中强调了它适用的场景，也就是当请求创建 pull request 或提交代码时。 -3. 通读这个技能。注意其中定义了分支应如何创建、提交应如何生成，以及 pull request 的内容应包含什么。 +1. 在编辑器中打开 `.github/skills/quality-checks/SKILL.md` 及其配套脚本，并检查差异。 +2. 检查 `name` 和 `description` 是否说明了技能及其适用场景。阅读指令，不要只看元数据。 +3. 确认执行顺序确实调用 `.github/skills/quality-checks/` 下的配套脚本，执行 lint、单元测试、E2E 和类型检查。 +4. 检查每个封装脚本是否根据自身位置解析根目录，并明确检查推导出的目录是否包含此检出目录中预期的 `package.json`。命令因 npm 搜索祖先目录而成功，并不能证明根目录正确。检查路径是否加引号、参数是否转发、输出是否可见，以及失败时是否正确退出；PowerShell 必须传递原生 npm 命令的失败状态。 +5. 检查文档中只运行一个单元测试文件的示例。封装脚本负责插入 npm 的 `--` 分隔符，因此调用方应直接传递目标工具的参数，不再添加分隔符。可复用指令中不应包含特定机器的检出目录绝对路径。在运行任何内容之前，让 Copilot 修正遗漏或问题。 +6. 脚本应仅负责根目录和清单文件验证，以及运行现有 npm 检查。端口和进程相关决策应放在 SKILL.md 中，而不是通过 shell 进程管理代码实现。确认只有智能体实际启动的服务器才可以停止；工作目录或进程名称匹配不能证明归属。交付的文件应仅包含技能、必需的封装脚本和必要的共享辅助文件，不含临时探测或调试文件。 -## 使用技能 +> [!NOTE] +> 当前 Tailspin Toys 需要 Node.js 22.13 或更高版本、项目依赖项，以及用于 E2E 检查的 Playwright Chromium。在检出目录的 README 和 `package.json` 中确认前提条件。缺少前提条件或 PowerShell 执行策略阻止运行时，需要经批准的解决方案，而不是自动安装、绕过策略或悄悄改为直接运行 npm。 -如前所述，技能会由 Copilot CLI 自动调用。因此，只需请求 Copilot 创建一个 PR。 +## 运行技能 -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 +确认上一练习的开发服务器已停止。Playwright 会为 E2E 构建并提供预览服务，但其本地配置可以复用端口 `4321` 上的服务器。其他检出目录的服务器不能为当前功能提供有效证据。 -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 +如果 Copilot CLI 提供 `/quality-checks`，选择它来显式调用已发现的技能，并附上以下请求。如果未发现技能，直接在此会话中发送相同请求；本练习支持通过读取技能的方式运行它。 -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools +```plaintext +读取 .github/skills/quality-checks/SKILL.md，并按照其中的指令验证此检出目录中的筛选功能。先检查每个封装脚本的代码，确认其推导出的目录包含此检出目录中预期的 package.json，且根目录无效时会明确报错并失败退出，而不是依赖 npm 在祖先目录中查找包。不要为模拟失败而移动、重命名、删除或修改存储库文件。实际运行其配套脚本，执行 lint、单元测试、端到端测试和类型检查。同时运行文档中只运行一个单元测试文件的示例，直接传递目标工具的参数，因为 npm 的 -- 分隔符由封装脚本负责。根据测试运行器的结果，确认仅运行了指定文件，并报告该文件名及实际执行的测试文件数量。仅回显参数或返回退出代码 0，不能证明文件选择正确。 -1. 使用以下提示，请 Copilot 创建一个 PR： +报告每次脚本调用及其结果，包括失败、跳过的检查或缺失的前提条件。不要在技能脚本无法使用时悄悄改为直接运行 npm 命令。确认待测试的检出目录和服务器，只停止你启动的服务器，并在安装任何内容或停止其他进程前询问。不要修改应用代码、切换分支、提交、推送或创建 pull request。 +``` - ``` - Can you please create a pull request for me! - ``` +检查工具调用和输出。四个脚本都必须实际执行；描述检查内容或跳过检查都不算通过。对于单文件示例，将请求的文件名与运行器实际输出的文件结果及报告的数量进行比较：应只运行该文件。如果还运行了其他文件，回显参数或退出代码 0 都不足以证明正确。失败是有用的证据：修正技能，或在获批后解决环境配置阻碍，再重新运行受影响的检查。不要停止无关进程，也不要强行消除端口冲突。 -2. Copilot 会确认这个请求。稍等片刻后，会看到 Copilot 显示它正在使用 **make-contribution** 技能。 +## 保存检查点 -3. 然后 Copilot 会遵循该技能中的说明。它会先运行测试，然后创建分支、提交，最后创建 PR。 -4. 创建 PR 后，返回存储库并打开该 PR。注意其中各个部分遵循了技能中设定的准则，与团队提出的要求一致。 -5. 在进入下一节练习前，将本地工作区重置到从 `main` 创建的新分支，以便后续无障碍工作与这个过滤功能 PR 保持分离： +检查技能及其运行结果后，授权创建本地检查点： - ```bash - git checkout main - git pull - git checkout -b accessibility-cli - ``` +```plaintext +检查当前差异，仅为 quality-checks 技能文件创建检查点提交。保留现有筛选功能分支。不要推送或创建 pull request。 +``` -## 总结和后续步骤 +## 总结与后续步骤 -在智能体技能的帮助下，已经创建了一个符合文档要求的新 PR。完成了以下事项： +你已创建、检查并运行可复用的 quality-checks 技能，包括其单文件测试示例。技能文件将与筛选功能、QA 配置和相关测试一起纳入练习 8 的功能 PR。继续在同一检出目录中完成[练习 6 - 使用 Playwright MCP 验证功能][next-lesson]。 -- 探索了一个现有的 pull request 创建技能。 -- 了解了 AI 智能体如何使用技能。 -- 在技能的帮助下，创建了一个符合准则的 PR。 +## 更多技能示例 -技能非常适合处理任务，但如果需要更强大的操作能力，就应该利用[自定义智能体][next-lesson]，下一节就会探索这一点。 +以下社区示例仅供参考，不是额外任务。采用前先检查其前提条件和行为： -## 资源 +- [贡献工作流：`make-repo-contribution`][contribution-example]。 +- [需求文档：`prd`][prd-example]。 +- [图表及配套导出脚本：`drawio`][drawio-example]。 +- [浏览器测试：`webapp-testing`][browser-example]。 -- [关于 Agent Skills][about-agent-skills] -- [Agent Skills 规范][agent-skills-spec] -- [Agent Skills 存储库][agent-skills-repo] -- [awesome-copilot 上的 Agent Skills][awesome-copilot-skills] +上游贡献示例名为 `make-repo-contribution`；旧版 Tailspin 模板使用另一个名称 `make-contribution`。本工作坊不依赖其中任何一个贡献技能。 -[previous-lesson]: ../4-mcp/ -[next-lesson]: ../6-custom-agents/ -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[awesome-copilot-skills]: https://github.com/github/awesome-copilot/tree/main/skills +[previous-lesson]: ../4-build-filtering/ +[next-lesson]: ../6-mcp-playwright/ +[skill-spec]: https://agentskills.io/specification +[contribution-example]: https://github.com/github/awesome-copilot/tree/main/skills/make-repo-contribution +[prd-example]: https://github.com/github/awesome-copilot/tree/main/skills/prd +[drawio-example]: https://github.com/github/awesome-copilot/tree/main/skills/drawio +[browser-example]: https://github.com/github/awesome-copilot/tree/main/skills/webapp-testing diff --git a/docs/zh-cn/cli/6-custom-agents.md b/docs/zh-cn/cli/6-custom-agents.md deleted file mode 100644 index 366d1f01..00000000 --- a/docs/zh-cn/cli/6-custom-agents.md +++ /dev/null @@ -1,115 +0,0 @@ ---- -title: "练习 6 - 在 GitHub Copilot CLI 中使用自定义智能体" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -## 什么是自定义智能体？ - -GitHub Copilot 中的[自定义智能体][custom-agents-concept]允许创建适用于开发工作流中特定任务或领域的专用 AI 助手。通过在存储库的 `.github/agents` 文件夹中使用 markdown 文件定义智能体，可以为 Copilot 提供聚焦的说明、最佳实践、编码模式和领域知识，从而引导它更高效地完成特定类型的工作。团队可以把自身经验固化为可复用智能体——例如强制遵循 [WCAG][wcag] 的无障碍智能体、遵循安全编码实践的安全智能体，或保持一致测试模式的测试智能体。 - -自定义智能体通过项目 `.github/agents` 文件夹中的 markdown 文件定义，也可以全局定义在 `~/.copilot/agents` 中。每个文件都有 YAML frontmatter，至少包含 `name` 和 `description`，后面跟着一个 markdown prompt，用于定义智能体的行为、专长和说明。 - -### 自定义智能体与智能体技能的对比 - -自定义智能体与[智能体技能][agent-skills-concept]在逻辑上有一些重叠。两者主要都通过 markdown 文件定义，也都在告诉 AI 如何执行操作。最清晰的区分方式是：**自定义智能体**是执行工作的角色，而 **skills** 是工具。 - -自定义智能体拥有自己的上下文窗口，并且设计上就用于在工作过程中编排技能（甚至其他智能体）。在这个实验中，无障碍自定义智能体会根据无障碍准则审查并更新网站；在执行这项工作时，它可以调用诸如 pull request 工作流技能，或用于运行和管理测试的技能。 - -> [!NOTE] -> 编写自定义智能体并不存在唯一“正确”的方式。和 AI 中的大多数事情一样，需要测试并迭代，找到最适合环境和场景的做法。 - -[custom-agents-concept]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[agent-skills-concept]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[wcag]: https://www.w3.org/WAI/standards-guidelines/wcag/ - -## 场景 - -许多 Web 应用在无障碍方面都做得不够，而正在使用的网站也不例外。接下来将使用一个自定义智能体来识别并解决无障碍缺陷。 - -Tailspin Toys 致力于确保其众筹平台对所有用户都可访问，无论其视觉能力或偏好如何。最近的用户反馈指出，由于文本与背景颜色之间的对比度不足，一些用户认为当前的深色主题难以阅读。为了解决这一无障碍问题，设计团队要求实现一种可开关的高对比度模式。 - -由于无障碍非常关键，希望尽快实现这项功能。因此将使用一个自定义智能体来生成功能。 -在本练习中，将： - -- 探索自定义智能体。 -- 启用一个自定义智能体，并通过 Copilot CLI 为其分配任务。 - -## 查看无障碍自定义智能体 - -项目中已经预先创建了一个用于无障碍的自定义智能体。先查看其内容，了解它将如何引导 Copilot。 - -1. 打开 `.github/agents/accessibility.md`。 -2. 注意其中带有 `name` 和 `description` 字段的 YAML frontmatter。 - -> [!CAUTION] -> 自定义智能体必须包含带 `name` 和 `description` 的 frontmatter。 - -3. 接着浏览后续部分，查看其中强调的内容： - - 为无障碍网站生成代码时的核心职责。 - - 无障碍最佳实践。 - - HTML、CSS 和 JavaScript 的代码示例。 - - 常见陷阱和错误列表。 - -## 在 Copilot CLI 中使用自定义智能体 - -可以通过 `/agent` 命令在 Copilot CLI 中启动自定义智能体。现在对网站执行一次无障碍检查。 - -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 - -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. 在 Copilot CLI 的提示窗口中输入 `/agent` 并选择 Enter，调出智能体列表。 -2. 从可用智能体列表中选择 **Accessibility agent**。 -3. 使用以下提示，请无障碍智能体执行审查，并为无障碍积压工作项生成修复： - - ``` - Perform an accessibility review of the site. Pull the related issue down from the repository for details. Implement a high-contrast mode toggle that persists the user's preference across page reloads. Ensure there are e2e tests for any updates made to the project. Then create a PR with the updates. - ``` - -4. Copilot 会开始处理这项任务。它会先检索 issue，然后执行审查、生成更新，最后创建 PR。创建 PR 时，还会注意到它使用了项目中专门处理 PR 的技能。 - -> [!NOTE] -> 这个过程可能需要几分钟。正好可以回顾一下到目前为止学到的所有内容、休息片刻，或者提前看一下下一模块——其中会介绍 Copilot CLI 中更多可用命令。 - -## 总结和后续步骤 - -本课探索了 GitHub Copilot 中的[自定义智能体][custom-agents]：它们是面向特定任务和领域定制的专用 AI 助手。通过自定义智能体，可以把团队的经验和标准固化为可复用智能体，引导 Copilot 更高效地完成特定类型的工作。 - -本课探索了以下概念： - -- 自定义智能体是如何定义的。 -- 如何在 Copilot CLI 中使用自定义智能体。 - -接下来将探索[一些斜杠命令][next-lesson]，学习更多 Copilot CLI 的使用技巧。 - -## 资源 - -- [自定义智能体][custom-agents] -- [为存储库创建自定义智能体][creating-custom-agents] -- [awesome-copilot 上的自定义智能体][awesome-copilot-agents] -- [在组织中启用自定义智能体的准备工作][org-custom-agents] -- [在企业中启用自定义智能体的准备工作][enterprise-custom-agents] - -[previous-lesson]: ../5-agent-skills/ -[next-lesson]: ../7-slash-commands/ -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[creating-custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/cloud-agent/create-custom-agents -[awesome-copilot-agents]: https://github.com/github/awesome-copilot/tree/main/agents -[org-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-organization/prepare-for-custom-agents -[enterprise-custom-agents]: https://docs.github.com/copilot/how-tos/administer-copilot/manage-for-enterprise/manage-agents/prepare-for-custom-agents diff --git a/docs/zh-cn/cli/6-mcp-playwright.md b/docs/zh-cn/cli/6-mcp-playwright.md new file mode 100644 index 00000000..ced6954a --- /dev/null +++ b/docs/zh-cn/cli/6-mcp-playwright.md @@ -0,0 +1,95 @@ +--- +title: "练习 6 - 使用 Playwright MCP 验证功能" +description: "通过 MCP 连接浏览器，将观察到的筛选行为与议题和批准的计划进行比较。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +筛选实现和 quality-checks 技能已经过自动化验证。现在为 Copilot 提供浏览器，让它直接观察功能。本练习展示**模型上下文协议（MCP）**交互，而不是再次运行完整测试套件。 + +在同一筛选检出目录和分支上保持 **Interactive** 模式。配置 MCP 不会开始新的功能里程碑。 + +在本练习中，你将： + +- 连接 Playwright MCP，确认其浏览器工具可用。 +- 将实际筛选行为与议题及已批准的标准进行比较。 +- 审查观察结果，并停止自己启动的开发服务器。 + +## 场景 + +自动化检查已通过，但 Tailspin Toys 还需要有关访客体验的证据。你将为 Copilot 提供浏览器工具，让它操作筛选器，并将显示的游戏与约定行为进行比较，而不是把控件能够响应当作筛选功能正确运行的证明。 + +## MCP 带来的能力 + +[MCP][mcp-overview] 通过服务器将智能体连接到外部工具和上下文。内置 GitHub MCP 服务器让 Copilot 能处理议题和 PR。[Playwright MCP 服务器][playwright-mcp]则提供打开页面、检查无障碍元素、导航及操作控件的浏览器工具。 + +浏览器的无障碍快照有助于智能体识别控件，但不能证明完全符合无障碍要求。应将实际操作和观察结果与议题要求进行比较，而不是接受笼统的“看起来不错”。 + +> [!CAUTION] +> 将 MCP 服务器视为项目依赖项：启用前审查发布者、源代码、权限和所有包下载。组织策略可能限制可运行的服务器。不要将凭据放入已提交的配置，也不要只为完成练习而批准未知工具。 + +## 配置 Playwright MCP + +1. 在现有 CLI 会话中输入 `/mcp`，检查已配置的服务器。复用可用的 Playwright 配置，不要重复添加。 +2. 如有需要，输入 `/mcp add`，使用 Tab 在表单中移动。 +3. 将 **Server Name** 设为 `playwright`，**Server Type** 设为 **STDIO**（或 **Local**），**Command** 设为 `npx @playwright/mcp@latest --headless`。 +4. 为此已审查的浏览器服务器，将 **Tools** 设为 `*`。这会使其工具可用，但不会替代 CLI 的权限控制。 +5. 审查包及启动命令后，按 Ctrl+S 保存。注册会启动服务器，并可能下载包；应明确批准该设置，并回应包提示。 +6. 输入 `/mcp show playwright`，确认服务器已连接且浏览器工具可用。 + +无头浏览器无需桌面窗口，适合 Codespaces。交互式添加流程将配置保存到 `~/.copilot/mcp-config.json`，无需重启 CLI 即可使用服务器。这是用户配置，不是应包含在功能 PR 中的文件。[MCP 设置指南][mcp-setup]说明了相关字段和配置来源。 + +> [!NOTE] +> 项目 E2E 依赖项与 MCP 浏览器有关，但可能需要不同设置。如果缺少浏览器或系统依赖项，应检查实际错误，并获批后解决具体的先决条件。不要自动安装浏览器，也不要假定服务器已连接就证明它能启动浏览器。 + +## 启动正确的应用 + +在同一筛选检出目录中打开单独的终端。确认目录和分支，再启动应用： + +```bash +pwd +git branch --show-current +npm run dev +``` + +从服务器输出中读取实际本地 URL。在 codespace 中，MCP 服务器和应用处于同一环境，因此使用该本地 URL，通常是 `http://localhost:4321`，不要假定必须使用转发后的浏览器 URL。 + +如果端口已占用或 Astro 选择了其他端口，继续前先确定服务器归属。不要复用或终止未知服务器。使用刚启动进程的 URL，并在测试期间保持该终端打开。 + +## 观察筛选行为 + +将占位符替换为真实议题 URL、练习 4 中批准的澄清内容和应用 URL： + +```plaintext +使用已配置的 Playwright MCP 服务器，根据此议题验证筛选功能：。以下是规划时批准的澄清内容：<粘贴约定的澄清内容，或填写 none>。当前检出目录的应用运行于 。在依赖结果前，确认被测检出目录、分支和服务器。 + +打开游戏页面，记录未筛选状态，先选择一个类别，再选择多个类别，应用发行商筛选，并组合类别和发行商选择。根据批准的标准测试清除筛选和空结果行为。检查控件标签、键盘操作和可见焦点。将显示结果与所选筛选条件及源数据比较，不要仅因为控件发生变化就推断成功。 + +使用实际浏览器工具操作，逐项报告观察到的结果，并明确标出失败或缺失证据。不要仅为此浏览器练习再次运行完整测试套件，不要更改应用代码、创建测试或自定义配置、更改分支、提交、推送或打开 PR。在安装任何内容或停止其他进程前先询问。 +``` + +检查浏览器工具调用和报告。Copilot 是否确实选择了多个类别并与发行商组合？返回的游戏是否符合约定行为？报告是否区分了可观察的浏览器行为、数据层覆盖和自动化测试覆盖？ + +如果失败，记录观察到的行为。单独授权针对性的应用修复，再重复受影响的浏览器检查和自动化检查。不要为了迁就实现而修改验收标准，也不要将旧证据算作更改后代码的验证。 + +## 停止自己启动的服务器并继续 + +在启动开发服务器的终端中按 Ctrl+C 停止它。保持 Playwright MCP 配置可用。练习 7 将协调新的浏览器观察和自动化 E2E 检查，这些检查不得复用过时的开发服务器或其他检出目录的应用。 + +## 总结与后续步骤 + +创建 QA 配置文件前保持 **Interactive**。你已观察浏览器行为，没有额外创建 PR 或分支；接下来[创建并使用 QA 智能体][next-lesson]，将需求、覆盖情况、技能和最终证据结合起来。 + +## 资源 + +- [向 Copilot CLI 添加 MCP 服务器][mcp-setup]说明设置和管理方式。 +- [Microsoft Playwright MCP][playwright-mcp] 说明浏览器配置和工具。 +- [GitHub MCP 注册表][mcp-registry]列出其他可供评估的服务器。 + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-overview]: https://docs.github.com/copilot/concepts/context/mcp +[mcp-setup]: https://docs.github.com/copilot/how-tos/copilot-cli/customize-copilot/add-mcp-servers +[playwright-mcp]: https://github.com/microsoft/playwright-mcp +[mcp-registry]: https://github.com/mcp diff --git a/docs/zh-cn/cli/7-qa-agent.md b/docs/zh-cn/cli/7-qa-agent.md new file mode 100644 index 00000000..85cac402 --- /dev/null +++ b/docs/zh-cn/cli/7-qa-agent.md @@ -0,0 +1,89 @@ +--- +title: "练习 7 - 创建并使用 QA 智能体" +description: "创建以需求为先的 QA 配置，将测试覆盖、quality-checks 技能和直接浏览器验证证据结合起来。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +你已运行可重复的检查，并通过 Playwright MCP 探索了筛选功能。现在创建一个 **QA 自定义智能体**，将需求、覆盖情况和浏览器验证证据结合起来。保留筛选功能会话、检出目录和分支；到练习 8 再创建功能 PR。 + +在本练习中，你将： + +- 创建并检查以需求为先的 QA 配置。 +- 选择配置，审查覆盖情况、检查结果和浏览器证据。 +- 返回普通智能体，为配置和有充分理由添加的测试保存检查点。 + +## 场景 + +Tailspin Toys 正准备发布筛选功能。仅凭测试通过，无法判断是否覆盖了所有约定的需求。团队需要重点比较议题与实现，识别缺口，并说明功能是否已准备好接受审查。QA 配置将指导这项评估，但不会取代人的判断。 + +## 创建 QA 配置 + +保持 **Interactive** 模式。配置定义专业角色及其指令；技能封装可复用的任务指令、脚本和资源。QA 智能体将使用你的技能和已配置的 MCP 工具，而不是取代它们。 + +发送以下提示，然后在运行前检查定义： + +```plaintext +在 .github/agents/qa.agent.md 中创建可复用的 QA 自定义智能体。先检查存储库指令、package.json、测试配置和 .github/skills/quality-checks/SKILL.md。为配置提供有效的 YAML frontmatter，其中 name 为 QA，description 说明适用场景。不要固定模型或添加 tools 列表；继承当前使用环境的可用工具和权限。只创建智能体定义，然后停止，让我在运行前检查。 + +在智能体指令中，要求每项 QA 任务都从用户提供的 issue 和已批准的验收标准出发。以这些需求而非实现为准。需求缺失或不明确时要询问。检查功能及现有测试，将每项标准映射到适当的自动化覆盖和可观察的行为。 + +要求通过已配置的 Playwright MCP 服务器直接进行浏览器验证，并通过现有 quality-checks 技能及其配套脚本执行 lint、单元测试、端到端测试和类型检查。如果技能尚未被自动发现，则明确读取技能。缺少技能、MCP 工具、前提条件或访问权限时，报告为受阻；不要悄悄改用其他工作流，也不要把跳过的检查标记为通过。确认待测试的检出目录和服务器，避免复用其他工作树的服务器，只停止智能体自己启动的服务器，并在任何安装或停止其他进程前询问。 + +允许 QA 智能体遵循存储库指令，为确实存在的覆盖缺口添加最少的必要测试；覆盖已经充分时，不添加测试也是有效结果。不要弱化断言、禁用失败测试、为迎合代码而修改验收标准，或未经我批准修改应用代码。更改后，重新运行受影响的检查，并对更改后的版本完成最终验证。要求提供简明报告，将标准映射到证据和通过/失败/受阻状态，列出新增测试或解释为何不需要，报告全部四项检查结果，并指出尚未解决的缺陷。只有具备所有必需的检查和证据，才能给出 GO；否则报告 NO-GO 并说明原因。QA 期间不要切换分支、提交、推送、创建或合并 PR，也不要创建其他智能体或技能。 +``` + +## 检查配置 + +在编辑器中打开 `.github/agents/qa.agent.md` 并检查差异。`description` 是必需字段；本练习还将易读的 `name` 设置为 `QA`。确认没有固定 `model`，也没有虚构工具列表。省略 `tools` 会继承可用工具，但不会绕过使用环境的权限。生产配置可以有意限制工具。 + +确认指令从需求出发，要求实际使用 MCP 浏览器工具和技能脚本，只允许有充分理由的测试补充，并如实报告阻碍。专业角色配置和技能都不要求独立的上下文窗口，也不要求编排其他智能体。 + +## 根据 issue 运行 QA + +运行提示应发送给选中的 **QA** 自定义智能体，而不是让默认智能体读取配置。在同一检出目录中启动新的 CLI 对话以加载新配置，不要创建其他功能分支。 + +1. 保存筛选功能 issue 的 URL 和已批准的澄清内容。等待当前智能体完成，然后输入 `/exit` 返回终端。 +2. 使用 `git branch --show-current` 和 `git status --short` 确认仍在筛选功能存储库目录中，并处于同一分支。不要切换分支或创建工作树。 +3. 使用存储库配置启动 CLI： + + ```shell + copilot --agent qa + ``` + +4. 运行前，确认 CLI 显示选中的智能体是 **QA**。[CLI 命令参考][cli-reference]记录了 `--agent`；仅写入或读取配置不代表激活。如果选择失败，或智能体无法访问已配置的 Playwright MCP 工具和技能，暂停并与讲师一起解决这一阻碍。 + +将两个占位符替换为实际筛选功能 issue 的 URL 和练习 4 中批准的澄清内容；如果 issue 已完整说明需求，则填写 `none`。不要依赖前一个智能体的记忆。 + +```plaintext +根据此 issue 验证筛选功能：。以下是我在规划期间批准的补充验收标准：<粘贴约定的澄清内容，或填写 none>。 + +使用 Playwright MCP 服务器验证行为，检查测试覆盖，仅针对覆盖缺口添加测试，并通过 quality-checks 技能运行验证。报告证据、检查结果和阻碍。未经我批准，不要修改应用代码。不要创建提交或 pull request。 +``` + +## 审查证据 + +对照 issue 检查报告：每项标准都需要适当的自动化覆盖和可观察的行为。检查实际的 Playwright MCP 工具活动、检出目录和服务器身份，以及全部四项技能脚本结果。浏览器检查和自动化 E2E 不得复用过时的服务器或其他检出目录。 + +审查新增测试：它们应填补真正的缺口，而不是弱化断言。覆盖充分时，不新增测试是正确做法。因受阻或失败而给出 **NO-GO** 是有效结果，不代表可以跳过证据。 + +如果 QA 发现应用缺陷，另行批准针对性修复，并在更改后的版本上重新执行受影响的检查和浏览器观察。缺少前提条件或工具时，需要明确的解决方案。不要将旧证据当作更改后代码的证明。 + +## 保存检查点 + +QA 完成后，保存其报告，其中应包含 issue URL、已批准的澄清内容、测试过的版本、浏览器观察和检查结果。输入 `/exit`，然后在同一目录和分支中启动不带 `--agent` 的 `copilot`，返回普通对话。再次提供这些上下文；新对话不会继承 QA 对话的证据。 + +审查配置、测试更改及相应证据后，向普通智能体发送以下请求： + +```plaintext +检查当前差异，为 QA 智能体定义和已批准的测试更改创建检查点提交。保留现有筛选功能分支。不要推送或创建 pull request。 +``` + +## 总结与后续步骤 + +你已创建并选择 QA 配置、审查证据，并保存配置和有充分理由添加的测试。继续跟踪未解决的问题；失败或受阻的结论不代表获准合并。带着筛选功能、技能、QA 配置、测试和当前验证证据，继续完成[练习 8 - 创建并合并功能 PR][next-lesson]。 + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/zh-cn/cli/7-slash-commands.md b/docs/zh-cn/cli/7-slash-commands.md deleted file mode 100644 index 15262f20..00000000 --- a/docs/zh-cn/cli/7-slash-commands.md +++ /dev/null @@ -1,177 +0,0 @@ ---- -title: "练习 7 - GitHub Copilot CLI 中的斜杠命令" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -像其他优秀的 CLI 工具一样，GitHub Copilot CLI 也提供了许多斜杠命令供交互使用。这些命令会暴露高级功能、“幕后”信息或额外的配置选项。前面已经体验过 `/clear`（清理上下文）和 `/mcp`（查看 MCP 服务器）。接下来再探索几个强大的命令，包括 `/context`、`/model`、`/share` 和 `/delegate`。 - -## 场景 - -核心 CLI 流程已经体验完毕。现在再看看一些附加能力——共享会话、切换模型，以及把任务委托给 [Copilot cloud agent][about-cloud-agent]。 - -在本练习中，将使用： - -- `/share` 创建一个 GitHub gist，与团队共享会话。 -- `/context` 查看 Copilot CLI 当前使用的上下文。 -- `/model` 查看可用模型列表，并在需要时选择新的模型。 -- `/delegate` 可选地把任务移交给 cloud agent。这需要 cloud agent，Copilot Student、Pro、Pro+、Business 和 Enterprise 都支持——只有 Copilot Free 不支持。 - -## 共享会话 - -无论使用什么工具，包括 AI 工具，本身都是一种技能。与团队一起工作、彼此分享经验，是帮助所有人提升体验并生成更高质量代码的最佳方式。为此，Copilot CLI 提供了 `/share` 命令。`/share` 可以生成 markdown 文件或 GitHub gist，其中包含会话详情、使用过的提示以及 Copilot 采取的逻辑。 - -现在创建一个可以分享给团队的 GitHub gist。 - -> [!TIP] -> **启动 Copilot CLI 会话** -> -> 开始下面的练习前，先返回 codespace 并打开一个终端（如果还没打开，可按 Ctrl+\`）。然后使用 `--yolo` 和 `--enable-all-github-mcp-tools` 启动 Copilot CLI： -> -> ```bash -> copilot --yolo --enable-all-github-mcp-tools -> ``` -> -> 如果希望接续这个项目最近一次会话，而不是重新开始，请运行 `copilot --yolo --enable-all-github-mcp-tools --continue`。如果 Copilot CLI 仍在运行之前练习中的会话，请发送 `/clear` 开始一段新的对话。 -> -> `--enable-all-github-mcp-tools` 会为当前会话启用 GitHub MCP 读写工具，因此在工作坊流程中 Copilot 可以读取积压工作并打开 pull request。 - -> [!CAUTION] -> `--yolo` 会启用完整的自动权限（`--allow-all-tools`、`--allow-all-paths` 和 `--allow-all-urls`）。只能在 Codespace 或 VM 这类隔离环境中使用，绝不要把它设成日常开发的默认别名。详情见[允许和拒绝工具使用][allow-all-warning]。 - -[allow-all-warning]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/allowing-tools - -1. 在 Copilot CLI 的提示窗口中发送以下命令： - - ``` - /share gist - ``` - -2. 稍等片刻后，Copilot 会创建一个 gist 并显示链接。 -3. 复制该链接文本。 -4. 在新的浏览器标签页中粘贴链接并查看 gist。注意其中如何突出显示已发送的提示、使用过的技能和智能体、Copilot 的思考过程，甚至包括本地运行命令的代码和结果。 - -`/share` 生成的 gist 和 markdown 文件，既可以作为代码生成过程的文档，也可以用于向团队分享某些操作是如何完成的，以及这些操作如何帮助 Copilot 生成期望结果。 - -## 探索 Copilot CLI 的上下文 - -处理较大或较复杂的任务时，可能会触及模型的最大上下文窗口。窗口的具体大小取决于所使用的模型和 Copilot CLI 版本。当上下文窗口达到上限时，Copilot CLI 会自动压缩上下文，总结信息并移除它认为与当前任务无关的内容。可以使用斜杠命令查看当前上下文状态，也可以手动压缩上下文。现在来看看上下文窗口。 - -1. 在 Copilot CLI 的提示窗口中发送以下命令： - - ``` - /context - ``` - -2. 稍等片刻后，Copilot CLI 会生成当前上下文的可视化表示： - - ![Copilot CLI 上下文窗口截图](../../_images/cli-7-context-window.png) - -3. 注意显示的模型（可能与图片中不同）以及当前已使用的 token 百分比。其余信息展示了以下内容： - - | 标题 | 说明 | - | ------------ | ------------------------------------------------------ | - | System/Tools | 说明文件、文件内容和工具定义 | - | Messages | 与 Copilot 的对话历史 | - | Buffer | Copilot CLI 为生成响应预留的空间 | - | Free space | 剩余可用空间 | - -4. 向 Copilot CLI 发送以下斜杠命令，压缩对话历史： - - ``` - /compact - ``` - -5. 完成后，再次发送以下命令，显示当前上下文统计： - - ``` - /context - ``` - -6. 注意上下文的变化。由于当前上下文窗口可能还比较小，变化未必十分明显。 - -> [!NOTE] -> 当上下文变满时，Copilot CLI 会自动压缩。接近 100% 容量时，它会在提示窗口上方显示百分比。通常它会异步压缩，因此在处理过程中仍可继续与 Copilot 交互。不过，它也可能在执行压缩时阻塞当前操作几秒钟。 - -### 上下文最佳实践 - -在大多数会话中，Copilot 本身就能高效管理上下文，通常不需要额外指导。不过，在某些情况下，可能会决定手动指示 Copilot 清空或压缩其历史记录： - -- 如果要切换到应用的其他部分，或转到无关任务，可以使用 `/clear` 重新开始，避免旧的无关上下文让 Copilot 混淆。 -- 如果即将接近最大上下文窗口，可以手动使用 `/compact`，自行控制压缩发生的时机。 - -> [!CAUTION] -> 再次强调，大多数时候 Copilot 都能在无需直接干预的情况下管理上下文。如果发现 Copilot 因较早的信息而有些混乱，或者即将切换到无关任务，再考虑使用这些手动命令即可。 - -## 选择模型 - -不同模型有不同的强项，不同开发者也会有不同偏好。Copilot CLI 允许列出并选择要使用的模型。 - -1. 向 Copilot CLI 发送以下斜杠命令，显示模型列表： - - ``` - /model - ``` - -2. 查看模型列表。每个模型旁边都会显示其名称及单次请求成本修正值。 -3. 如果需要，可以选择一个新模型；或者选择 Esc 退出模型列表。 - -> [!CAUTION] -> 在 Copilot CLI 中，模型选择会持久保留。 - -## 委托给 cloud agent（可选） - -有时希望继续在终端中工作，但把耗时较长的任务交给 Copilot cloud agent。`/delegate` 命令会把当前 Copilot CLI 会话发送到 GitHub.com，由 cloud agent 接手，异步处理，并在完成后打开 pull request。 - -> [!NOTE] -> `/delegate` 需要 cloud agent，Copilot Student、Pro、Pro+、Business 和 Enterprise 都支持——只有 Copilot Free 不支持。如果没有访问权限，可以阅读这一部分，然后跳过动手步骤。 - -1. 先清空当前会话，避免把整个工作坊累积的上下文一并委托出去： - - ``` - /clear - ``` - -2. 发送一个范围较小、定义清晰的提示。例如，可以委托积压工作中的延伸目标——分页功能： - - ``` - Implement pagination on the game list page so it shows a fixed number of games per page with Previous and Next controls, and add tests. - ``` - -3. 发送以下斜杠命令，把会话交给 cloud agent，并确认要委托的提示： - - ``` - /delegate - ``` - -4. 在浏览器中打开 [Copilot agents](https://github.com/copilot/agents) 以监控进度。 -5. 在这个路径中，无需等待 pull request 完成；稍后可以再回来查看。如果想更深入了解如何管理异步 agent 工作，可继续学习 [Cloud agent 路径](../../cloud/)。 - -## 总结和后续步骤 - -在 Copilot CLI 中使用斜杠命令，可以对它进行配置、共享会话，并查看 Copilot 工作方式的内部信息。本课中，已经使用或了解了以下内容： - -- 使用 `/share` 创建 GitHub gist，与团队共享会话。 -- 使用 `/context` 查看 Copilot CLI 当前使用的上下文。 -- 使用 `/model` 查看可用模型列表，并在需要时选择新的模型。 -- 了解了 `/delegate` 作为连接 cloud agent 的可选桥梁。 - -当然，还有更多斜杠命令可用，也还有更多 Copilot CLI 功能值得探索。最后通过[回顾已学内容][next-lesson]以及后续学习方向，为这段旅程收尾。 - -## 资源 - -- [使用 Copilot CLI][using-copilot-cli] -- [关于 Copilot CLI][about-copilot-cli] -- [Copilot CLI 中的上下文管理][context-management] -- [使用 Copilot CLI 共享会话][share-sessions] -- [在 Copilot CLI 中选择模型][selecting-models] - -[previous-lesson]: ../6-custom-agents/ -[next-lesson]: ../8-review/ -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[about-cloud-agent]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-cloud-agent -[context-management]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#context-management -[share-sessions]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#share-sessions -[selecting-models]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#select-an-llm diff --git a/docs/zh-cn/cli/8-create-pull-request.md b/docs/zh-cn/cli/8-create-pull-request.md new file mode 100644 index 00000000..b9c28226 --- /dev/null +++ b/docs/zh-cn/cli/8-create-pull-request.md @@ -0,0 +1,111 @@ +--- +title: "练习 8 - 创建并合并功能 PR" +description: "审查完整的筛选里程碑，复用当前 QA 证据，并在 CI 和审查通过后合并第三个拉取请求。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +现在将筛选里程碑汇集到 PR 3 中。保持练习 4–7 使用的分支和检出目录，其中包含筛选实现、quality-checks 技能及脚本、QA 配置文件和相关测试。 + +在本练习中，你将： + +- 审查完整里程碑的差异和当前 QA 证据。 +- 请求创建一个功能 PR，检查其检查结果和审查反馈。 +- 明确合并已审查的 PR，并更新本地 `main`。 + +## 场景 + +筛选工作分散在多个检查点中，但审查者需要评估一个完整功能。Tailspin Toys 希望 PR 能串联需求、实现、可复用检查和 QA 发现。你将准备好这些交接内容，并在合并前解决阻碍。 + +这是一个遵循存储库约定、范围明确的普通 PR 请求，不需要贡献技能。 + +> [!NOTE] +> 生产团队可能会将功能与可复用质量基础设施分开。本研讨会有意将两者结合，在一个功能 PR 中展示完整工作流。此前的星级评分和指令 PR 应已合并到 `main`，而不是再次作为无关工作出现在差异中。 + +## 检查准备状态和证据 + +1. 审查 QA 结论及需求与证据的对应关系。**NO-GO**、缺少浏览器证据或跳过必需检查，都是合并前需要解决的阻塞项。 +2. 确认全部四项检查确实通过 quality-checks 技能运行：lint、单元测试、E2E 和类型检查。 +3. 审查被测修订版本，以及这些检查完成后的更改。只有被测代码、测试和验证脚本保持不变时，才可复用当前 QA 证据。仅创建检查点提交不会使相同文件内容的证据失效，但代码变化会。 +4. 如果实现或被测输入发生变化，重新运行相关技能检查和浏览器观察，并更新证据。当当前 QA 结果仍适用时，不要仅因为要打开 PR 就重新运行整个套件。 +5. 检查完整的分支差异，而不只是最新检查点或未提交的更改。 + +在同一检出目录的另一个终端中运行： + +```bash +git status +git fetch origin +git log --oneline origin/main..HEAD +git diff --stat origin/main...HEAD +git --no-pager diff origin/main...HEAD +``` + +三点差异显示当前分支自与 `origin/main` 的共同祖先以来的更改，包括早期检查点。确认其中仅包含预期的筛选里程碑。也要检查新文件；暂存前必须审查意外出现的未跟踪或未提交文件。 + +## 请求创建 PR 3 + +练习 7 已在创建检查点前让你返回普通 **Interactive** 会话。如果 QA 配置文件不再处于活动状态，且筛选检出目录和分支未变，就在该会话中继续。保留议题 URL、批准的规划澄清内容及当前 QA 报告，包括被测修订版本和检查结果。 + +QA 配置文件禁止在 QA 期间提交和执行 PR 操作。如果它仍处于活动状态，应先返回普通会话，再请求创建 PR： + +1. 等待 QA 空闲，再在其 CLI 提示符处输入 `/exit`。如果另一个会话仍在活动，导致 CLI 未关闭，应先完成或保留该工作，再返回普通提示符并按 Ctrl+D，关闭此 CLI 实例。 +2. 在 shell 提示符处，保持同一筛选检出目录和分支。确认它们的标识，再启动新的普通会话，不使用 `--agent qa` 或恢复会话标志： + + ```bash + pwd + git branch --show-current + git status + copilot + ``` + +3. 确认处于 **Interactive** 模式，且 QA 配置文件不再活动。不要创建其他工作树、更改分支或恢复 QA 会话。 + +将下方所有占位符替换为真实议题 URL、批准的澄清内容和当前 QA 证据。即使仍在练习 7 的普通会话中，也应明确提供这些信息；新对话不得依赖 QA 会话的记忆。 + +```plaintext +为此议题准备筛选功能 PR：。以下是我在规划时批准的附加验收标准：<粘贴约定的澄清内容，或填写 none>。以下是当前 QA 证据：<粘贴 QA 报告，包括被测修订版本、浏览器观察、覆盖评估、全部四项检查结果和任何限制>。 + +确认检出目录和当前筛选分支。检查相对于 main 的完整差异、所有里程碑检查点提交、git status、存储库 PR 模板及所提供的 QA 证据。仅包含已审查的筛选实现、quality-checks 技能及随附脚本、QA 智能体定义和相关测试。 + +仅在 QA 结果仍描述最终文件内容时复用。如果代码、测试或验证脚本之后发生变化，先报告，并通过技能运行相关检查及受影响的浏览器验证，再将这些结果作为当前证据。不要将失败、受阻或跳过的检查标记为通过。 + +如有需要，提交剩余已审查的里程碑更改，推送当前分支，并遵循存储库约定创建一个以 main 为目标的 PR。包含议题及批准的标准、实现摘要、新增测试或无需新增的理由、浏览器观察、全部四项检查结果和剩余限制。不要合并、创建其他分支、调用贡献技能或开始其他功能。 +``` + +## 审查 PR 和 CI + +打开返回的 URL，在 **Files changed** 中检查整个 PR。确认其中包含技能脚本和 QA 配置文件，并且没有混入凭据、本地 MCP 配置、无关文件、生成的报告或依赖安装。 + +使用 PR 的 **Checks** 选项卡，或在功能分支的终端中运行： + +```bash +gh pr view +gh pr diff +gh pr checks --watch +``` + +检查存储库的 `.github/workflows/`，不要假设绿色标记涵盖所有验证类型。当前 Tailspin 的 **Run tests** 工作流会运行 lint、类型检查、Vitest 单元测试，以及针对构建后静态站点的 Playwright E2E 测试。它不能替代 QA 报告中的直接 MCP 浏览器观察。研讨会站点的 Astro 构建和链接检查验证的是另一个存储库。 + +如果检查失败，查看日志并解决原因。针对性修复必须在更新后的修订版本上经过审查和重新验证，再推送。如果 `main` 变化且解决冲突改变了功能，也应更新受影响的证据。等待必需的人工审查；智能体自己的批准不能覆盖分支保护。 + +## 合并并更新本地 main + +PR 满足全部审查和检查要求后，在 GitHub 上明确选择 **Merge pull request** 并确认合并。确认 PR 3 为 **Merged**。 + +使用 `/exit` 退出 CLI 会话。在工作树干净的情况下，更新本地检出内容： + +```bash +git status +git switch main +git pull --ff-only +``` + +## 总结与后续步骤 + +下一练习无需新分支。现在已合并恰好三个研讨会 PR：星级评分；指令及示例改动；筛选功能及质量技能、QA 配置文件和测试。 + +继续学习[练习 9 - 探索斜杠命令和 CLI 选项][next-lesson]，在明确范围内了解 CLI 控件，而不是开始其他实现任务。 + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-slash-commands/ diff --git a/docs/zh-cn/cli/8-review.md b/docs/zh-cn/cli/8-review.md deleted file mode 100644 index 5b1db087..00000000 --- a/docs/zh-cn/cli/8-review.md +++ /dev/null @@ -1,70 +0,0 @@ ---- -title: "练习 8 - 回顾与后续步骤" -authors: - - geektrainer -lastUpdated: 2026-06-30 ---- - -在前几节练习中，已经探索了 GitHub Copilot CLI 的一些最常见用例，包括： - -- 与 GitHub 和其他 MCP 服务器交互。 -- 使用说明文件指导代码生成。 -- 实现技能，为 Copilot CLI 工具箱添加工具。 -- 调用自定义智能体处理更高级、更复杂的任务。 -- 使用斜杠命令管理会话，并可选择通过 `/delegate` 衔接回 cloud agent。 - -下面再谈谈一些斜杠命令、最佳实践和后续步骤。 - -## 斜杠命令 - -Copilot CLI 提供了一系列斜杠命令用于交互，其中包括一些可用于配置它或查看幕后情况的命令。前面已经使用过 `/clear` 来开始新聊天并清除当前上下文，也使用过 `/mcp` 来查看和管理 MCP 服务器。以下是一些可能也很有用的命令： - -| 命令 | 说明 | -| ------------------ | ------------------------------------------------------------- | -| `/add-dir` | 将目录添加到 Copilot 的受信任列表 | -| `/clear`, `/new` | 清除对话历史并重新开始 | -| `/compact` | 总结对话历史，以减少上下文窗口占用 | -| `/context` | 显示上下文窗口 token 使用情况和可视化信息 | -| `/diff` | 查看当前目录中的变更 | -| `/model` | 选择要使用的 AI 模型（Claude Sonnet、GPT-5 等） | -| `/plan ` | 在编码前创建实现计划 | -| `/review ` | 运行代码审查代理分析变更 | -| `/delegate` | 将任务委托给 Copilot cloud agent 进行异步处理 | -| `/session` | 显示会话信息和工作区摘要 | -| `/share` | 将会话共享为 markdown 文件或 GitHub gist | -| `/skills` | 管理技能以增强能力 | -| `/usage` | 显示会话使用指标和统计信息 | - -> [!TIP] -> 使用 `/help` 查看完整的可用命令列表和键盘快捷键。 - -## 最佳实践 - -使用任何 AI 工具时，底层基础设施都会影响最终效果。完善的说明文件、自定义智能体和智能体技能都很重要——本工作坊已经逐一体验过。[awesome-copilot][awesome-copilot] 是一个很好的模板来源，而 Copilot 本身也可以为这些内容生成脚手架，作为起点。 - -和基础设施同样重要的，仍然是上下文。清楚描述想构建*什么*、*为什么*构建、以及*如何*构建，都会显著影响输出结果。凡是有助于 Copilot 的信息，都应该主动提供。 - -## 后续步骤 - -提升任何工具使用能力的最好方式，就是持续使用它。把它用在生产代码上、用在个人项目上，或者用在那个想了很多年却一直没开始实现的小应用上。把经验分享给团队，也从团队中学习。并且，一如既往地，多查阅文档。 - -如果想继续探索 GitHub Copilot 生态系统，可以查看 [VS Code 路径](../../vscode/) 或 [Cloud agent 路径](../../cloud/)。 - -## 资源 - -- [关于 Copilot CLI][about-copilot-cli] -- [使用 Copilot CLI][using-copilot-cli] -- [Awesome Copilot 存储库][awesome-copilot] -- [自定义说明指南][repo-instructions] -- [Agent Skills 文档][agent-skills] -- [自定义智能体文档][custom-agents] -- [MCP 规范][mcp-spec] - -[previous-lesson]: ../7-slash-commands/ -[about-copilot-cli]: https://docs.github.com/copilot/concepts/agents/about-copilot-cli -[using-copilot-cli]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli -[awesome-copilot]: https://github.com/github/awesome-copilot -[repo-instructions]: https://docs.github.com/copilot/how-tos/configure-custom-instructions/add-repository-instructions -[agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[custom-agents]: https://docs.github.com/copilot/how-tos/use-copilot-agents/use-copilot-cli#use-custom-agents -[mcp-spec]: https://modelcontextprotocol.io/ diff --git a/docs/zh-cn/cli/9-slash-commands.md b/docs/zh-cn/cli/9-slash-commands.md new file mode 100644 index 00000000..1b30ff9e --- /dev/null +++ b/docs/zh-cn/cli/9-slash-commands.md @@ -0,0 +1,98 @@ +--- +title: "练习 9 - 探索斜杠命令和 CLI 选项" +description: "检查上下文、模型和会话控件，审查共享目标，并探索 CLI 标志，不启动其他功能。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +三个 PR 里程碑已完成。现在探索帮助理解和管理会话的 CLI 控件。本练习不实现其他功能、不委托工作，也不打开其他 PR。 + +在本练习中，你将： + +- 检查上下文、用量、模型和模式控件。 +- 将命令行选项与已安装版本的帮助进行比较。 +- 在本地导出会话，并在共享任何内容前进行审查。 + +## 场景 + +功能已交付，接下来需要了解日常工作会用到的 CLI 控件。你将检查会话及其共享选项，而不启动其他任务，避免管理上下文或导出对话时意外授权工作或泄露项目信息。 + +从更新后的练习检出目录中，以 **Interactive** 模式启动 `copilot`。使用 `/help` 和[命令参考][cli-reference]确认已安装版本支持哪些命令；当前文档描述的控件可能比安装版本更新。 + +## 检查上下文和会话信息 + +1. 发送范围明确的只读请求： + + ```plaintext + 汇总存储库的指令文件、quality-checks 技能和 QA 配置文件。说明它们如何支持筛选验证。不要修改文件、执行检查、委托工作、提交或打开 PR。 + ``` + +2. 输入 `/context`，查看上下文窗口用量。注意消息、指令和工具定义如何占用上下文。 +3. 输入 `/compact`，再输入 `/context`。压缩通过总结历史来减少占用；较短会话的变化可能不明显。 +4. 输入 `/session` 检查当前会话，输入 `/usage` 查看使用量信息。 + +压缩不能替代需求输入。切换任务或智能体时，应明确保留并传递议题 URL、批准的标准、检出目录标识和相关证据。 + +`/clear` 开始新对话，但不会撤销文件或切换 Git 分支。`/resume` 打开会话选择器，用于返回之前的工作。查看选择器，再按 Esc 离开，不恢复其他任务。不要清除仅存的一份验收标准，也不要假定恢复对话就意味着旧验证仍然有效。 + +## 检查模型和模式 + +输入 `/model`，查看账户可用的模型，包括提供时可选的 **Auto**。阅读选择详情和使用量信息；模型可用性和定价可能变化。按 Esc 离开选择器，不更换模型。如果确实更换，应确认显示的选择及当前 CLI 版本中该选择的作用范围。 + +使用 Shift+Tab 在 **Interactive**、**Plan** 和 **Autopilot** 间循环切换，观察模式指示器；然后返回 **Interactive**，不发送实现提示词。回顾它们的区别： + +- Plan 用于编码前约定工作。 +- Autopilot 持续执行已批准、范围明确的任务。 +- Interactive 提供明确的审查和决策节点。 +- 权限单独控制允许哪些工具操作。 + +## 检查命令行选项 + +在单独的终端中运行： + +```bash +copilot --help +``` + +将以下文档选项与已安装版本的帮助进行比较： + +| 选项 | 用途 | +| --- | --- | +| `--model MODEL` | 为一次调用选择模型；先确认可用性 | +| `--agent AGENT` | 为一次调用选择自定义智能体 | +| `-p PROMPT` | 以编程方式运行提示词，完成后退出 | +| `--output-format json` | 输出结构化 JSONL，每行一个 JSON 对象 | +| `--resume` | 恢复现有会话 | +| `--enable-all-github-mcp-tools` | 提供完整的内置 GitHub MCP 工具集 | + +这些是要了解的控件，不是另一个待启动的任务。编程模式可以执行真实工具操作；JSON 输出格式并不会让请求变为只读。智能体选择应遵循[练习 7][qa-lesson]中经过验证的工作流，而不是改为要求默认智能体阅读配置文件来代替真正激活自定义智能体。权限和访问限制仍然适用。 + +## 共享前先审查 + +`/share` 可以将会话内容发送到不同目标。[CLI 命令参考][cli-reference]记录了用于 Markdown 导出的 `/share file [session|research] [PATH]`，以及用于发布 gist 的 `/share gist [session|research]`。当前文档说明，不带子命令时，若已登录且已同步，会创建可共享的 GitHub 链接，否则回退为 Markdown 导出。不要假定不带参数的命令只会预览内容而直接运行。 + +本研讨会明确选择本地会话导出及文件名，而不是发布： + +```text +/share file session cli-session-review.md +``` + +在编辑器中打开导出的文件，检查实际内容。审查提示词、回复、工具输出、文件路径、存储库数据，以及任何凭据或个人信息。不要假定导出包含每个内部步骤，或已自动移除敏感内容。 + +> [!CAUTION] +> gist 或共享链接会向外部披露内容。秘密 gist 不提供私密访问控制，任何持有 URL 的人都能查看。共享前确认目标、接收者、权限和组织策略。如果需要脱敏，只能通过批准的渠道共享已审查、已脱敏的文件；之后不要再发布原始会话。 + +不要将此导出放入功能 PR 或存储库历史。检查后，移除刚生成的文件，或将其移到批准的本地笔记位置。不要移除无关文件。 + +云端委托可能创建远程工作和额外 PR，因此不要在此运行 `/delegate`。[Cloud agent 研讨会][cloud-workshop]介绍了这一独立工作流。 + +## 总结与后续步骤 + +你已检查上下文、使用量、模型和模式控件、命令行选项及共享目标，没有启动其他功能。继续学习[练习 10 - 总结与后续步骤][next-lesson]，回顾已构建的工作流和产出。 + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[qa-lesson]: ../7-qa-agent/ +[cloud-workshop]: ../../cloud/ +[cli-reference]: https://docs.github.com/copilot/reference/copilot-cli-reference/cli-command-reference diff --git a/docs/zh-cn/cli/README.md b/docs/zh-cn/cli/README.md index 5d6513c4..0ed3109a 100644 --- a/docs/zh-cn/cli/README.md +++ b/docs/zh-cn/cli/README.md @@ -3,12 +3,12 @@ slug: zh-cn/cli title: "GitHub Copilot CLI" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- **[GitHub Copilot CLI](https://docs.github.com/copilot/concepts/agents/about-copilot-cli)** 将 GitHub Copilot 作为代理式编码助手带入终端。它可以探索代码库、生成代码、运行命令，并连接外部工具——全部通过命令行完成，无需切换到图形化编辑器即可保持工作流畅。 -在这些练习中，将先安装并验证 Copilot CLI，然后通过自定义说明为它提供项目上下文，再使用计划模式有目的地生成一个功能。接着连接 Playwright MCP 服务器，在真实浏览器中测试该功能；然后通过可复用的智能体技能和自定义智能体扩展 Copilot。最后，将探索用于管理上下文、模型和共享的斜杠命令，并回顾已完成的内容。 +完成练习 0–1 的设置后，你将学习练习 2–10 中的九个核心模块。从添加星级评分快速上手，建立文档指令，再使用 **Plan** 和 **Autopilot** 模式构建筛选功能。随后创建可复用的 quality-checks 技能，使用 Playwright MCP 验证行为，创建 QA 智能体，并交付功能。最后探索 CLI 控件，回顾已构建的内容。 ## 练习 @@ -16,13 +16,21 @@ lastUpdated: 2026-06-30 |----------|-------|-------------| | [0. 先决条件][ex0] | 设置 | 创建存储库和 codespace | | [1. 安装 Copilot CLI][ex1] | 安装 | 安装并验证 Copilot CLI | -| [2. 自定义说明][ex2] | 上下文 | 添加一条说明，并观察 Copilot CLI 如何遵循它 | -| [3. 生成代码][ex3] | 代码生成 | 使用计划模式生成功能 | -| [4. 使用 Playwright MCP 测试][ex4] | 外部工具 | 添加 Playwright MCP 服务器，并在浏览器中测试功能 | -| [5. 智能体技能][ex5] | 技能 | 用专门的技能增强 Copilot | -| [6. 自定义智能体][ex6] | 智能体 | 查看并使用自定义智能体 | -| [7. 斜杠命令][ex7] | CLI 功能 | 探索上下文、模型、共享，以及可选的委托给 cloud agent | -| [8. 回顾][ex8] | 总结 | 回顾关键概念和后续步骤 | +| [2. 添加星级评分：快速上手][ex2] | 首次更改 | 显示现有评分，完成验证，并合并 PR 1 | +| [3. 使用自定义指令引导 Copilot][ex3] | 上下文 | 添加文档约定，展示其效果，并合并 PR 2 | +| [4. 使用 Plan 和 Autopilot 构建筛选功能][ex4] | 实现 | 审查计划，批准 Autopilot，测试并保存检查点 | +| [5. 创建并使用 quality-checks 技能][ex5] | 技能 | 生成、审查并运行随附的 shell 检查脚本 | +| [6. 使用 Playwright MCP 验证功能][ex6] | 浏览器工具 | 在真实浏览器中观察筛选行为 | +| [7. 创建并使用 QA 智能体][ex7] | 智能体 | 审查需求和覆盖情况，收集最终证据 | +| [8. 创建并合并功能 PR][ex8] | 交付 | 在 PR 3 中一并审查筛选功能和可复用自定义配置 | +| [9. 探索斜杠命令和 CLI 选项][ex9] | CLI 控件 | 检查上下文、模型、会话和共享目标 | +| [10. 总结与后续步骤][ex10] | 总结 | 回顾共同产出和三个 PR 里程碑 | + +## 分支和拉取请求 + +你将合并三个拉取请求：星级评分；指令及小型示例改动；最后是筛选功能及 quality-checks 技能、QA 配置文件和相关测试。前两个 PR 都必须先完成合并，再从更新后的 `main` 开始下一个里程碑。 + +练习 4–8 共用一个功能分支和检出目录。过程中使用检查点提交保存进度；创建技能、设置 MCP 和选择 QA 不会开启新的功能分支。练习 9 只探索控件，不启动其他功能或 PR。 ## 先决条件 @@ -46,10 +54,12 @@ lastUpdated: 2026-06-30 [ex0]: 0-prerequisites/ [ex1]: 1-install-copilot-cli/ -[ex2]: 2-custom-instructions/ -[ex3]: 3-generating-code/ -[ex4]: 4-mcp/ +[ex2]: 2-add-star-rating/ +[ex3]: 3-custom-instructions/ +[ex4]: 4-build-filtering/ [ex5]: 5-agent-skills/ -[ex6]: 6-custom-agents/ -[ex7]: 7-slash-commands/ -[ex8]: 8-review/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-slash-commands/ +[ex10]: 10-review/ diff --git a/website/astro.config.mjs b/website/astro.config.mjs index 98536a81..e53afc2e 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -71,13 +71,15 @@ export default defineConfig({ { label: 'Overview', link: '/cli/' }, { label: '0. Prerequisites', link: '/cli/0-prerequisites/' }, { label: '1. Install Copilot CLI', link: '/cli/1-install-copilot-cli/' }, - { label: '2. Custom instructions', link: '/cli/2-custom-instructions/' }, - { label: '3. Generating code', link: '/cli/3-generating-code/' }, - { label: '4. Testing with Playwright MCP', link: '/cli/4-mcp/' }, - { label: '5. Agent skills', link: '/cli/5-agent-skills/' }, - { label: '6. Custom agents', link: '/cli/6-custom-agents/' }, - { label: '7. Slash commands', link: '/cli/7-slash-commands/' }, - { label: '8. Review', link: '/cli/8-review/' }, + { label: '2. Add star ratings', link: '/cli/2-add-star-rating/' }, + { label: '3. Custom instructions', link: '/cli/3-custom-instructions/' }, + { label: '4. Build filtering with Plan and Autopilot', link: '/cli/4-build-filtering/' }, + { label: '5. Create and use a quality-checks skill', link: '/cli/5-agent-skills/' }, + { label: '6. Validate with Playwright MCP', link: '/cli/6-mcp-playwright/' }, + { label: '7. Create and use a QA agent', link: '/cli/7-qa-agent/' }, + { label: '8. Create and merge the feature PR', link: '/cli/8-create-pull-request/' }, + { label: '9. Slash commands and CLI options', link: '/cli/9-slash-commands/' }, + { label: '10. Wrap-up and next steps', link: '/cli/10-review/' }, ], }, {