diff --git a/AUTHORING.md b/AUTHORING.md index fd226b81..ac043196 100644 --- a/AUTHORING.md +++ b/AUTHORING.md @@ -15,7 +15,7 @@ copilot-workshops/ │ ├── cli/ ← Copilot CLI lessons (0-prerequisites.md + numbered exercises) │ ├── vscode/ ← VS Code lessons (0-prerequisites.md + numbered exercises) │ ├── cloud/ ← Cloud agent lessons (0-prerequisites.md + numbered exercises) -│ ├── app/ ← GitHub Copilot app lessons (setup folded into Exercise 1) +│ ├── app/ ← GitHub Copilot app lessons (setup 0–1, core modules 2–10) │ ├── es-es/ ja-jp/ ... ← Translated locale trees (currently the app harness) │ └── _images/ ← Screenshots and diagrams (shared across locales) ├── website/ ← Optional Astro + Starlight publisher diff --git a/docs/README.md b/docs/README.md index 56ff3ad5..83601fa5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -27,7 +27,7 @@ GitHub Copilot inside **Visual Studio Code** and GitHub Codespaces. Work with Co ### 🤖 [Copilot App](app/) -The **GitHub Copilot app** — a desktop application built on Copilot CLI. Run parallel agent sessions, switch session modes, collaborate on canvases, and manage GitHub issues and pull requests natively — including **Agent Merge**, which shepherds a pull request through rebases, review feedback, CI fixes, and merge. +The **GitHub Copilot app** — a desktop application built on Copilot CLI. Follow the same setup and nine core modules through the star-rating, instructions, filtering, skill, MCP, QA, and feature-PR workflow, using the app's isolated sessions and **Agent Merge**. Create and merge a repository-backed canvas as the fourth pull-request milestone, then wrap up. ### ☁️ [Copilot Cloud Agent](cloud/) diff --git a/docs/app/0-prerequisites.md b/docs/app/0-prerequisites.md index 7e9a4050..9e3c47c5 100644 --- a/docs/app/0-prerequisites.md +++ b/docs/app/0-prerequisites.md @@ -15,18 +15,18 @@ In this lesson, you will: ## Install Node.js -Several lessons ask an agent to build features and run the Tailspin Toys test suite locally, which needs **[Node.js][nodejs]** — the only runtime the project requires. Install version **22 or newer**; the current **LTS** release is a safe choice. +Several lessons ask an agent to build features and run the Tailspin Toys test suite locally, which needs **[Node.js][nodejs]**. Use **Node.js 22.13 or later**, and confirm the supported version in your checkout's `package.json` and README. The simplest option on every platform is the official installer: 1. In your operating system, open a terminal window using Windows Terminal, macOS terminal, or whatever you typically use. -2. Run the following command to confirm you have at least Node.js 22 or higher installed: +2. Run the following command to confirm you have Node.js 22.13 or later installed: ```shell node --version ``` -3. If you see `v22` or a higher number, you can skip to the next section! +3. If the reported version is at least `v22.13.0` and supported by the project, you can skip to the next section. > [!TIP] > You only need to complete these steps if you don't have Node installed, or you need to update. @@ -41,10 +41,10 @@ The simplest option on every platform is the official installer: node --version ``` -9. You should see `v22.x.x` or higher. +9. Confirm the reported version is at least `v22.13.0` and supported by the project. -> [!TIP] -> Prefer containers? If you have **[Docker][docker]**, you can use the repository's [dev container][dev-containers] instead of installing Node.js locally — it bundles Node for you. You don't need both. +> [!IMPORTANT] +> This App path uses local worktrees. A runtime installed only in a container is not available to those local sessions. Each worktree also needs the project dependencies and Playwright Chromium for E2E checks. Follow the learner repository's README when preparing a worktree, and review any installation request before approving it. ## Set up the lab repository @@ -64,6 +64,8 @@ You'll work against your own copy of the Tailspin Toys project. Create it now fr > [!NOTE] > 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. +Use a fresh copy of the revised template: it includes repository instructions, application code, tests, and an existing canvas extension, but no supplied custom agents or skills. You will create your own quality-checks skill and QA profile during the workshop. If you use an older copy, inspect existing customizations rather than overwrite them. + ## Summary and next steps You're set up! You installed Node.js so the project can build and test on your machine, and you created your own copy of the Tailspin Toys repository from the template. @@ -79,7 +81,5 @@ Next, you'll install the GitHub Copilot app, connect the repository you just cre [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/1-install-copilot-app.md b/docs/app/1-install-copilot-app.md index ee3f52c4..ab768c91 100644 --- a/docs/app/1-install-copilot-app.md +++ b/docs/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ To use the GitHub Copilot app the first step, as you might imagine, is to instal With your project connected, take a moment to learn your way around. The app organizes everything into a few areas in the sidebar: -- **Sessions** — where agents do their work. Each session runs in its own isolated workspace, so you can run several at once without their changes colliding. You'll start your first session in the next lesson. +- **Sessions** — where agents do their work. For this workshop, choose a **new working tree** so each PR milestone has an isolated checkout and branch. Other workspace choices exist, but are not used here. - **Quick chats** — lightweight conversations for questions and brainstorming that don't need a branch or workspace of their own. You'll try one at the end of this lesson. - **My work** — your issues and pull requests, surfaced through the app's **native GitHub integration**. From here you can browse and filter issues and pull requests, check CI status, start a session from an issue, and review pull requests — all without leaving the app. -- **Automations** — saved agent tasks that run on a schedule or on demand. You'll create one near the end of the harness. +- **Customize** — discover and manage MCP servers, skills, and canvases. You'll use it to configure Playwright MCP. +- **Automations** — saved agent tasks that run on a schedule or on demand. The wrap-up links to these as a next step, not another workshop exercise. ### Find your seeded backlog Because the app integrates with GitHub natively, the work waiting in your repository shows up right inside the app. When you created your repository from the template, a backlog of issues was filed for you — let's confirm it's there. 1. Select **My work** in the sidebar. -2. The template seeded eight issues in your backlog. This harness focuses on the following three — confirm you can see them: +2. Find these issues by title rather than assuming their issue numbers: - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. Select an issue to read its details. Each issue is also a launch point for an agent session — you'll start work from these issues later in the harness. +3. Select an issue to read its details. Each issue is also a launch point for an agent session — you'll start work from these issues later in the harness. Other backlog issues provide context for the canvas, not another implementation task. > [!NOTE] > The list of items in My work is automatically filtered to only display items from the repositories you've added to Copilot app. Want to see work items from other repos? Add them to the app! @@ -84,7 +84,13 @@ Congratulations! You've installed the GitHub Copilot app, connected your project - get oriented in the workspace and find your seeded backlog in **My work**. - use a quick chat to ask a fast, throwaway question. -Next, you'll start your first agent session and make your first change to the project — showing a star rating on the game cards. Continue to [Lesson 2 - Running your first agent session][next-lesson]. +## Keep PR milestones separate + +You will merge four PRs: star ratings; instructions with a small demonstration; filtering with the skill, QA profile, and tests; then the triage canvas. Use one branch per PR milestone. Lessons 4–8 stay in the same filtering session, worktree, and branch, with checkpoint commits rather than extra PRs. + +A new App worktree can start from stale local state. Before each new milestone edits files, fetch the repository and fast-forward the new session branch to the latest `origin/main`. The next lessons show this explicitly. Do not stack branches, cherry-pick earlier work, or switch an active filtering session to another branch. + +Next, you'll start your first agent session and make your first change to the project — showing a star rating on the game cards. Continue to [Lesson 2 - Add star ratings: a quick win][next-lesson]. ## Resources @@ -92,7 +98,7 @@ Next, you'll start your first agent session and make your first change to the pr - [Getting started with the GitHub Copilot app][getting-started] - [Working with agent sessions in the GitHub Copilot app][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/app/8-review.md b/docs/app/10-review.md similarity index 50% rename from docs/app/8-review.md rename to docs/app/10-review.md index 5de4f1ba..9a308d11 100644 --- a/docs/app/8-review.md +++ b/docs/app/10-review.md @@ -1,44 +1,43 @@ --- -title: "Lesson 8 - Review and next steps" -description: "Recap the GitHub Copilot app harness, automate recurring work, and explore where to go next." +title: "Lesson 10 - Wrap-up and next steps" +description: "Recap the nine core App modules, four PR milestones, and reusable quality workflow, then explore further resources." authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- Over the last several lessons, you took a feature from idea to merge with the GitHub Copilot app, including: - connecting a repository and orienting to the app's workspace and your seeded backlog. - starting sessions from a direct task and from issues, and using Plan and Autopilot modes to control how the agent works. -- guiding the agent with custom instructions and a reusable skill. +- guiding the agent with custom instructions, then asking it to create a reusable skill with shell scripts that you inspected and ran for lint, unit tests, end-to-end tests, and type checks. - testing your work with the Playwright MCP server in a real browser. +- creating and selecting a QA custom agent to assess requirements, coverage, skill-script results, and browser evidence. - collaborating with the agent on a shared canvas. -- shipping changes up a ladder of merge automation — from merging on github.com yourself to letting **Agent Merge** land a pull request. +- explicitly merging the early PRs yourself, then authorizing **Agent Merge** within the feature and canvas PR workflows. -Let's automate some recurring work, talk through best practices, and look at where to go next. +Setup Lessons 0–1 led into nine core modules, Lessons 2–10. Take a moment to review the artifacts and where to go next; this wrap-up does not launch another hands-on task. -## Automate recurring work +## What you shipped -The app can run agents for you on a schedule or on demand through **automations** — great for routine tasks like triaging new issues or recapping recent activity. Let's create a simple, non-destructive one. +The workshop has four PR milestones, each on its own branch from updated `main`: -1. Select **Automations** in the sidebar, then select **New automation**. -2. Give it a name, such as `Recap my recent work`. -3. Choose a trigger. **Manual** lets you run it on demand; **On a schedule** runs it automatically; **When an issue is created** reacts to new issues. Choose **Manual** for this lesson. -4. Enter a read-only prompt so the automation can't change anything, for example: +1. **Star ratings:** display the existing `starRating` and an explicit unrated state on game cards. +2. **Instructions and demonstration:** add the documentation convention and verify its effect on a small real code change. +3. **Filtering and quality workflow:** implement the issue, create the shell-bundled `quality-checks` skill and QA profile, and include the associated tests. +4. **Repository-backed triage canvas:** share a board that adds issue context without automatically implementing another feature. - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` +Lessons 4–8 used the same filtering session, worktree, and branch. Checkpoint commits preserved progress within PR 3; skills, MCP configuration, and QA did not need separate feature branches. Each later milestone began only after the earlier PR merged and the fresh session branch was updated from `origin/main`. -5. Pick the project (your Tailspin Toys repository) and create the automation. -6. Run it on demand to see the result. +## Different kinds of verification -> [!TIP] -> Automations can run locally or in the cloud. Enable **Run in the cloud** and pick the **Tools** an automation may use when you want it to run unattended on a schedule. Keep scheduled automations scoped and non-destructive until you trust their output. +The early features used existing npm checks. Filtering added your manual browser inspection. The skill made the four checks repeatable through bundled scripts, MCP added direct agent browser observations, and QA combined requirements and coverage with final verification. The PR reused QA evidence only while it applied to the submitted revision. + +Tests added should close genuine gaps; a QA run that needs no new tests can be correct. Missing tools, skipped checks, and failures are visible blockers, not passes. Review code and evidence before authorizing merge, and refresh affected evidence after changes. ## Best practices -When using any AI tool, the infrastructure around it drives the quality of what you get out. Instructions files, skills, and custom agents all played a part in this workshop — invest in them and reuse them across sessions. +When using any AI tool, the infrastructure around it drives the quality of what you get out. You created instructions, a skill, and a QA profile in this workshop — review them and reuse them across sessions. Custom agents define specialist roles and instructions, with available tools governed by configuration and harness permissions; skills package reusable task instructions, executable scripts, and supporting resources loaded on demand. A custom agent can execute scripts too, including those bundled with a skill. Confirm actual script execution and custom-agent selection rather than relying on a convincing description. Match the **mode and model** to the task. Use **Plan** to think through an approach before building, **Interactive** to stay in the loop on focused changes, and **Autopilot** only for well-scoped, isolated tasks. Choose a faster model for routine edits and a more capable model with higher reasoning effort for complex work. @@ -49,6 +48,7 @@ Context still matters as much as infrastructure. Clearly describing *what* you w You've covered the core workflow. A few more features worth a look: - **Quick chats** for fast, throwaway questions that don't need a full session. +- [**Automations**][using-automations] for recurring or on-demand tasks such as summarizing recent work. Review the schedule, permissions, and scope before adopting one; creating an automation is a next step, not part of this workshop. - **Rubber duck** to talk through a problem and get high-signal feedback before you build. - [**Custom agents**][custom-agents] to package a role, its tools, and its instructions for repeatable, specialized work. - [`/chronicle`][chronicle] to generate a narrative of what happened in a session. @@ -60,7 +60,7 @@ You've covered the core workflow. A few more features worth a look: The best way to improve with any tool is to keep using it! Use it for production code, for hobby code, for the little app you've had in mind for years but never got around to building. Share your learnings with your team, and learn from theirs. 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/), the [Copilot CLI harness](../../cli/), or the [Cloud agent harness](../../cloud/). +If you'd like to explore more of the GitHub Copilot ecosystem, check out the [VS Code harness][vscode-harness], the [Copilot CLI harness][cli-harness], or the [Cloud agent harness][cloud-harness]. ## Resources @@ -71,6 +71,10 @@ If you'd like to explore more of the GitHub Copilot ecosystem, check out the [VS - [Working with canvas extensions][canvas-docs] - [About cloud and local sandboxes][sandboxes] +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started [customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/app/2-add-star-rating.md b/docs/app/2-add-star-rating.md index 0ac7a9e3..345b3497 100644 --- a/docs/app/2-add-star-rating.md +++ b/docs/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "Lesson 2 - Running your first agent session" +title: "Lesson 2 - Add star ratings: a quick win" description: "Start your first agent session in the GitHub Copilot app, make a small change to the game cards, and merge it as your first pull request." authors: - geektrainer @@ -22,7 +22,7 @@ Each game in Tailspin Toys can have a star rating, and it already appears on the ## Anatomy of a session -A **session** is a conversation with an agent that runs in its own isolated workspace. Every session gets a **dedicated git worktree and branch**, which is what lets you run several sessions at once — one adding a feature, another fixing a bug — without their changes colliding. Your sessions appear in the sidebar grouped by repository; select any one to switch to it. +A **session** is a conversation with an agent. In this workshop you choose a **new working tree**, giving the session a dedicated checkout and branch. This isolates each PR milestone without a separate branch for every lesson. Your sessions appear in the sidebar grouped by repository; select any one to switch to it. Inside a session you'll see three things: the **conversation** with the agent, the agent's **tool activity** as it explores and edits files, and the list of **changed files** with their diffs. @@ -36,16 +36,20 @@ Let's start a new session to begin exploring the project and implementing our fe ![The GitHub Copilot app prompt box with the repository selector set to tailspin-toys and the model selector shown beneath the prompt](../_images/app-2-start-session.png) -4. Use the following prompt to request the change: +4. Choose a **new working tree** and **Interactive** mode below the prompt box. Use the following prompt to request the change: ```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. + Before editing, identify this checkout and branch, confirm it is a clean new worktree, fetch origin, and fast-forward this session branch to origin/main. Confirm HEAD matches origin/main. Stop and explain if it is dirty, diverged, or cannot be updated; do not reset or discard work. + + 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 or change the data model. + + Follow repository instructions, add or update appropriate tests, and run the relevant existing npm checks. Inspect prerequisites and ask before installing anything. Report the changed files and check results, then stop for my review. Do not commit, push, open a pull request, or implement another feature. ``` > [!NOTE] > Notice how the prompt contained the name of the file for Copilot to update. While it's not required at all to specify which files Copilot should include in its work, pointing it in the right direction both helps Copilot quickly generate code and reduce token usage. -5. Select Enter to send the prompt to Copilot. +5. Press Enter to send the prompt to Copilot. Copilot app begins work by first creating a new worktree, an isolated copy of the project. It then explores the project, locating the necessary files to update to add the new feature. It will then create the necessary code. You've now added a new feature with Copilot app! @@ -76,7 +80,9 @@ All AI-generated changes deserve a review before they're merged, even small ones ## Check the changes -Of course we shouldn't just read the code and assume it works. We should visually test everything as well! To do so we'll need to start the app from the terminal, then confirm everything works. Fortunately there's a terminal built into Copilot app! +Review the agent's automated check results before opening a browser. Confirm that tests cover a numeric `starRating` and the `null` fallback, using the project's existing npm scripts rather than a skill that does not exist yet. A missing prerequisite or skipped check is not a pass. + +Then inspect the app manually using the session's built-in terminal. Identify the worktree before starting the server, and do not reuse a server belonging to another checkout. 1. In the review panel on the right side of Copilot app, select **Terminal**. If there is no **Terminal** button, select the **+** (labeled as **Open in panel**), then select **Terminal**. @@ -89,26 +95,30 @@ Of course we shouldn't just read the code and assume it works. We should visuall ``` 3. Once the server starts (this will just take a moment), open a browser window. -4. Navigate to http://localhost:4321. -5. You should now see star ratings on all the games on the landing page! +4. Open the local URL printed by the server, normally `http://localhost:4321`. If the port is occupied, identify the owner instead of stopping an unrelated process. +5. Confirm rated game cards display their value out of five. Where unrated data is available, confirm **No rating yet** appears; otherwise use the automated test to verify the null case rather than claiming you observed it. 6. Return to the terminal window. -7. Select Ctrl+C to stop the dev server. +7. Press Control+C (Mac) or Ctrl+C (Windows/Linux) to stop the dev server you started. ## Open and merge your first pull request -Your change looks good — now it's time to ship it! You'll ask the agent to open a pull request, then review and merge it yourself on github.com. For now we'll manage this manually. In an upcoming lesson we'll explore how Copilot can handle some of the work for you automatically. +Your change looks good — now it's time to ship PR 1. First authorize the commit and PR separately from implementation: + +```plaintext +Review the full diff for the star-rating change and its tests, summarize the verification, and commit the reviewed changes on this session branch. Push the branch and create a pull request targeting main using the repository's PR template. Do not merge it. +``` -1. In the upper right hand corner, select **Create PR**. +1. Follow the created PR link in the session. If the app presents a **Create PR** confirmation, select it to approve the request rather than creating a second PR. 2. If prompted, select **Sign in with your browser** and follow the prompts to authenticate. 3. Copilot gets to work on creating the PR. -Once the PR is created, Copilot will monitor any workflows on the repository that need to run. After a few moments, the button in the upper right will change to **Ready to merge**. This will be your indication your PR is ready to merge! +Once the PR is created, inspect the full PR diff and the checks in **My work**. Read the learner repository's workflow results; wait for required checks and reviews, and resolve failures before merging. **Ready to merge** is not a substitute for reviewing the change or your local evidence. 4. Select the **PR** bubble just above chat to open your PR in the review pane to see your pull request. You can review the PR as needed here. 5. Once ready, select **Ready to merge**. 6. Select **Merge pull request** on the new dialog window to merge your pull request! -You've now pushed a new feature to the website! +Confirm PR 1 is merged into `main` before continuing. Merging the learner repository does not by itself deploy a website. The next lesson starts a fresh worktree and updates it from `origin/main` so it includes this PR. ## Summary and next steps @@ -118,7 +128,7 @@ You've started your first agent session and shipped your first change! Specifica - directed the agent to make a small, focused change to the game cards. - reviewed the change in the workspace diff view. - ran the app locally to confirm the star rating in the browser. -- opened a pull request and merged it yourself on github.com. +- opened PR 1, reviewed its checks, and explicitly merged it. Next, you'll use the app to add a custom instructions standard to the repository — starting from one of the issues in your backlog. Continue to [Lesson 3 - Guiding Copilot with custom instructions][next-lesson]. @@ -129,6 +139,7 @@ Next, you'll use the app to add a custom instructions standard to the repository - [Managing issues and pull requests with the GitHub Copilot app][managing-issues-prs] [prior-lesson]: ../1-install-copilot-app/#install-and-configure-the-github-copilot-app +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/3-custom-instructions.md b/docs/app/3-custom-instructions.md index 4711afd4..1963fe11 100644 --- a/docs/app/3-custom-instructions.md +++ b/docs/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "Lesson 3 - Guiding Copilot with custom instructions" -description: "Use the GitHub Copilot app to add a custom instructions standard to your repository, starting from an issue in your backlog and merging the change as a pull request." +description: "Add a documentation standard, demonstrate it on a small existing helper or component, and merge both as the second pull request." authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- 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 that context available. One of the most powerful tools for this is [instruction files][instruction-files], which describe not just *what* code you want but *how* it should be structured. In this lesson you'll add a documentation standard to your repository, and you'll do it the way you'll do most work from here on: starting from an issue in your backlog and letting the agent make the change. @@ -12,15 +12,17 @@ In this lesson, you will: - explore how repository instructions and path-scoped instruction files reach the agent. - start a session from the instructions issue in your backlog. -- ask the agent to add a documentation standard to `.github/copilot-instructions.md`. -- review the change and merge it as a pull request. +- ask the agent to add a focused documentation standard to the appropriate repository instruction files. +- demonstrate the standard with a small real code change, validate it, and merge PR 2. ## Scenario As any good dev shop, Tailspin Toys has a set of guidelines and requirements for development practices. These include: -- Documentation should be added to code in the form of TSDoc doc comments. -- Formatting should be documented and enforced through linting. +- Comments should explain intent and non-obvious decisions rather than restate code. +- Exported functions in `db/` and `src/lib/` should document their purpose, parameters, and return values with TSDoc/JSDoc, including an injectable `db` argument where present. +- Reusable Astro components should document their `Props` contracts, and comments should stay current when related code changes. +- Existing formatting and lint guidance should be preserved. Through the use of instruction files you'll ensure Copilot has the right information to perform the tasks in alignment with the practices highlighted. @@ -28,13 +30,13 @@ Through the use of instruction files you'll ensure Copilot has the right informa 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: +The project uses two kinds of instruction 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] -> Copilot supports other standards to bring in instructions guidance through AGENTS.md, CLAUDE.md and GEMINI.md, allowing you to ensure Copilot always has the right context. +> Other instruction formats and support vary by harness. Consult the [custom instructions support reference][custom-instructions-support] before relying on a particular format. ### Best practices for managing instructions files @@ -74,49 +76,55 @@ Take a moment to read the instruction files this repository ships with — there 11. 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. +> Compare the existing guidance with the actual coding-standards issue before adding rules. This lesson focuses on intent-based comments, exported data-layer function documentation, and Astro `Props` contracts, not blanket file headers or comments that restate code. ## Start from the instructions issue -In the previous lesson you started a session from a direct prompt. Most work, however, starts with an issue. Let's create a new session based off an issue filed to update the instructions files, then make the request for the update. +Confirm PR 1 is merged before creating this session. Start a fresh worktree for PR 2; do not continue on the star-rating branch. Most work starts with an issue, so use the coding-standards issue to supply the requirements. > [!NOTE] > Because instructions files have a large impact on the code generated by Copilot, care should be taken in ensuring they clearly guide Copilot. Having Copilot create a first version, like you'll do in this lesson is a great approach, followed by a review by you to ensure the updates meet your requirements. 1. Select **My work** in the sidebar 2. Select the issue titled **Update our repository coding standards** to open the issue. -3. Select **New session** in the upper right to start a new session based on the issue. +3. Select **New session** in the upper right, choose a **new working tree**, and select **Interactive** mode. ![The issue view in the GitHub Copilot app with an arrow pointing to the New session button in the upper right](../_images/app-new-session-from-issue.png) -4. Use the following prompt to request Copilot update the instructions files to meet the requirements documented in the issue: +4. Use the following prompt. Updating the new session branch before editing makes the latest merged `main` the actual starting point, even if the app's local checkout was stale: - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + Before editing, identify this checkout and branch, confirm it is a clean new worktree, fetch origin, and fast-forward this session branch to origin/main. Confirm HEAD matches origin/main and includes the merged star-rating PR. Stop if it is dirty, diverged, or missing that merge; do not reset, discard work, or create another branch. + + Read the issue "Update our repository coding standards" and the existing repository instructions. Add a focused documentation convention: explain intent rather than mechanics; document exported functions in db/ and src/lib/ with TSDoc/JSDoc covering purpose, parameters, returns, and injectable db arguments where present; document reusable Astro components' Props contracts; and keep comments current when related code changes. + + Put each rule in the appropriate existing instruction file without duplication or contradictions, and link to or summarize the updated standard in README. Preserve existing formatting and lint guidance. Do not require blanket file headers, migrate formatting tools, rewrite documentation across the application, or implement filtering. Show me the instruction diff, then stop for review. Do not create a skill or agent, commit, push, or create a PR. + ``` Copilot will make the updates! ## Review the change -Let's both read through the updates Copilot made, but also ask it to provide an example of the code it will now generate based on the updated instructions. +Read the updated guidance, then demonstrate its effect on a real file. A proposed snippet alone does not show that repository instructions affected a code change. 1. Select **Changes** in the upper right to open the code changes. ![The session panel tabs in the GitHub Copilot app with an arrow pointing to the Changes tab](../_images/app-select-changes.png) -2. Review the updated instructions file. Confirm it has the guidelines about adding documentation and comments to the code. +2. Review the updated instruction files and README reference. Confirm the rules match the issue's comment philosophy, exported-function documentation, and component contracts without inventing a blanket file-header requirement. > [!NOTE] > Because AI is probabilistic rather than deterministic, the exact text will vary. -3. Use the following prompt to ask Copilot to create an example of the code it will now generate: +3. After reviewing the instructions, request a bounded demonstration in this same session: + + ```plaintext + Demonstrate the updated documentation convention on one small existing exported TypeScript helper in db/ or src/lib/, or one reusable Astro component. Inspect the repository to choose a suitable existing file; do not assume a publishers helper exists. Make a small behavior-preserving readability improvement and apply the relevant function-documentation or Props-contract guidance. Explain non-obvious intent without adding comments that merely restate code. - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + Keep the change bounded to that demonstration and any directly relevant tests. Do not implement filtering or create a new feature. Run the relevant existing npm checks, report what changed and how the instruction affected the code, and stop for review. Ask before installing anything. Do not commit, push, or create a PR. + ``` -4. Review the code Copilot proposes. Note the TSDoc doc comments and the file header comment it includes — exactly what the updated instructions ask for. +4. Review the actual file diff, not only the chat response. Check that the documentation explains the real behavior and that the readability change preserves it. Review the relevant test, lint, and type-check results; resolve failures before continuing. You've now updated the instructions files in the project and seen the impact it will have! @@ -124,17 +132,23 @@ You've now updated the instructions files in the project and seen the impact it Instructions files become assets in the repository, meaning they're shared with the rest of the team. Let's create a PR with our work, just like we would any other asset! -1. In the upper right hand corner, select **Create PR**. +First authorize the reviewed instructions and demonstration together: + +```plaintext +Review the full diff for the coding-standard instructions, README reference, and bounded code demonstration, including any related tests. Summarize the verification and commit these reviewed changes on this session branch. Push the branch and create one pull request targeting main, using the repository's PR template and linking the coding-standards issue. Describe this as a partial contribution unless every issue acceptance criterion is satisfied; do not use closing keywords for incomplete work. Do not merge it. +``` + +1. Follow the PR link in the session. If the app presents a **Create PR** confirmation, select it without creating a duplicate PR. 2. If prompted, select **Sign in with your browser** and follow the prompts to authenticate. 3. Copilot gets to work on creating the PR. -Once the PR is created, Copilot will monitor any workflows on the repository that need to run. After a few moments, the button in the upper right will change to **Ready to merge**. This will be your indication your PR is ready to merge! +Inspect the full PR diff in **My work**, including both the instruction and code changes. Review the learner repository's CI results and any required reviews. Resolve failures before selecting **Ready to merge**; CI does not replace the demonstration or your review. 4. Select **Ready to merge**. 5. Select **Merge pull request** on the new dialog window to merge your pull request! > [!NOTE] -> With the standard merged into your default branch, it becomes part of the project for everyone — and for every new session. When you start the filtering session in the next lesson from an up-to-date default branch, the agent will follow this standard automatically. You'll see the TypeScript it generates include TSDoc doc comments without being asked — a small but real demonstration of instructions shaping generated code. +> Confirm PR 2 is merged into `main` before beginning filtering. A new worktree alone does not guarantee current code: in Lesson 4 you will fetch and fast-forward the fresh session branch to `origin/main`, then verify both earlier merges are present before planning. ## Summary and next steps @@ -142,10 +156,10 @@ You explored how the app picks up context from instruction files, then used a se - explored the repository's `copilot-instructions.md` and path-scoped `*.instructions.md` files. - started a session from the instructions issue in your backlog. -- asked the agent to add a documentation standard to `.github/copilot-instructions.md`. -- reviewed the change and merged it as a pull request. +- asked the agent to add focused documentation rules to the appropriate instruction files and reference them from README. +- inspected the standard's effect on a real code change, validated the result, and merged both as PR 2. -Next, you'll build the filtering feature in a fresh session — and watch it pick up the standard you just merged. Continue to [Lesson 4 - Building a feature with Autopilot][next-lesson]. +Next, you'll build the filtering feature in a fresh session — and check that it follows the standard you just merged. Continue to [Lesson 4 - Build filtering with Plan and Autopilot][next-lesson]. ## Resources @@ -154,6 +168,7 @@ Next, you'll build the filtering feature in a fresh session — and watch it pic - [Best practices for creating custom instructions][instructions-best-practices] - [Awesome Copilot — a collection of instruction files and other resources][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/app/4-build-filtering.md b/docs/app/4-build-filtering.md index 328b1edd..12fa5e41 100644 --- a/docs/app/4-build-filtering.md +++ b/docs/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "Lesson 4 - Building a feature with Autopilot" -description: "Use Plan and Autopilot modes in the GitHub Copilot app to build a static, client-side filtering feature, watch it inherit your documentation standard, and verify it with an agent skill." +title: "Lesson 4 - Build filtering with Plan and Autopilot" +description: "Plan filtering from its issue, explicitly approve Autopilot, validate with the existing npm checks and a manual browser visit, and save a checkpoint." authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -We've made a couple of small updates to our project thus far. But more robust changes require a more robust process. Fortunately, the GitHub Copilot app is built to work with our existing flow, ensuring we build the right things the right way. This is the first of three lessons where you will follow a typical development process, starting by using an issue to generate a new feature and an agent skill to run the validation tests and linters. +You have merged star ratings and the documentation standard with its code demonstration. Now build the filtering feature. This is the start of one larger PR milestone: keep this same session, worktree, and branch through Lessons 4–8. In this lesson, you will: -- start a fresh session from the filtering issue. -- use **Plan** mode to plan the feature, then **Autopilot** to build it. -- confirm the generated code follows the documentation standard you merged earlier. -- verify your work with the project's `quality-checks` skill. +- start from updated `main` and read the actual filtering issue. +- resolve requirements in **Plan** mode before explicitly approving **Autopilot**. +- review filtering and tests, then run the four existing npm checks. +- visit the feature manually in a browser and save a checkpoint. + +The skill, MCP validation, QA profile, and feature PR come in later modules. Do not create them during this implementation step. ## Scenario -The home page lists every game, but visitors can't narrow the list down. The filtering issue asks you to let them filter games by **category** and **publisher**. Let's use Copilot to implement that functionality. +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. -## Background +## Session modes -Introducing AI coding agents to your development flow doesn't change the fundamentals. If anything, they become even more important! Most developers follow a flow that resembles: +The mode selector below the prompt controls the agent's autonomy: -1. Open a filed issue with details of what needs to be done. -2. Create a plan of what needs to be built. -3. Build and review the code. -4. Run the tests to validate the code. -5. Manually validate the new functionality. -6. Create a pull request (PR). -7. Once the code has been reviewed and the continuous integration process succeeds, merge the code. +- **Interactive** keeps you involved as the agent works and requests input. +- **Plan** prepares a plan for review before implementation. +- **Autopilot** implements and iterates autonomously within the approved scope and permissions. -> [!NOTE] -> Depending on your team and organization, the exact specifics will vary. But most will be a variation on the theme listed above. +Plan first, make approval explicit, then return to Interactive before creating reusable customizations. -By sticking to this standard approach you ensure the code generated by AI meets the requirements set forth, and goes through the same vetting process as code written by hand. +## Start from updated main -## Session modes +Confirm PR 1 and PR 2 are merged on GitHub. Create a fresh worktree for filtering rather than continuing either earlier branch. -The **session mode** controls how much autonomy the agent has. You can set it from the dropdown below the prompt field and change it at any time: +1. Select **My work** and find **Allow users to filter games by category and publisher** by title. Open it and copy its actual URL; issue numbers vary between repositories. +2. Select **New session** and choose a **new working tree**. Keep **Interactive** mode for the baseline update. -- **Interactive**: You and the agent work together. The agent suggests changes and waits for your input before proceeding. -- **Plan**: The agent creates a plan first. You review and approve the plan before the agent executes it. -- **Autopilot**: The agent works fully autonomously—writing code, running tests, and iterating without waiting for input. + ![The issue view in the GitHub Copilot app with an arrow pointing to the New session button](../_images/app-new-session-from-issue.png) -## Plan the filtering feature +3. Send this setup request before planning or editing: -The best time to catch a potential issue is before any code is written, and the best way to do that is a bit of planning in advance. By planning with Copilot you'll ask Copilot to generate a set of steps and document the approach it will take. You can then review the plan, make any suggestions you might have to improve it, before letting Copilot generate the code based on the plan. - -Let's open the issue, start a new session, and create a plan by switching into plan mode and making the request. + ```plaintext + Prepare this fresh filtering session without implementing anything. Identify the checkout and branch, confirm the worktree is clean, fetch origin, and fast-forward this session branch to origin/main. Confirm HEAD matches origin/main and includes the merged star-rating and coding-standards PRs. -1. Select **My work** from the navigation tab. -2. Select the issue titled **Allow users to filter games by category and publisher**. -3. Select **New session** in the upper right. + Stop and explain if the checkout is dirty, diverged, or missing either merge. Do not reset or discard work, switch branches, create another branch, or edit application files. Report the baseline revision. + ``` - ![The issue view in the GitHub Copilot app with an arrow pointing to the New session button in the upper right](../_images/app-new-session-from-issue.png) +4. Check the reported baseline. Fetching alone does not update the worktree: the current session branch must be fast-forwarded and its `HEAD` must match the fetched `origin/main` before work begins. -4. Select Shift+Tab until the mode displays **Plan**. +## Plan the filtering feature - ![The GitHub Copilot app prompt box with an arrow pointing to the mode selector set to Plan](../_images/app-4-plan-mode.png) +Switch the mode selector to **Plan**. Replace the issue placeholder below with the URL you copied. -5. Send the following prompt. The filtering issue is already in this session's context because you started from it: +```plaintext +Plan the filtering feature from this issue: . Read its full acceptance criteria and the repository instructions, then inspect the current static Astro application and its existing data-access helpers and tests. Do not implement yet. - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +Cover multiple-category selection, publisher filtering, combined category and publisher filtering, suitable data-access helpers, accessible controls, and unit and end-to-end coverage required by the issue. Ask me to resolve unspecified behavior, such as how multiple categories combine, clearing filters, and empty results, rather than silently invent requirements. Do not introduce a server API unless the requirements and existing architecture justify it. -6. The agent may ask follow-up questions as it builds the plan. Answer them based on how you'd build the feature. +Propose a bounded implementation and verification plan that follows the repository documentation convention and adds or updates the necessary unit and end-to-end tests. After confirming the commands in package.json, plan to run npm run lint, npm run test:unit, npm run test:e2e, and npm run typecheck:all using the existing project tooling. Record the issue URL and my approved clarifications in the plan so I can reuse them for QA. -> [!NOTE] -> Because Copilot is probabilistic, the exact follow-up questions Copilot asks will vary. In fact, it might not ask any questions! This is perfectly normal. +Include these execution safeguards in the plan before I approve it: identify the checkout and server under test; inspect prerequisites before running checks; ask before installing software, dependencies, or browsers; do not reuse another worktree's server; stop only servers you started; and report other port conflicts rather than stopping unrelated processes. Missing prerequisites and skipped checks must be reported as blockers, not passes. -7. Once completed, Copilot will offer a plan summary. Review the plan. You should see it propose building queries, adding filter controls, and of course tests. Provide feedback to refine it if you'd like — the agent will incorporate your suggestions into a new version. +Include this implementation boundary in the plan: after I explicitly approve Autopilot, implement only the agreed filtering feature and its tests in this same worktree and branch, run the four checks, report the implementation and all check results including failures or blockers, then stop for my review and manual browser check. Do not create skills or custom agents, configure MCP, change branches, commit, push, or open a PR during implementation. The manual browser check and checkpoint commit happen later under my separate direction. -## Build it with Autopilot +For now, stay in Plan mode and stop with the plan for my review. Do not implement, create skills or custom agents, configure MCP, change branches, commit, push, or open a PR. +``` -With the plan created, let's let Copilot build the implementation! +Answer any clarifying questions and review the plan against the issue. Look for the data-access changes, accessible controls, and tests rather than accepting a UI-only implementation. Save the actual issue URL and approved clarifications from the plan for Lessons 6 and 7; use `none` when no extra criteria were needed. -1. In the list of options in the **Plan summary** dialog, select the option closest to **Approve and implement with autopilot**. +Before approving, confirm the plan itself contains the four checks, documentation convention, prerequisite and server safeguards, same-worktree/branch requirement, and the stop after implementation and verification. It must prohibit later skills, agents, MCP setup, commits, pushes, and PRs during implementation. If any boundary is missing, request a revised plan while still in **Plan** mode and inspect the revision before approving. -Copilot will begin work on the implementation! +## Explicitly approve Autopilot -> [!NOTE] -> If Copilot doesn't automatically start creating the necessary code, you can prompt it to do so by using a prompt like "Go ahead and start building out the plan!". -> -> Creating the necessary updates will take several minutes. The agent edits and creates files, writes and runs tests, and iterates. Now's a good time to reflect on what you've explored so far, or to enjoy a beverage. +Only after the reviewed plan contains your requirements and all execution boundaries, select **Approve and implement with autopilot** in the plan approval controls, or the equivalent explicit Autopilot option shown in your version. Confirm the mode indicator shows **Autopilot**. -## Review the changes +Approval can start execution immediately. All implementation scope, safety rules, and stop boundaries must therefore be in the reviewed plan before you approve; do not rely on adding them in a follow-up message after execution starts. -All AI-generated code needs review before it's merged. Let's both review the code and run the site to ensure everything looks good. +Autopilot can write code and tests and iterate on failures, but this permission is not permission to complete later workshop modules. A missing prerequisite is a blocker to resolve with approval, not a passed check. -1. Select **Changes** in the upper right to open the code changes. +## Review and verify the implementation - ![The session panel tabs in the GitHub Copilot app with an arrow pointing to the Changes tab](../_images/app-select-changes.png) +1. Open **Changes** and inspect the filtering implementation and tests. +2. Compare the result with the issue and approved clarifications, including multiple categories and publisher combinations. Check that new or modified helpers follow the documentation standard from Lesson 3. +3. Inspect actual command output for all four npm checks. These run directly now because you have not created the quality-checks skill yet. +4. Resolve failures and rerun affected checks before accepting the implementation. Playwright's E2E configuration builds and serves a preview and can reuse a local server; make sure the tested server belongs to this worktree, not an earlier lesson. -2. Review the changes. You should see new TypeScript and Astro files, and test files. Notice the new helper functions include TSDoc doc comments and a file header comment — the documentation standard you merged in Lesson 3, applied automatically without being asked. -3. In the review panel on the right side of Copilot app, select **Terminal**. If there is no **Terminal** button, select the **+** (labeled as **Open in panel**), then select **Terminal**. +## Check the feature manually - ![The Terminal button in the review panel of the GitHub Copilot app](../_images/app-terminal-screenshot.png) +Return the session to **Interactive** mode before manual review and keep it there for Lesson 5. -4. Enter the following command in the terminal window to start the web app's dev server: +1. Open **Terminal** in this session's review panel. If needed, select **+**, then **Terminal**. +2. Confirm the terminal is in the filtering worktree and run: ```shell npm run dev ``` -5. Once the server starts (this will just take a moment), open a browser window. -6. Navigate to http://localhost:4321. -7. You should now see filters available on the landing page! -8. If anything doesn't look right, you can ask Copilot to make the updates! -9. Once satisfied, return to the terminal window. -10. Select Ctrl+C to stop the dev server. - -## Verify your work with the quality-checks skill +3. Open the URL printed by this server in your browser, normally `http://localhost:4321`. If the port is occupied, identify its owner instead of stopping an unrelated process or assuming the existing server contains your changes. +4. Exercise category selection, publisher selection, and their combination against the approved behavior. Check keyboard access and the agreed clearing and empty-result behavior. +5. If anything fails, request a focused correction, review the diff, rerun affected automated checks, and repeat the relevant browser checks. +6. Return to the terminal and press Control+C (Mac) or Ctrl+C (Windows/Linux) to stop the server you started. Confirm it stopped before the next module's E2E run. -You could eyeball the diff and call it done, but the team has a defined quality bar — and a repeatable way to check it. +This is your manual browser observation. Agent-driven browser observation through MCP comes in Lesson 6. -**Agent skills** let you give Copilot guidance on how to perform repeatable tasks like running tests, generating builds, or creating pull requests. 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 works across Copilot Chat in agent mode, Copilot cloud agent, Copilot CLI, and the GitHub Copilot app. +## Save a checkpoint -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: +After reviewing the changes and verification, authorize a local commit: -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +Review the current diff and create a checkpoint commit for the filtering implementation and its tests. Keep this same filtering branch and worktree. Do not create skills or agents, configure MCP, push, or open a pull request. ``` -Skills can also include subfolders with scripts, assets, and reference material. The full structure is covered in the [agent skills specification][agent-skills-spec]. - -> [!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. - -## Explore the quality-checks skill - -Let's explore the skill to see what it does. - -1. If the review panel is not already visible, open it by selecting **Toggle review panel** in the upper right. - - ![The GitHub Copilot app top toolbar with an arrow pointing to the Toggle review panel button to the right of Create PR](../_images/app-2-review-panel.png) - -2. Select the **+** to add a new item to the review panel. -3. Select **File**. -4. Search for `SKILL.md`. -5. Select `SKILL.md .github/skills/quality-checks` from the list of files to open it. -6. Note the `name` and `description`. The description tells the agent *when* to use it — whenever code changes need to be tested, linted, or verified before a commit, push, or merge. -7. Read through the skill. Notice it documents which script runs which suite (unit tests, Playwright end-to-end tests, ESLint), in what order, and how to debug common failures — so the agent runs the checks the team's way instead of guessing. - -## Run the checks - -In the same filtering session, ask the agent to verify the work. You won't name the skill — the agent will match it from your request. - -1. Return to Copilot app. -2. Directly call the skill by using the slash command `/quality-checks` and select Enter. -3. Following the skill, the agent runs the unit tests, the linter, and the end-to-end tests, and reports the results. If anything fails, ask it to fix the issue and run the checks again until everything is green. -4. **Keep this session open.** In the next lesson you'll add the Playwright MCP server and use it to see the filtering feature working in a real browser. - ## Summary and next steps -You built a real feature end to end and verified it against the team's bar! Specifically, you: - -- started a fresh session from the filtering issue on an up-to-date project. -- used Plan mode to plan the feature and Autopilot to build it. -- confirmed the generated helper followed the documentation standard you merged in Lesson 3. -- verified your work with the `quality-checks` skill. - -Next, you'll connect the Playwright MCP server and ask the agent to explore your filtering feature in a real browser. Continue to [Lesson 5 - Testing with the Playwright MCP server][next-lesson]. +You've agreed the filtering requirements, reviewed the implementation and tests, and checked the feature manually. This checkpoint is part of PR 3, not a separate PR. Stay in **Interactive** mode in the same session for [Lesson 5 - Create and use a quality-checks skill][next-lesson]. ## Resources - [Working with agent sessions in the GitHub Copilot app][agent-sessions] -- [About Agent Skills][about-agent-skills] -- [Customizing the GitHub Copilot app][customize-app] - [About cloud and local sandboxes for GitHub Copilot][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification diff --git a/docs/app/5-agent-skills.md b/docs/app/5-agent-skills.md new file mode 100644 index 00000000..812bdb5b --- /dev/null +++ b/docs/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +title: "Lesson 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-09-11 +--- + +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 Lessons 4–8; this lesson does not create a pull request. + +In this lesson, 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 + +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. + +## Instructions, scripts, and resources + +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. + +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. + +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. + +## Create the skill + +Switch the filtering session back to **Interactive** mode using the mode selector 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. + +```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. + +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. + +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. + +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. +``` + +## Inspect the skill + +1. Open **Changes** to review the generated files. You can also use the review panel's **+**, **File**, then search for `SKILL.md` or the script filenames. +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. + +> [!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. + +## Run the skill + +Confirm the development server from the previous lesson 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. + +If the app 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. + +```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. + +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. + +## Save a checkpoint + +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 + +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 Lesson 8. Continue in this same session to [Lesson 6 - Validate functionality with Playwright MCP][next-lesson]. + +## More skill examples + +These community examples are references, not additional tasks. Review their prerequisites and behavior before adopting them: + +- [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]. + +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-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/app/5-mcp-playwright.md b/docs/app/5-mcp-playwright.md deleted file mode 100644 index 202d83bd..00000000 --- a/docs/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Lesson 5 - Testing with the Playwright MCP server" -description: "Add the Playwright MCP server to the GitHub Copilot app and ask the agent to manually test your filtering feature in a real browser." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -In the previous lesson you created and verified the filtering feature with the project's automated test suite. Tests automate validation of code, but allowing the agent to confirm behavior is powerful. It allows an agent to respond to issues it sees in the actual UI it's creating. Let's explore how MCP allows access to external capabilities to AI agents, and add the Playwright MCP server to allow Copilot to interact with the site you're building directly. - -In this lesson, you will: - -- understand what Model Context Protocol (MCP) is and how the GitHub Copilot app uses it. -- add the Playwright MCP server from the app settings. -- ask the agent to drive a browser and explore your filtering feature. - -## Scenario - -While unit and end-to-end tests are important, validating updates to the UI requires actually interacting with the UI. You want to allow Copilot to use the website you're working on as a user would to further automate how changes are made, providing more confidence the updates perform as expected. - -## What is Model Context Protocol (MCP)? - -[Model Context Protocol (MCP)][mcp-blog-post] 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][playwright-mcp-server]**: 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] -> 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. - -## Add the Playwright MCP server - -You add and manage MCP servers from the app settings. The app includes a catalog of popular servers, so the [Playwright MCP server][playwright-mcp-server] is just a couple of clicks away. - -1. Select Ctrl+, to open the Copilot app settings page. -2. Select **MCP servers**. -3. In the search dialog, type `Playwright`. -4. Select **Playwright** from the list of **Popular MCP servers**. -5. Select **Add server** to add it to the list of available MCP servers. -6. Select Esc to close the settings dialog. - -You've now added the Playwright MCP server! - -## Ask Copilot to explore the feature via Playwright - -Let's ask Copilot to test the feature manually by using the Playwright MCP server. - -1. Use the following prompt to ask Copilot to validate the new functionality: - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -Copilot will launch a browser through the Playwright MCP server, walk through each step, and report back what it found. You'll actually see it open a browser on your system to perform the tasks! - -2. 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. -3. Leave this session open as we're going to close it out in the next lesson! - -Copilot has now also validated the functionality in the browser by exploring the feature like a user would. - -## Summary and next steps - -Congratulations, you used the Playwright MCP server to explore your feature in a real browser from the GitHub Copilot app! To recap, you: - -- learned what Model Context Protocol (MCP) is and how the app makes MCP tools available. -- added the Playwright MCP server from the app settings. -- asked the agent to drive a browser and explore your filtering feature. - -Your feature is built, verified, and seen working. Now it's time to ship it — using **Agent Merge** to open and merge the pull request for you. Continue to [Lesson 6 - Merging with Agent Merge][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] -- [Configuring MCP servers in the GitHub Copilot app][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/app/6-agent-merge.md b/docs/app/6-agent-merge.md deleted file mode 100644 index 55aff8bb..00000000 --- a/docs/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Lesson 6 - Merging with Agent Merge" -description: "Open the filtering pull request, review it in My work, and let Agent Merge fix what's blocking it and merge it for you — the top rung of the merge-automation ladder." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Your filtering feature is built, verified, and seen working in a browser. The last step is to merge it. You've merged twice already in this harness — both times you opened the pull request and merged it yourself on github.com. This time you'll let the app do the heavy lifting with **Agent Merge**, which shepherds a pull request through its whole lifecycle from inside the app. - -In this lesson, you will: - -- learn what Agent Merge is and how it automates the merge lifecycle. -- enable Agent Merge on your filtering session. -- watch it create the pull request, run CI, and merge when everything is green. - -## Scenario - -Over the last few modules you've explored various levels of automation, from creating code to allowing Copilot to validate a UI directly. To further speed development, Tailspin Toys would like to see if there's a way pull requests that have been vetted and validated can automatically be merged. - -## Introducing Agent Merge - -**Agent Merge** allows automation of the last mile of landing a pull request via Copilot app. When you enable it, the app's session reads your pull request, addresses what's blocking it — fixing failing CI checks, responding to review comments, rebasing when needed — and merges it as soon as GitHub allows. It runs in the background, survives app restarts, and turns itself off once your pull request is merged. - -Up to this point you've been the one clicking **Merge pull request** on github.com. Agent Merge shifts that responsibility to the agent so you can move on to the next task while it shepherds the PR through to completion. You still review and approve the work — the agent just handles the mechanical finish line. - -## Use Agent Merge to manage the PR - -You've reviewed the code manually, run tests, and even allowed Copilot to validate the UI. Now it's time to merge the new code into the codebase! Let's allow agent merge to shepherd the PR through continuous integration (CI) and to merge. - -1. Return to the session you had open from the previous module where you were adding filtering functionality. -2. In the upper right-hand corner, select the dropdown next to **Create PR**. -3. Select **Agent merge** to enable agent merge. - - ![The Create PR dropdown in the GitHub Copilot app expanded, with an arrow pointing to the Agent merge option](../_images/app-enable-agent-merge.png) - -4. The button text now changes to **Agent merge**. -5. Select the **Agent merge** button to start the agent merge process. - -Copilot app then begins the process of creating and managing the PR! It starts by exploring the project to determine how best to create a PR, followed by creating the new PR. - -After a few moments, you'll notice Copilot starts work again, looking at the PR conditions - the CI process of running all the tests on your repository. It will report back status on any reviews left by other team members, any checks that need to run (the CI process), and if the PR is mergeable. - -6. Allow agent merge to merge the pull request by selecting the dropdown next to **Agent merge** then **Merge pull request**. - - ![The Agent merge dropdown showing the agent's allowed actions — Address reviews, Fix CI failures, Resolve conflicts — with an arrow pointing to Merge pull request](../_images/app-agent-merge-merge.png) - -7. Once all CI processes are green (meaning the tests passed), Copilot will merge the pull request! - -## Summary and next steps - -You've automated several parts of the development process, including generating code, testing and validating code, and now the pull request process. You: - -- learned what Agent Merge is and how it automates the merge lifecycle. -- enabled Agent Merge on your filtering session. -- watched it create the pull request, run CI, and merge when everything was green. - -Next, you'll explore **canvases** — a richer way to plan and visualize work with the agent. Continue to [Lesson 7 - Planning with canvases][next-lesson]. - -## Resources - -- [Managing issues and pull requests with the GitHub Copilot app][managing-issues-prs] -- [About the GitHub Copilot app][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/6-mcp-playwright.md b/docs/app/6-mcp-playwright.md new file mode 100644 index 00000000..df028912 --- /dev/null +++ b/docs/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "Lesson 6 - Validate functionality with Playwright MCP" +description: "Configure Playwright MCP through Customize and observe filtering in a browser in the existing feature worktree." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +In the previous lesson you packaged and ran the project's checks through your quality-checks skill. Now give the agent access to a browser so it can observe the filtering UI directly. Stay in the same filtering session, worktree, and branch. This lesson adds browser evidence, not another feature, full test-suite run, or PR. + +In this lesson, you will: + +- understand what Model Context Protocol (MCP) is and how the GitHub Copilot app uses it. +- add the Playwright MCP server through **Customize**. +- ask the agent to drive a browser and explore your filtering feature. + +## Scenario + +While unit and end-to-end tests are important, validating updates to the UI requires actually interacting with the UI. You want to allow Copilot to use the website you're working on as a user would to further automate how changes are made, providing more confidence the updates perform as expected. + +## What is Model Context Protocol (MCP)? + +[Model Context Protocol (MCP)][mcp-blog-post] 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][playwright-mcp-server]**: 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] +> 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. + +## Add the Playwright MCP server + +The current [App customization documentation][customize-app] uses **Customize** in the sidebar for MCP discovery and management. MCP servers configured for your repositories or Copilot CLI can already be available in the App; inspect installed servers before adding a duplicate. + +1. Select **Customize** in the sidebar. +2. Select **MCP**, then check **Installed** for an existing Playwright server. +3. If needed, find **Playwright** among the available servers, or use the custom-server flow documented by the publisher. +4. Review the publisher, configuration, and any installation prompts before approving them. Follow the prompts to add the server; organization policy or missing prerequisites can block setup. +5. Return to the existing filtering session, keeping **Interactive** mode. Confirm Playwright MCP browser tools are available before asking for validation. Do not create a new feature worktree as a setup workaround. + +If setup fails, resolve the configuration or permission issue rather than accepting a claim that the agent browsed without tools. Browser visibility depends on the server configuration; actual tool activity and observations are the evidence. + +## Ask Copilot to explore the feature via Playwright + +Use the actual issue URL and approved clarifications saved in Lesson 4. Stop any manual dev server from earlier lessons before the agent starts its own. It must identify the checkout and server it is testing. + +1. Use the following prompt to ask Copilot to validate the new functionality: + + ```plaintext + Use the configured Playwright MCP server to observe the filtering feature against this issue: . These are my approved planning clarifications: . Stay in this filtering worktree and branch. + + Identify the checkout, start its dev server, and use actual browser tools to exercise the required multiple-category selection, publisher filtering, combined filtering, accessible controls, and any agreed clearing or empty-result behavior. Report observations against the criteria, including failures or blocked checks. Do not claim behavior you did not observe. + + This step is browser observation, not another full automated test run. Do not change application code, tests, skills, or agent profiles, commit, push, or create a PR. Report missing MCP tools or prerequisites as blocked and ask before installing anything. Do not reuse another checkout's server or stop unrelated processes. Stop only the server you started when finished. + ``` + +Inspect the Playwright MCP tool calls, the URL under test, and the reported browser observations. A narrative based only on source code or earlier E2E results does not demonstrate MCP. + +2. Read the summary against the issue and approved clarifications. If there is a defect, authorize a focused fix separately, review the changed diff, and repeat relevant automated checks and browser observations. Evidence from before the fix is not proof of the resulting revision. +3. Confirm the agent stopped its own server. Keep this filtering session open and remain in **Interactive** mode before creating the QA profile in Lesson 7. + +This stage establishes direct observation, not a replacement for automated coverage. A failure or blocked observation remains visible for QA. + +## Summary and next steps + +Congratulations, you used the Playwright MCP server to explore your feature in a real browser from the GitHub Copilot app! To recap, you: + +- learned what Model Context Protocol (MCP) is and how the app makes MCP tools available. +- configured the Playwright MCP server through **Customize**. +- asked the agent to drive a browser and explore your filtering feature. + +Next, bring the requirements, browser observations, coverage, and skill together with a specialist profile. Continue in this same session to [Lesson 7 - Create and use a QA agent][next-lesson]. Do not create the feature PR yet. + +## Resources + +- [What the heck is MCP and why is everyone talking about it?][mcp-blog-post] +- [Microsoft Playwright MCP Server][playwright-mcp-server] +- [Configuring MCP servers in the GitHub Copilot app][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/app/7-canvases.md b/docs/app/7-canvases.md deleted file mode 100644 index 223552db..00000000 --- a/docs/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Lesson 7 - Planning with canvases" -description: "Create a shared, agent-driven canvas in the GitHub Copilot app to plan and track your work alongside the agent." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -So far you've directed agents through chat. But a lot of work doesn't live in a conversation — it lives on a board, in a document, or on a checklist. **Canvases** give you and the agent a shared surface for exactly that kind of work, right inside the app. In this lesson you'll create a simple canvas to plan and track the backlog you've been working through. - -In this lesson, you will: - -- understand what a canvas is and when to use one. -- create a shared Kanban board canvas to triage your backlog. -- save the canvas to your repository and merge it for the team. -- open the canvas in a new session and start work from it. - -## Scenario - -Looking at a list of issues can be rather daunting, even in the best of times. Tailspin Toys' developers have been looking for a tool that would allow them to quickly triage issues, and begin work on them in Copilot app. - -## What is a canvas? - -A [canvas][canvas-docs] is a shared, interactive surface for a work artifact — a plan, a triage board, a release checklist, a dashboard, or a document. While chat is great for describing intent and reasoning through ambiguity, most work happens on a *surface*. Canvases let you collaborate with the agent directly on that surface. - -Canvases are **bidirectional**: the agent can update the canvas while it works, and you can edit the same surface yourself. When you create a canvas, the agent builds it based on your prompt and workflow, and you can ask it to add, remove, or revise capabilities as you go. Once created, a canvas opens in the app's right side panel. - -Some common examples include: - -- **Markdown canvases** for planning your day and prioritizing issues and pull requests. -- **Agentic kanban boards** where people and agents add cards and move work across columns. -- **Issue triage boards** that summarize top issues and recurring themes for a repository. - -## Why use a canvas? - -Reach for a canvas when a task needs structure, iteration, and verification, and a chat alone isn't enough. A canvas lets you: - -- ground the agent's work in an actual artifact that fits your workflow. -- steer or correct work directly on the shared surface, then let the agent continue from your changes. -- inspect progress as visible changes to an artifact, not just chat responses. - -## Create a canvas to track your work - -You've shipped a lot: the star rating, the documentation standard, and the filtering feature are all merged. But there's still items on the backlog. Let's create the canvas to help quickly triage the work. - -1. Return to (or open) the GitHub Copilot app. -2. Select the **Home screen**. -3. Ensure `tailspin-toys` is selected for the repo. -4. In the prompt box, use the following prompt to create our canvas that meets our needs: - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -Copilot will get to work on creating the canvas! - -> [!NOTE] -> This will take a few minutes for it to do so. Because this is a complicated task, you might not be satisfied with the first version. You can continue to prompt to build the tool of your dreams! - -## Save the canvas and merge it to the repository - -Canvases can become assets in the repository, just like instructions files and skills. Let's ask Copilot to add it to our repository and merge it so the whole team can use it. - -1. In the same session, ask Copilot to save the canvas to the repository by using the following prompt: - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Once Copilot has saved the canvas files, select the dropdown next to **Create PR** in the upper right-hand corner. -3. Select **Agent merge** to enable agent merge. - - ![The Create PR dropdown in the GitHub Copilot app expanded, with an arrow pointing to the Agent merge option](../_images/app-enable-agent-merge.png) - -4. The button text now changes to **Agent merge**. -5. Select the **Agent merge** button to start the agent merge process. - -Copilot app begins the process of creating and managing the PR. It starts by exploring the project to determine how best to create a PR, then creates it. - -After a few moments, you'll notice Copilot starts work again, looking at the PR conditions — the CI process of running all the tests on your repository. It will report back status on any reviews left by other team members, any checks that need to run (the CI process), and if the PR is mergeable. - -6. Allow agent merge to merge the pull request by selecting the dropdown next to **Agent merge** then **Merge pull request**. - - ![The Agent merge dropdown showing the agent's allowed actions — Address reviews, Fix CI failures, Resolve conflicts — with an arrow pointing to Merge pull request](../_images/app-agent-merge-merge.png) - -7. Wait for all CI processes to pass (go green). Once they do, Copilot will merge the pull request automatically! - -You've now created a new shared canvas for your team! - -## Work in the canvas - -With the canvas created, let's start a new session and put it to work! - -1. Inside the Copilot app, start a new session by selecting **New session** next to **tailspin-toys**. -2. Ask Copilot to open the triage canvas by using the following prompt: - - ```plaintext - Open the triage issues canvas - ``` - -3. You should notice the canvas you built is now open in this new session! -4. Select **Add to current context** on one of the issues that's of most interest to you. -5. Copilot gets to work on the issue! - -You've now used a canvas you created to streamline the development process. - -## Summary and next steps - -You created a shared surface where you and the agent can collaborate! You: - -- learned what canvases are and when to use them. -- created a shared Kanban triage board canvas with the agent. -- saved and merged the canvas to your repository with Agent Merge. -- opened the canvas in a new session and used it to start work. - -With your backlog tracked, take a step back to review everything you've built and where to go next. Continue to [Lesson 8 - Review and next steps][next-lesson]. - -## Resources - -- [Working with canvas extensions in the GitHub Copilot app][canvas-docs] -- [Canvases on Awesome Copilot][awesome-copilot-canvases] -- [About the GitHub Copilot app][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/7-qa-agent.md b/docs/app/7-qa-agent.md new file mode 100644 index 00000000..c3b330c7 --- /dev/null +++ b/docs/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +title: "Lesson 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-14 +--- + +In the previous lessons, you built a quality-checks skill and gave Copilot a browser through Playwright MCP. Now bring those capabilities together with a **QA custom agent** that reviews the filtering feature against its requirements. + +In this lesson, you will: + +- understand how a custom agent works with instructions, skills, and MCP tools. +- create and inspect a reusable QA profile. +- select the QA agent and review its findings against the filtering issue. +- save the profile and any justified tests for the feature PR. + +## Scenario + +Tailspin Toys is preparing to ship category and publisher filtering. The automated checks and browser exploration have given the team useful evidence, but passing tests alone cannot show whether every agreed requirement is covered. Before opening the PR, the team wants a focused review of what was requested, what was built, and what still needs attention. + +You'll create a QA agent that starts from the issue and your approved planning decisions, checks coverage, and uses the skill and browser tools to gather evidence. Its job is to identify gaps and explain whether the feature is ready for review, not to approve its own work or merge the PR. + +## What is a custom agent? + +A custom agent is a reusable specialist role defined in a Markdown profile. Its instructions shape how Copilot approaches a task; selecting the profile applies that role to your conversation. For this workshop, you'll define the role in `.github/agents/qa.agent.md` and select it in the app. + +The customizations you've built have different jobs. Repository instructions describe the team's standards. The quality-checks skill packages repeatable checks. Playwright MCP supplies browser tools. The QA profile tells Copilot how to use those capabilities to assess requirements and report findings. It doesn't replace them or require another agent session. + +## Create the QA profile + +Continue in the filtering session from Lesson 6, keeping the same worktree and branch. Confirm the session is in **Interactive** mode, the quality-checks skill is present, and Playwright MCP is available. The feature PR comes in Lesson 8; this lesson adds a profile and, only where needed, tests. + +Send the following prompt to the ordinary Copilot agent. You'll inspect the resulting file before selecting QA: + +```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 + +1. Open **Changes** and select `.github/agents/qa.agent.md`. You can also find it through the file review panel. +2. Read the frontmatter. `description` is required, and `name: QA` makes the profile recognizable in the picker. Leave `model` and `tools` unspecified for this exercise so the selected model and available tools are used; normal permissions still apply. +3. Read the instructions as a review checklist: do they start from requirements, use the skill and browser tools, add tests only for real gaps, and distinguish failures from blocked checks? +4. Ask Copilot to correct any gaps before selecting the profile. Confirm it created the definition without starting QA or changing the application. + +> [!NOTE] +> A specialist profile guides behavior; it does not guarantee a correct result. You'll still inspect the agent's tool activity, test changes, and report. + +## Run QA against the issue + +The run prompt is for the selected **QA** custom agent, not the default agent reading a profile. Keep the same filtering checkout and branch. + +1. In the current session, open the agent picker in the prompt box, or enter `/agent`, as described in the [app customization documentation][customize-app]. +2. Select **QA** and verify that the app visibly identifies **QA** as the active agent before sending the run prompt. +3. If **QA** is not listed or you cannot confirm it is active, pause and ask your facilitator while retaining this worktree and branch. Do not create a new feature session, invent a reload sequence, or substitute a request for the default agent to read `qa.agent.md`. + +The documented picker is available during a session, but discovery of a newly created repository profile can depend on your app version. Do not treat writing the file as proof of activation. + +Replace both placeholders with the actual filtering issue URL and the clarifications approved in Lesson 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 + +Read the report alongside the filtering issue and your approved clarifications: + +1. Check that each criterion is connected to appropriate tests and observable behavior. For example, combining categories and a publisher needs evidence about the returned games, not just whether the controls respond. +2. Inspect actual Playwright MCP tool activity and confirm the tested server belongs to this checkout. Browser checks and automated E2E must not reuse a stale server or another checkout. +3. Review results for lint, unit tests, E2E tests, and type checks. All four must run through the quality-checks skill's scripts; a summary of planned commands is not execution. +4. Open **Changes** to inspect any added tests and compare them with the gaps in the report. + +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 + +QA's role is verification, so return to the ordinary agent before requesting a commit: + +1. Keep the QA report, issue URL, approved clarifications, and tested revision available for the PR lesson. +2. In the same session, use the agent picker to return to the ordinary Copilot agent and confirm **QA** is no longer selected. +3. Keep the same worktree and branch. If you cannot find the ordinary-agent choice, ask your facilitator rather than starting another feature session or issuing commit instructions to QA. + +When you have reviewed the profile, any test changes, and the resulting evidence, send the checkpoint request to the ordinary agent with that QA context: + +```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 added a reusable specialist role to the workflow and reviewed its work. In this lesson, you: + +- created and inspected a QA profile that starts from requirements. +- selected it to assess coverage and gather evidence through the skill and Playwright MCP. +- reviewed the findings and saved the profile with any justified test changes on the filtering branch. + +You now have the pieces for a feature review: the implementation, skill, QA profile, tests, and verification report. Carry any unresolved findings forward; a failed or blocked result is not merge approval. Continue to [Lesson 8 - Create and merge the feature PR][next-lesson] to review the complete milestone and use Agent Merge. + +## Resources + +- [Customizing the GitHub Copilot app, including selecting custom agents][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/app/8-create-pull-request.md b/docs/app/8-create-pull-request.md new file mode 100644 index 00000000..e9c24660 --- /dev/null +++ b/docs/app/8-create-pull-request.md @@ -0,0 +1,89 @@ +--- +title: "Lesson 8 - Create and merge the feature PR" +description: "Review filtering, the skill, QA profile, and tests together, create PR 3, and explicitly authorize Agent Merge." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Your filtering implementation, quality-checks skill, QA profile, and associated tests are checkpointed on one branch. Review them together and use the current QA evidence to prepare PR 3. You have already explicitly merged the star-rating and instructions PRs. This time you'll use **Agent Merge** within the PR workflow, not as a separate feature or branch. + +In this lesson, you will: + +- learn what Agent Merge is and how it automates the merge lifecycle. +- inspect the full feature PR and verification evidence. +- authorize Agent Merge only after review, and confirm the PR is merged. + +## Scenario + +Over the last few modules you've explored various levels of automation, from creating code to allowing Copilot to validate a UI directly. To further speed development, Tailspin Toys would like to see if there's a way pull requests that have been vetted and validated can automatically be merged. + +## Introducing Agent Merge + +**Agent Merge** allows automation of the last mile of landing a pull request via Copilot app. When you enable it, the app's session reads your pull request, addresses what's blocking it — fixing failing CI checks, responding to review comments, rebasing when needed — and merges it as soon as GitHub allows. It runs in the background, survives app restarts, and turns itself off once your pull request is merged. + +Up to this point you've selected **Merge pull request** yourself. Agent Merge can take on that responsibility, but its ability to edit code and merge still needs your explicit authorization. Review its allowed actions and the work before granting merge permission. + +## Review the complete milestone + +Stay in the filtering session from Lessons 4–7. Check the full branch diff against `main`, not just the latest checkpoint: it should contain filtering, `.github/skills/quality-checks/SKILL.md`, the bundled scripts, `.github/agents/qa.agent.md`, and the associated tests. + +Use the agent picker to return from **QA** to the general Copilot agent before requesting commits or PR actions, and keep **Interactive** mode. The QA profile's job was verification, not shipping. Changing the selected agent must not change the filtering session, checkout, or branch. + +This workshop deliberately combines feature work and reusable quality infrastructure in one PR. A production team might split those concerns; here, checkpoint commits preserve reviewable steps without stacked branches or extra PRs. + +Review Lesson 7's QA report. Reuse its evidence only if it covers the final revision being submitted, with all four checks and the relevant browser observations completed. If code changes, conflicts, or CI fixes alter what was tested, rerun affected checks and browser observations and update the evidence. A failed or blocked **NO-GO** report is not merge approval. + +Once the diff and evidence are ready, send: + +```plaintext +Review the full filtering branch diff against main, including the filtering feature, quality-checks skill and scripts, QA agent definition, and associated tests. Summarize the issue criteria, approved clarifications, and current QA evidence. Reuse verification only if it still applies to the final revision; report stale, missing, or failing evidence before proceeding. + +If the reviewed changes and verification are ready, commit any remaining approved milestone changes, push this branch, and create one feature PR targeting main using the repository's PR template and the actual filtering issue URL. Keep the checkpoint history on this branch. Do not use a contribution skill, create another branch or PR, or merge yet. +``` + +Open the PR in **My work** and inspect **Files changed**, its description, reviews, and check results. Inspect Tailspin Toys' own workflow files and required checks; do not assume every local check or browser observation runs in CI. The workshop publisher's Astro build and link checker belong to another repository and do not validate this feature. + +## Use Agent Merge to manage the PR + +After reviewing the existing PR, configure Agent Merge in this same session. Do not create a second PR. + +1. Return to the filtering session and confirm it is linked to PR 3. +2. Open the PR action dropdown in the upper right-hand corner. Before a PR exists, it is next to **Create PR**; the label can change once a PR is linked. +3. Select **Agent merge** to enable agent merge. +4. Review the available permissions, including **Address reviews**, **Fix CI failures**, **Resolve conflicts**, and **Merge pull request**. Leave merge permission off while findings or verification are unresolved. +5. Before starting it, send the following scope and authorization, then select **Agent merge**: + + ```plaintext + Manage this existing filtering PR with Agent Merge. Address review or CI blockers only within this PR's scope. Do not weaken tests or requirements, and ask before unrelated changes or installations. Any change to the tested revision requires updated relevant checks and browser evidence; do not treat older QA results as proof of changed code. + + Do not merge until I explicitly enable Merge pull request after reviewing the final diff and evidence. Do not create another PR or begin the canvas task. + ``` + +6. Review any follow-up changes and updated results. When the final diff is approved, required CI and reviews pass, and QA evidence applies to that revision, explicitly authorize merging by selecting the dropdown next to **Agent merge**, then **Merge pull request**. + + ![The Agent merge dropdown showing the agent's allowed actions — Address reviews, Fix CI failures, Resolve conflicts — with an arrow pointing to Merge pull request](../_images/app-agent-merge-merge.png) + +7. Confirm GitHub shows PR 3 as **Merged**, not merely mergeable or queued. Agent Merge does not bypass repository protections or missing permissions; resolve those blockers before continuing. + +Only after that merge should you start the canvas milestone. Lesson 9 creates a fresh worktree and fast-forwards its session branch to the latest `origin/main` so the canvas begins with the complete merged feature. + +## Summary and next steps + +You've automated several parts of the development process, including generating code, testing and validating code, and now the pull request process. You: + +- learned what Agent Merge is and how it automates the merge lifecycle. +- reviewed the complete filtering, skill, QA-profile, and test diff as PR 3. +- reused current QA evidence, inspected CI, and explicitly authorized Agent Merge. + +Next, you'll explore **canvases** — a richer way to plan and visualize work with the agent. Continue to [Lesson 9 - Create a triage canvas][next-lesson]. + +## Resources + +- [Managing issues and pull requests with the GitHub Copilot app][managing-issues-prs] +- [About the GitHub Copilot app][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/9-canvases.md b/docs/app/9-canvases.md new file mode 100644 index 00000000..72a8f0fe --- /dev/null +++ b/docs/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "Lesson 9 - Create a triage canvas" +description: "Create and review a repository-backed triage canvas, merge PR 4, and reopen it to add issue context without starting another feature." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +So far you've directed agents through chat. But a lot of work doesn't live in a conversation — it lives on a board, in a document, or on a checklist. **Canvases** give you and the agent a shared surface for exactly that kind of work, right inside the app. In this lesson you'll create a simple canvas to plan and track the backlog you've been working through. + +In this lesson, you will: + +- understand what a canvas is and when to use one. +- create a shared Kanban board canvas to triage your backlog. +- save the canvas to your repository and merge it for the team. +- reopen the canvas and add issue context without implementing another feature. + +## Scenario + +Looking at a list of issues can be daunting. Tailspin Toys' developers want a tool to triage issues and add their details to a session's context. Adding context is not authorization to implement an issue; this exercise ends with a reusable board, not a fifth PR. + +## What is a canvas? + +A [canvas][canvas-docs] is a shared, interactive surface for a work artifact — a plan, a triage board, a release checklist, a dashboard, or a document. While chat is great for describing intent and reasoning through ambiguity, most work happens on a *surface*. Canvases let you collaborate with the agent directly on that surface. + +Canvases are **bidirectional**: the agent can update the canvas while it works, and you can edit the same surface yourself. When you create a canvas, the agent builds it based on your prompt and workflow, and you can ask it to add, remove, or revise capabilities as you go. Once created, a canvas opens in the app's right side panel. + +Some common examples include: + +- **Markdown canvases** for planning your day and prioritizing issues and pull requests. +- **Agentic kanban boards** where people and agents add cards and move work across columns. +- **Issue triage boards** that summarize top issues and recurring themes for a repository. + +## Why use a canvas? + +Reach for a canvas when a task needs structure, iteration, and verification, and a chat alone isn't enough. A canvas lets you: + +- ground the agent's work in an actual artifact that fits your workflow. +- steer or correct work directly on the shared surface, then let the agent continue from your changes. +- inspect progress as visible changes to an artifact, not just chat responses. + +## Create a canvas to track your work + +Confirm PR 3 has merged. The star rating, documentation standard, filtering feature, quality skill, and QA profile must all be on `main` before starting the canvas. Use a fresh session and one branch for this final PR milestone. + +1. Return to (or open) the GitHub Copilot app. +2. Select the **Home screen**. +3. Ensure `tailspin-toys` is selected for the repo. +4. Choose a **new working tree** and **Interactive** mode. Send this baseline request before creating any files: + + ```plaintext + Prepare this fresh canvas session without implementing anything. Confirm this is a clean new worktree, fetch origin, and fast-forward the current session branch to origin/main. Report the checkout, branch, and matching HEAD and origin/main revisions. Verify the filtering PR is merged and the filtering feature, quality-checks skill, and QA profile are present. + + Stop if the checkout is dirty, diverged, or missing the prior merge. Do not reset, discard work, switch branches, or create another branch. Stop after reporting the baseline. + ``` + +5. Check the baseline report, then request the repository-backed canvas: + + ```plaintext + Create a basic repository-backed Kanban triage canvas for this repository using the App's supported canvas-extension workflow. Save its definition under .github/extensions/ so the team can reuse it. Inspect existing extensions and preserve them; do not overwrite the supplied database explorer. + + Read the current open issues. Highlight the three most likely to need attention, with the remainder below. Include each highlighted issue's title, content summary, URL, and a justification for its priority. Treat the ranking as a suggestion, not an instruction to change issues. + + Give every card an Add to current context action that attaches the issue details to this session only. It must not start implementation, create sessions or branches, change issue state, or create PRs. Keep the canvas bounded and keyboard-accessible. + + Show me the generated files and open the canvas for inspection. Do not change application code, commit, push, or create a PR. Ask before installing anything or adding dependencies. + ``` + +Copilot creates the canvas files and opens the shared surface. Review the generated extension before trusting its actions; it is executable repository content, not just a picture. + +> [!NOTE] +> If the first version needs work, request focused improvements within the triage scope. Do not turn this exercise into implementing one of the backlog issues. + +## Inspect and exercise the canvas + +1. Open **Changes** and confirm the canvas definition is repository-backed under `.github/extensions/`, not saved only for your user or session. Check that existing extensions and application files are unchanged. +2. Compare the board with the actual open issues and assess the ranking explanations. +3. Check that cards and controls are readable and usable with a keyboard. +4. Select **Add to current context** for an issue and confirm only its details enter the conversation. No implementation or issue-state change should start. +5. Review any corrections and ask Copilot to run the applicable existing validation for the files changed. Record results and blockers, rather than assuming an interactive surface is correct because it opened. + +## Save the canvas and merge it to the repository + +The canvas is already a repository asset. Commit and submit only the reviewed canvas work as PR 4: + +1. In the same session, send: + + ```plaintext + Review the repository-backed triage canvas diff and its validation evidence. Commit the approved canvas files on this session branch, push it, and create one PR targeting main using the repository's PR template. Describe the canvas behavior and how we verified that adding an issue only adds context. Do not merge yet or implement a backlog issue. + ``` + +2. Review the full PR diff and checks in **My work**. Confirm it contains the canvas, not unrelated application work. +3. In the same canvas session, open the PR action dropdown and select **Agent merge**. Review its allowed actions and keep **Merge pull request** off until you approve the final result. +4. Set the scope before starting Agent Merge: + + ```plaintext + Manage this existing canvas PR with Agent Merge. Address only in-scope review and CI blockers; ask before unrelated changes or installations. If the canvas changes, repeat its affected validation and update the evidence. Do not merge until I explicitly enable Merge pull request after review. Do not implement backlog issues or create another PR. + ``` + +5. Select **Agent merge** and review any follow-up changes. Inspect the learner repository's actual CI checks and resolve failures; CI is not a replacement for exercising the canvas. + +6. When the final diff and current evidence are approved and required checks and reviews pass, explicitly allow Agent Merge to merge by selecting its dropdown, then **Merge pull request**. + + ![The Agent merge dropdown showing the agent's allowed actions — Address reviews, Fix CI failures, Resolve conflicts — with an arrow pointing to Merge pull request](../_images/app-agent-merge-merge.png) + +7. Confirm GitHub shows PR 4 as **Merged** before continuing. + +You've now created a new shared canvas for your team! + +## Reopen the canvas without starting another feature + +Reopen the repository-backed canvas in the same canvas session after its PR is merged. This is an inspection step, not another branch or PR milestone. + +1. Return to the canvas session, keep **Interactive** mode, and close the canvas panel if it is still open. +2. Send: + + ```plaintext + Reopen the repository's triage canvas in this same session. I will add an issue to context to inspect its details only. Do not edit files, implement the issue, change its state, create another session or branch, commit, push, or open a PR. + ``` + +3. Confirm the saved canvas opens again without regenerating its definition. +4. Select **Add to current context** on one of the issues that's of most interest to you. +5. Confirm the selected issue's details appear in context without starting implementation. Stop there: the workshop has four PR milestones, not five. + +You've now used a canvas you created to streamline the development process. + +## Summary and next steps + +You created a shared surface where you and the agent can collaborate! You: + +- learned what canvases are and when to use them. +- created a shared Kanban triage board canvas with the agent. +- saved and merged the canvas to your repository with Agent Merge. +- reopened the merged canvas and added issue context without launching another feature. + +With your backlog tracked, take a step back to review everything you've built and where to go next. Continue to [Lesson 10 - Wrap-up and next steps][next-lesson]. + +## Resources + +- [Working with canvas extensions in the GitHub Copilot app][canvas-docs] +- [Canvases on Awesome Copilot][awesome-copilot-canvases] +- [About the GitHub Copilot app][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/app/README.md b/docs/app/README.md index 0f424ef9..2c07a60b 100644 --- a/docs/app/README.md +++ b/docs/app/README.md @@ -3,12 +3,14 @@ slug: app title: "GitHub Copilot app" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- The **[GitHub Copilot app](https://docs.github.com/copilot/concepts/agents/github-copilot-app)** is a desktop application built on Copilot CLI that brings agent-driven development into a single, focused workspace. It adds parallel agent sessions, switchable session modes, shared canvases, and native GitHub issue and pull request management — including **Agent Merge**, which shepherds a pull request through rebases, review feedback, CI fixes, and merge. -Across these lessons you'll install the app and set up your project, then get oriented in the app's workspace and the backlog the template seeded for you. You'll start with a small change — adding a star rating — then add a custom instructions standard from an issue, build a filtering feature in an isolated agent session, and verify it with a reusable skill. You'll add the Playwright MCP server to explore the feature in a real browser, then climb a ladder of merge automation that ends with **Agent Merge** landing your pull request. Finally you'll collaborate on a shared canvas and automate recurring work — a complete loop from idea to merged feature. +Setup Lessons 0–1 prepare your project and App workspace. The nine core modules, Lessons 2–10, begin with a star-rating quick win and a documentation convention demonstrated in real code. Then you'll plan and build filtering, create and execute a shell-bundled quality-checks skill, observe the feature through Playwright MCP, and create a QA custom agent to assess requirements and coverage. You'll review the complete feature PR and authorize Agent Merge, then create and merge a shared triage canvas. + +The workshop has four PR milestones: star ratings; instructions with their demonstration; filtering with the skill, QA profile, and tests; then the canvas. Start each milestone from updated `main`, using one branch per PR rather than one per module. Lessons 4–8 stay in the same filtering session, worktree, and branch. Reopening the canvas adds issue context without launching another feature or fifth PR. Automations are linked as a next step, not an additional exercise. ## Lessons @@ -16,13 +18,15 @@ Across these lessons you'll install the app and set up your project, then get or |--------|-------|-------------| | [0. Prerequisites][ex0] | Setup | Install Node.js and create your copy of the Tailspin Toys project | | [1. Install the Copilot app][ex1] | Setup | Install the app, connect your project, and get oriented in the workspace | -| [2. Running your first agent session][ex2] | First change | Start a session and ship a small change as your first pull request | -| [3. Guiding Copilot with custom instructions][ex3] | Context | Add a documentation standard from an issue and merge it | -| [4. Building a feature with Autopilot][ex4] | Core Feature | Use Plan and Autopilot to build filtering, then verify it with a skill | -| [5. Testing with Playwright MCP][ex5] | External Tools | Add the Playwright MCP server and explore your feature in a browser | -| [6. Merging with Agent Merge][ex6] | Merge | Let Agent Merge fix and land your filtering pull request | -| [7. Planning with canvases][ex7] | Collaboration | Create a shared canvas to plan and track your work | -| [8. Review and next steps][ex8] | Summary | Automate recurring tasks and explore what's next | +| [2. Add star ratings: a quick win][ex2] | First change | Display existing ratings and the null fallback, then merge PR 1 | +| [3. Guide Copilot with custom instructions][ex3] | Context | Add a documentation standard and a real demonstration, then merge PR 2 | +| [4. Build filtering with Plan and Autopilot][ex4] | Implementation | Approve the plan, implement and check filtering, and checkpoint | +| [5. Create and use a quality-checks skill][ex5] | Repeatable checks | Create, inspect, and execute bundled shell scripts | +| [6. Validate functionality with Playwright MCP][ex6] | Browser observation | Configure MCP through Customize and inspect filtering behavior | +| [7. Create and use a QA agent][ex7] | Requirements and coverage | Select a specialist profile and gather final verification evidence | +| [8. Create and merge the feature PR][ex8] | Review and merge | Review filtering, the skill, QA profile, and tests, then authorize Agent Merge for PR 3 | +| [9. Create a triage canvas][ex9] | Collaboration | Share a repository-backed canvas in PR 4 and add issue context | +| [10. Wrap-up and next steps][ex10] | Summary | Review the workflow, artifacts, and further resources | ## Prerequisites @@ -50,9 +54,11 @@ Before attending this workshop, please ensure you have: [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students diff --git a/docs/es-es/README.md b/docs/es-es/README.md index c57d5067..8faf6ff8 100644 --- a/docs/es-es/README.md +++ b/docs/es-es/README.md @@ -27,7 +27,7 @@ GitHub Copilot dentro de **Visual Studio Code** y GitHub Codespaces. Trabaja con ### 🤖 [Copilot App](app/) -La **aplicación GitHub Copilot** es una aplicación de escritorio basada en Copilot CLI. Ejecuta sesiones de agentes en paralelo, cambia el modo de las sesiones, colabora en lienzos y gestiona incidencias y solicitudes de incorporación de cambios de GitHub de forma nativa. También incluye **Agent Merge**, que guía una solicitud de incorporación de cambios durante los cambios de base, los comentarios de revisión, las correcciones de integración continua y la combinación. +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/) diff --git a/docs/es-es/app/0-prerequisites.md b/docs/es-es/app/0-prerequisites.md index b93e4997..676b584b 100644 --- a/docs/es-es/app/0-prerequisites.md +++ b/docs/es-es/app/0-prerequisites.md @@ -15,18 +15,18 @@ En esta lección: ## Instalar Node.js -En varias lecciones se pide a un agente que desarrolle funcionalidades y ejecute en local el conjunto de pruebas de Tailspin Toys, para lo que se necesita [**Node.js**][nodejs], el único entorno de ejecución que requiere el proyecto. Instala la versión **22 o posterior**; la versión **LTS** actual es una opción segura. +En varias lecciones se pide a un agente que desarrolle funcionalidades y ejecute en local el conjunto de pruebas de Tailspin Toys, para lo que se necesita [**Node.js**][nodejs]. Utiliza **Node.js 22.13 o posterior** y confirma la versión compatible en `package.json` y README de tu copia de trabajo. La opción más sencilla en cualquier plataforma es usar el instalador oficial: 1. En el sistema operativo, abre una ventana de terminal con Windows Terminal, Terminal de macOS o la aplicación que utilices habitualmente. -2. Ejecuta el comando siguiente para confirmar que tienes instalada la versión 22 de Node.js o una posterior: +2. Ejecuta el comando siguiente para confirmar que tienes instalado Node.js 22.13 o posterior: ```shell node --version ``` -3. Si aparece `v22` o un número superior, puedes pasar a la sección siguiente. +3. Si la versión indicada es al menos `v22.13.0` y es compatible con el proyecto, puedes pasar a la sección siguiente. > [!TIP] > Solo tienes que completar estos pasos si no tienes Node instalado o si necesitas actualizarlo. @@ -41,10 +41,10 @@ La opción más sencilla en cualquier plataforma es usar el instalador oficial: node --version ``` -9. Debería aparecer `v22.x.x` o una versión posterior. +9. Confirma que la versión indicada es al menos `v22.13.0` y es compatible con el proyecto. -> [!TIP] -> ¿Prefieres usar contenedores? Si tienes [**Docker**][docker], puedes utilizar el [contenedor de desarrollo][dev-containers] del repositorio en lugar de instalar Node.js en local; el contenedor ya incluye Node. No necesitas ambas opciones. +> [!IMPORTANT] +> Este recorrido de la aplicación utiliza worktrees locales. Un runtime instalado solo en un contenedor no está disponible para esas sesiones locales. Cada worktree también necesita las dependencias del proyecto y Chromium de Playwright para las comprobaciones E2E. Sigue el README del repositorio del participante al preparar un worktree y revisa cualquier solicitud de instalación antes de aprobarla. ## Configurar el repositorio del laboratorio @@ -64,6 +64,8 @@ Trabajarás con tu propia copia del proyecto Tailspin Toys. Créala ahora a part > [!NOTE] > Al crear el repositorio a partir de la plantilla, se genera automáticamente una lista de incidencias de trabajo pendiente. Trabajarás con estas incidencias durante todo el taller; no necesitas crear ninguna. +Utiliza una copia nueva de la plantilla revisada: incluye instrucciones del repositorio, código de la aplicación, pruebas y una extensión de lienzo existente, pero no incluye agentes personalizados ni habilidades. Crearás tu propia habilidad quality-checks y un perfil QA durante el taller. Si utilizas una copia anterior, examina las personalizaciones existentes en lugar de sobrescribirlas. + ## Resumen y pasos siguientes Ya tienes el entorno preparado. Has instalado Node.js para poder compilar y probar el proyecto en tu equipo y has creado tu propia copia del repositorio Tailspin Toys a partir de la plantilla. @@ -79,7 +81,5 @@ A continuación, instalarás la aplicación GitHub Copilot, conectarás el repos [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/1-install-copilot-app.md b/docs/es-es/app/1-install-copilot-app.md index 212bdaee..049fe491 100644 --- a/docs/es-es/app/1-install-copilot-app.md +++ b/docs/es-es/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ Como cabe esperar, el primer paso para utilizar la aplicación GitHub Copilot es Con el proyecto conectado, dedica un momento a conocer el espacio de trabajo. La aplicación organiza todo en varias áreas de la barra lateral: -- **Sessions**: donde los agentes realizan su trabajo. Cada sesión se ejecuta en su propio espacio de trabajo aislado, por lo que puedes ejecutar varias a la vez sin que sus cambios entren en conflicto. Iniciarás tu primera sesión en la siguiente lección. +- **Sessions**: donde los agentes realizan su trabajo. En este taller, elige **new working tree** para que cada hito de PR tenga una copia de trabajo y una rama aisladas. Existen otras opciones de espacio de trabajo, pero no se utilizan aquí. - **Quick chats**: conversaciones ligeras para preguntas y lluvias de ideas que no necesitan una rama ni un espacio de trabajo propios. Probarás una al final de esta lección. - **My work**: tus incidencias y solicitudes de incorporación de cambios, disponibles mediante la **integración nativa con GitHub** de la aplicación. Desde aquí puedes examinar y filtrar incidencias y solicitudes de incorporación de cambios, comprobar el estado de CI, iniciar una sesión a partir de una incidencia y revisar solicitudes de incorporación de cambios, todo ello sin salir de la aplicación. -- **Automations**: tareas de agente guardadas que se ejecutan según una programación o bajo demanda. Crearás una casi al final de este recorrido. +- **Customize**: descubre y gestiona servidores MCP, habilidades y lienzos. Lo utilizarás para configurar MCP de Playwright. +- **Automations**: tareas de agente guardadas que se ejecutan según una programación o bajo demanda. El resumen final enlaza a ellas como siguiente paso, no como otro ejercicio del taller. ### Localizar la lista de trabajo pendiente inicial Como la aplicación se integra de forma nativa con GitHub, el trabajo pendiente del repositorio aparece directamente en ella. Cuando creaste el repositorio a partir de la plantilla, se generó una lista de incidencias. Vamos a comprobar que esté disponible. 1. Selecciona **My work** en la barra lateral. -2. La plantilla ha creado ocho incidencias en tu lista de trabajo pendiente. Este módulo se centra en las tres siguientes; confirma que puedes verlas: +2. Busca estas incidencias por su título en lugar de dar por hecho su número: - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. Selecciona una incidencia para leer sus detalles. Cada incidencia también sirve como punto de partida para una sesión de agente. Más adelante iniciarás el trabajo desde estas incidencias. +3. Selecciona una incidencia para leer sus detalles. Cada incidencia también sirve como punto de partida para una sesión de agente. Más adelante iniciarás el trabajo desde estas incidencias. Las demás incidencias pendientes aportan contexto al lienzo, no son otra tarea de implementación. > [!NOTE] > La lista de elementos de **My work** se filtra automáticamente para mostrar solo los elementos de los repositorios que has añadido a la aplicación Copilot. Para ver elementos de trabajo de otros repositorios, añádelos a la aplicación. @@ -70,7 +70,7 @@ Una buena forma de familiarizarse con la aplicación es utilizarla para conocer 2. Pregunta a la aplicación cómo funcionan sus sesiones: ```plaintext - How does the GitHub Copilot app use worktrees? + ¿Cómo utiliza la aplicación GitHub Copilot los worktrees? ``` 3. Lee la respuesta en la vista de conversación. Verás que cada sesión se ejecuta en su propio árbol de trabajo de Git aislado, lo que permite ejecutar varios agentes en paralelo sin que sus cambios entren en conflicto. Puedes continuar la conversación o iniciar un chat nuevo en cualquier momento. @@ -84,7 +84,13 @@ Has instalado la aplicación GitHub Copilot, conectado el proyecto y explorado e - familiarizarte con el espacio de trabajo y localizar la lista de trabajo pendiente inicial en **My work**. - utilizar un chat rápido para formular una pregunta breve y desechable. -A continuación, iniciarás tu primera sesión de agente y realizarás el primer cambio en el proyecto: mostrar una valoración por estrellas en las tarjetas de los juegos. Continúa con la [Lección 2 - Ejecutar tu primera sesión de agente][next-lesson]. +## Mantener separados los hitos de PR + +Combinarás cuatro PR: valoraciones por estrellas; instrucciones con una pequeña demostración; filtrado con la habilidad, el perfil QA y las pruebas; y, por último, el lienzo de clasificación de incidencias. Utiliza una rama por hito de PR. Las Lecciones 4–8 permanecen en la misma sesión, worktree y rama de filtrado, con commits de control en lugar de PR adicionales. + +Un worktree nuevo de la aplicación puede partir de un estado local desactualizado. Antes de editar archivos en cada hito nuevo, obtén los cambios del repositorio y actualiza la rama de la nueva sesión mediante un avance rápido hasta el último `origin/main`. Las lecciones siguientes lo muestran explícitamente. No apiles ramas, no selecciones commits de trabajos anteriores mediante cherry-pick ni cambies una sesión de filtrado activa a otra rama. + +A continuación, iniciarás tu primera sesión de agente y realizarás el primer cambio en el proyecto: mostrar una valoración por estrellas en las tarjetas de los juegos. Continúa con la [Lección 2 - Añadir valoraciones por estrellas: una mejora rápida][next-lesson]. ## Recursos @@ -92,7 +98,7 @@ A continuación, iniciarás tu primera sesión de agente y realizarás el primer - [Introducción a la aplicación GitHub Copilot][getting-started] - [Trabajar con sesiones de agente en la aplicación GitHub Copilot][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/es-es/app/10-review.md b/docs/es-es/app/10-review.md new file mode 100644 index 00000000..571468a1 --- /dev/null +++ b/docs/es-es/app/10-review.md @@ -0,0 +1,87 @@ +--- +title: "Lección 10 - Repaso y pasos siguientes" +description: "Repasa los nueve módulos principales de la aplicación, los cuatro hitos de PR y el flujo de calidad reutilizable, y explora otros recursos." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Durante las últimas lecciones, has llevado una funcionalidad desde la idea hasta la combinación mediante la aplicación GitHub Copilot. Entre otras cosas, has aprendido a: + +- conectar un repositorio y familiarizarte con el espacio de trabajo de la aplicación y la lista de trabajo pendiente inicial. +- iniciar sesiones desde una tarea directa y desde incidencias, y utilizar los modos Plan y Autopilot para controlar cómo trabaja el agente. +- orientar al agente con instrucciones personalizadas y después pedirle que cree una habilidad reutilizable con scripts de shell que has revisado y ejecutado para el linter, las pruebas unitarias, las pruebas de un extremo a otro y las comprobaciones de tipos. +- probar el trabajo con el servidor MCP de Playwright en un navegador real. +- crear y seleccionar un agente personalizado QA para evaluar requisitos, cobertura, resultados de scripts de la habilidad y pruebas de observación del navegador. +- colaborar con el agente en un lienzo compartido. +- combinar explícitamente las primeras PR personalmente y después autorizar **Agent Merge** dentro de los flujos de PR de la funcionalidad y el lienzo. + +Las Lecciones 0–1 de configuración dieron paso a nueve módulos principales, las Lecciones 2–10. Dedica un momento a repasar los recursos creados y cómo continuar; este resumen no inicia otra tarea práctica. + +## Qué has entregado + +El taller tiene cuatro hitos de PR, cada uno en su propia rama a partir de `main` actualizado: + +1. **Valoraciones por estrellas:** mostrar el `starRating` existente y un estado explícito sin valoración en las tarjetas de juegos. +2. **Instrucciones y demostración:** añadir la convención de documentación y verificar su efecto en un pequeño cambio de código real. +3. **Filtrado y flujo de calidad:** implementar la incidencia, crear la habilidad `quality-checks` con scripts de shell y el perfil QA e incluir las pruebas asociadas. +4. **Lienzo de clasificación guardado en el repositorio:** compartir un tablero que añada contexto de incidencias sin implementar automáticamente otra funcionalidad. + +Las Lecciones 4–8 utilizaron la misma sesión, worktree y rama de filtrado. Los commits de control conservaron el progreso dentro de la PR 3; las habilidades, la configuración MCP y QA no necesitaron ramas de funcionalidad independientes. Cada hito posterior comenzó solo después de combinar la PR anterior y actualizar la rama de la nueva sesión desde `origin/main`. + +## Distintos tipos de verificación + +Las primeras funcionalidades utilizaron las comprobaciones npm existentes. El filtrado añadió tu inspección manual en el navegador. La habilidad hizo repetibles las cuatro comprobaciones mediante scripts incluidos, MCP añadió observaciones directas del agente en el navegador y QA combinó requisitos y cobertura con la verificación final. La PR reutilizó las pruebas de QA solo mientras correspondían a la revisión enviada. + +Las pruebas añadidas deben cubrir carencias reales; una ejecución QA que no necesita pruebas nuevas puede ser correcta. Las herramientas ausentes, las comprobaciones omitidas y los fallos son bloqueos visibles, no resultados satisfactorios. Revisa el código y las pruebas de verificación antes de autorizar la combinación y actualiza las afectadas después de los cambios. + +## Procedimientos recomendados + +Al utilizar cualquier herramienta de IA, la infraestructura que la rodea determina la calidad de los resultados. En este taller has creado instrucciones, una habilidad y un perfil QA; revísalos y reutilízalos entre sesiones. Los agentes personalizados definen roles especializados e instrucciones, con herramientas disponibles según la configuración y los permisos del entorno; las habilidades agrupan instrucciones reutilizables para tareas, scripts ejecutables y recursos de apoyo que se cargan bajo demanda. Un agente personalizado también puede ejecutar scripts, incluidos los que forman parte de una habilidad. Confirma la ejecución real de los scripts y la selección del agente personalizado en lugar de confiar en una descripción convincente. + +Adapta el **modo y el modelo** a la tarea. Utiliza **Plan** para razonar sobre un enfoque antes de desarrollar, **Interactive** para mantener el control durante cambios concretos y **Autopilot** solo para tareas aisladas y bien delimitadas. Elige un modelo más rápido para las modificaciones rutinarias y otro más capaz, con mayor esfuerzo de razonamiento, para el trabajo complejo. + +El contexto sigue siendo tan importante como la infraestructura. Describir con claridad *qué* quieres crear, *por qué* y *cómo* cambia sustancialmente el resultado. Los chats rápidos son un buen lugar para delimitar una idea antes de dedicarle una sesión completa. + +## Más opciones para explorar + +Ya conoces el flujo de trabajo principal. Estas son algunas funcionalidades adicionales que merece la pena explorar: + +- **Quick chats** para preguntas rápidas y desechables que no necesitan una sesión completa. +- [**Automatizaciones**][using-automations] para tareas recurrentes o bajo demanda, como resumir el trabajo reciente. Revisa la programación, los permisos y el alcance antes de adoptar una; crear una automatización es un siguiente paso, no parte de este taller. +- **Rubber duck** para razonar sobre un problema y obtener comentarios pertinentes antes de desarrollar. +- [**Agentes personalizados**][custom-agents] para encapsular un rol, sus herramientas y sus instrucciones con el fin de realizar trabajo especializado y repetible. +- [`/chronicle`][chronicle] para generar una narración de lo sucedido en una sesión. +- [Usar tu propia clave (BYOK)][byok] para utilizar modelos de tu propio proveedor, incluidos modelos locales mediante Ollama, Foundry Local o LM Studio. +- [Entornos aislados en la nube][sandboxes] para ejecutar sesiones en un entorno aislado hospedado en GitHub. +- [Vínculos profundos][deep-links] para abrir la aplicación directamente en un repositorio, una sesión o una indicación. + +## Pasos siguientes + +La mejor forma de mejorar con cualquier herramienta es seguir utilizándola. Úsala para código de producción, proyectos personales o esa pequeña aplicación que llevas años pensando en crear. Comparte lo que aprendas con el equipo y aprende de sus experiencias. Y, como siempre, consulta la documentación. + +Para explorar más elementos del ecosistema de GitHub Copilot, consulta el [recorrido de VS Code][vscode-harness], el [recorrido de Copilot CLI][cli-harness] o el [recorrido del agente en la nube][cloud-harness]. + +## Recursos + +- [Acerca de la aplicación GitHub Copilot][about-copilot-app] +- [Introducción a la aplicación GitHub Copilot][getting-started] +- [Personalizar la aplicación GitHub Copilot][customize] +- [Utilizar automatizaciones][using-automations] +- [Trabajar con extensiones de lienzo][canvas-docs] +- [Acerca de los entornos aislados locales y en la nube][sandboxes] + +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app +[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started +[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app +[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes +[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle +[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents +[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models +[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/es-es/app/2-add-star-rating.md b/docs/es-es/app/2-add-star-rating.md index b10c330b..8a3cc1ef 100644 --- a/docs/es-es/app/2-add-star-rating.md +++ b/docs/es-es/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "Lección 2 - Ejecutar tu primera sesión de agente" +title: "Lección 2 - Añadir valoraciones por estrellas: una mejora rápida" description: "Inicia tu primera sesión de agente en la aplicación GitHub Copilot, realiza un pequeño cambio en las tarjetas de los juegos y combínalo como tu primera solicitud de incorporación de cambios." authors: - geektrainer @@ -22,7 +22,7 @@ Cada juego de Tailspin Toys puede tener una valoración por estrellas, que ya ap ## Anatomía de una sesión -Una **sesión** es una conversación con un agente que se ejecuta en su propio espacio de trabajo aislado. Cada sesión recibe un **árbol de trabajo y una rama de Git dedicados**, lo que permite ejecutar varias sesiones a la vez, por ejemplo, una para añadir una funcionalidad y otra para corregir un error, sin que sus cambios entren en conflicto. Las sesiones aparecen en la barra lateral agrupadas por repositorio; selecciona cualquiera de ellas para cambiar de sesión. +Una **sesión** es una conversación con un agente. En este taller eliges **new working tree**, lo que proporciona a la sesión una copia de trabajo y una rama dedicadas. Así se aísla cada hito de PR sin una rama distinta para cada lección. Las sesiones aparecen en la barra lateral agrupadas por repositorio; selecciona cualquiera de ellas para cambiar de sesión. Dentro de una sesión verás tres elementos: la **conversación** con el agente, la **actividad de las herramientas** del agente mientras explora y edita archivos, y la lista de **archivos modificados** con sus diferencias. @@ -36,16 +36,20 @@ Vamos a iniciar una sesión nueva para comenzar a explorar el proyecto e impleme ![Cuadro de indicaciones de la aplicación GitHub Copilot con el selector de repositorio establecido en tailspin-toys y el selector de modelo debajo](../../_images/app-2-start-session.png) -4. Utiliza la indicación siguiente para solicitar el cambio: +4. Elige **new working tree** y el modo **Interactive** debajo del cuadro de indicaciones. Utiliza la indicación siguiente para solicitar el cambio: ```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. + Antes de editar, identifica esta copia de trabajo y su rama, confirma que es un worktree nuevo y limpio, obtén los cambios de origin y actualiza la rama de esta sesión mediante un avance rápido hasta origin/main. Confirma que HEAD coincide con origin/main. Detente y explica el motivo si hay cambios pendientes, divergencias o no se puede actualizar; no restablezcas ni descartes trabajo. + + 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 ni cambies el modelo de datos. + + Sigue las instrucciones del repositorio, añade o actualiza las pruebas adecuadas y ejecuta las comprobaciones npm existentes pertinentes. Examina los requisitos previos y pregunta antes de instalar cualquier cosa. Informa de los archivos modificados y los resultados de las comprobaciones y después detente para que los revise. No crees commits, no envíes cambios, no abras una solicitud de incorporación de cambios ni implementes otra funcionalidad. ``` > [!NOTE] > Observa que la indicación contiene el nombre del archivo que Copilot debe actualizar. Aunque no es necesario especificar los archivos que Copilot debe incluir en su trabajo, orientarlo ayuda a que genere el código con rapidez y reduzca el uso de tokens. -5. Selecciona Enter para enviar la indicación a Copilot. +5. Pulsa Enter para enviar la indicación a Copilot. La aplicación Copilot comienza por crear un árbol de trabajo nuevo, una copia aislada del proyecto. Después explora el proyecto, localiza los archivos que debe actualizar para añadir la funcionalidad y crea el código necesario. Ya has añadido una nueva funcionalidad con la aplicación Copilot. @@ -76,7 +80,9 @@ Todos los cambios generados por IA deben revisarse antes de combinarlos, incluso ## Comprobar los cambios -No debemos limitarnos a leer el código y dar por hecho que funciona. También debemos probarlo visualmente. Para ello, iniciaremos la aplicación desde la terminal y confirmaremos que todo funciona. La aplicación Copilot incluye una terminal integrada. +Revisa los resultados de las comprobaciones automatizadas del agente antes de abrir un navegador. Confirma que las pruebas cubren un `starRating` numérico y la alternativa para `null`, mediante los scripts npm existentes del proyecto en lugar de una habilidad que aún no existe. Un requisito previo ausente o una comprobación omitida no cuentan como superados. + +Después examina la aplicación manualmente desde la terminal integrada de la sesión. Identifica el worktree antes de iniciar el servidor y no reutilices un servidor de otra copia de trabajo. 1. En el panel de revisión situado a la derecha de la aplicación Copilot, selecciona **Terminal**. Si no aparece el botón **Terminal**, selecciona **+** (con la etiqueta **Open in panel**) y, después, **Terminal**. @@ -89,26 +95,30 @@ No debemos limitarnos a leer el código y dar por hecho que funciona. También d ``` 3. Cuando se inicie el servidor, lo que solo tardará un momento, abre una ventana del navegador. -4. Ve a http://localhost:4321. -5. Ahora deberías ver valoraciones por estrellas en todos los juegos de la página de inicio. +4. Abre la URL local que muestra el servidor, normalmente `http://localhost:4321`. Si el puerto está ocupado, identifica a quién pertenece en lugar de detener un proceso ajeno. +5. Confirma que las tarjetas de juegos valorados muestran su puntuación sobre cinco. Si hay datos sin valoración, confirma que aparece **No rating yet**; de lo contrario, verifica el caso null mediante la prueba automatizada en lugar de afirmar que lo has observado. 6. Vuelve a la ventana de terminal. -7. Selecciona Ctrl+C para detener el servidor de desarrollo. +7. Pulsa Control+C (Mac) o Ctrl+C (Windows/Linux) para detener el servidor de desarrollo que has iniciado. ## Abrir y combinar tu primera solicitud de incorporación de cambios -El cambio tiene buen aspecto; ha llegado el momento de publicarlo. Pedirás al agente que abra una solicitud de incorporación de cambios y, después, la revisarás y combinarás en github.com. Por ahora, gestionarás este proceso de forma manual. En una próxima lección descubrirás cómo Copilot puede encargarse automáticamente de parte del trabajo. +El cambio tiene buen aspecto; ha llegado el momento de entregar la PR 1. Primero autoriza el commit y la PR por separado de la implementación: + +```plaintext +Revisa todas las diferencias del cambio de valoraciones por estrellas y sus pruebas, resume la verificación y crea un commit con los cambios revisados en la rama de esta sesión. Envía la rama y crea una solicitud de incorporación de cambios destinada a main con la plantilla de PR del repositorio. No la combines. +``` -1. En la esquina superior derecha, selecciona **Create PR**. +1. Abre el enlace de la PR creada en la sesión. Si la aplicación muestra una confirmación **Create PR**, selecciónala para aprobar la solicitud en lugar de crear una segunda PR. 2. Si se solicita, selecciona **Sign in with your browser** y sigue las indicaciones para autenticarte. 3. Copilot comenzará a crear la solicitud de incorporación de cambios. -Una vez creada, Copilot supervisará los flujos de trabajo del repositorio que deban ejecutarse. Después de unos instantes, el botón de la esquina superior derecha cambiará a **Ready to merge**. Esto indica que la solicitud está lista para combinarse. +Una vez creada la PR, examina todas sus diferencias y las comprobaciones en **My work**. Lee los resultados de los flujos de trabajo del repositorio del participante; espera a que se completen las comprobaciones y revisiones obligatorias y resuelve los fallos antes de combinar. **Ready to merge** no sustituye la revisión del cambio ni las pruebas de verificación locales. 4. Selecciona la burbuja **PR** situada justo encima del chat para abrir la solicitud en el panel de revisión. Puedes revisarla aquí según sea necesario. 5. Cuando esté lista, selecciona **Ready to merge**. 6. Selecciona **Merge pull request** en el nuevo cuadro de diálogo para combinar la solicitud. -Ya has publicado una nueva funcionalidad en el sitio web. +Confirma que la PR 1 se ha combinado en `main` antes de continuar. Combinar cambios en el repositorio del participante no despliega por sí solo un sitio web. La siguiente lección inicia un worktree nuevo y lo actualiza desde `origin/main` para que incluya esta PR. ## Resumen y pasos siguientes @@ -118,7 +128,7 @@ Has iniciado tu primera sesión de agente y publicado tu primer cambio. En concr - has indicado al agente que realice un cambio pequeño y específico en las tarjetas de los juegos. - has revisado el cambio en la vista de diferencias del espacio de trabajo. - has ejecutado la aplicación en local para confirmar la valoración por estrellas en el navegador. -- has abierto una solicitud de incorporación de cambios y la has combinado personalmente en github.com. +- has abierto la PR 1, revisado sus comprobaciones y autorizado explícitamente su combinación. A continuación, utilizarás la aplicación para añadir al repositorio un estándar de instrucciones personalizadas a partir de una de las incidencias de la lista de trabajo pendiente. Continúa con la [Lección 3 - Guiar a Copilot con instrucciones personalizadas][next-lesson]. @@ -128,7 +138,8 @@ A continuación, utilizarás la aplicación para añadir al repositorio un está - [Acerca de la aplicación GitHub Copilot][about-copilot-app] - [Gestionar incidencias y solicitudes de incorporación de cambios con la aplicación GitHub Copilot][managing-issues-prs] -[prior-lesson]: ../1-install-copilot-app/#instalar-y-configurar-la-aplicacion-github-copilot +[prior-lesson]: ../1-install-copilot-app/#instalar-y-configurar-la-aplicación-github-copilot +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/es-es/app/3-custom-instructions.md b/docs/es-es/app/3-custom-instructions.md index 3275c5e6..4c6be980 100644 --- a/docs/es-es/app/3-custom-instructions.md +++ b/docs/es-es/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "Lección 3 - Guiar a Copilot con instrucciones personalizadas" -description: "Utiliza la aplicación GitHub Copilot para añadir al repositorio un estándar de instrucciones personalizadas a partir de una incidencia de la lista de trabajo pendiente y combina el cambio como una solicitud de incorporación de cambios." +description: "Añade un estándar de documentación, demuéstralo en una pequeña función auxiliar o un componente existente y combina ambos como segunda solicitud de incorporación de cambios." authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- El contexto es fundamental al trabajar con IA generativa. Si una tarea debe realizarse de una forma concreta o Copilot necesita conocer información de fondo, conviene que ese contexto esté disponible. Una de las herramientas más potentes para proporcionarlo son los [archivos de instrucciones][instruction-files], que describen no solo *qué* código quieres, sino también *cómo* debe estructurarse. En esta lección añadirás un estándar de documentación al repositorio y lo harás como realizarás la mayor parte del trabajo a partir de ahora: comenzarás desde una incidencia de la lista de trabajo pendiente y dejarás que el agente realice el cambio. @@ -12,15 +12,17 @@ En esta lección: - explorarás cómo llegan al agente las instrucciones del repositorio y los archivos de instrucciones limitados por ruta. - iniciarás una sesión desde la incidencia sobre instrucciones de la lista de trabajo pendiente. -- pedirás al agente que añada un estándar de documentación a `.github/copilot-instructions.md`. -- revisarás el cambio y lo combinarás como una solicitud de incorporación de cambios. +- pedirás al agente que añada un estándar de documentación específico a los archivos de instrucciones adecuados del repositorio. +- demostrarás el estándar con un pequeño cambio de código real, lo validarás y combinarás la PR 2. ## Escenario Como cualquier buen equipo de desarrollo, Tailspin Toys dispone de directrices y requisitos para las prácticas de desarrollo. Entre ellos se incluyen: -- Se debe añadir documentación al código mediante comentarios de documentación TSDoc. -- El formato se debe documentar y aplicar mediante linting. +- Los comentarios deben explicar la intención y las decisiones no evidentes, en lugar de repetir lo que hace el código. +- Las funciones exportadas de `db/` y `src/lib/` deben documentar su propósito, parámetros y valores de retorno mediante TSDoc/JSDoc, incluido un argumento `db` inyectable cuando exista. +- Los componentes reutilizables de Astro deben documentar sus contratos de `Props`, y los comentarios deben mantenerse actualizados cuando cambie el código relacionado. +- Deben conservarse las directrices existentes de formato y lint. Mediante los archivos de instrucciones, garantizarás que Copilot disponga de la información adecuada para realizar las tareas conforme a estas prácticas. @@ -28,13 +30,13 @@ Mediante los archivos de instrucciones, garantizarás que Copilot disponga de la Las instrucciones personalizadas permiten proporcionar contexto y preferencias a Copilot para que comprenda mejor el estilo y los requisitos de programación. Esta potente funcionalidad ayuda a orientar a Copilot para obtener sugerencias y fragmentos de código más pertinentes. Puedes especificar las convenciones de programación, las bibliotecas e incluso los tipos de comentarios que prefieres incluir en el código. También puedes crear instrucciones para todo el repositorio o para tipos de archivo concretos, con contexto específico para una tarea. -Hay dos tipos de archivos de instrucciones: +El proyecto utiliza dos tipos de archivos de instrucciones: - `.github/copilot-instructions.md`, un único archivo de instrucciones que se envía a Copilot con **cada** solicitud del repositorio. Debe contener información del proyecto que sea pertinente para la mayoría de las solicitudes de chat o CLI enviadas a Copilot, como la pila tecnológica, una descripción general de lo que se está creando, procedimientos recomendados y otras directrices globales. - Los archivos `.github/instructions/*.instructions.md` se pueden crear para tareas o tipos de archivo concretos. Puedes utilizarlos para proporcionar directrices para lenguajes específicos, como TypeScript o Astro, o para tareas como crear un componente de interfaz de usuario o un nuevo conjunto de pruebas unitarias. > [!NOTE] -> Copilot admite otros estándares para incorporar instrucciones mediante AGENTS.md, CLAUDE.md y GEMINI.md, de modo que siempre disponga del contexto adecuado. +> Los demás formatos de instrucciones y su compatibilidad varían según el entorno. Consulta la [referencia de compatibilidad de instrucciones personalizadas][custom-instructions-support] antes de depender de un formato concreto. ### Procedimientos recomendados para gestionar archivos de instrucciones @@ -74,49 +76,55 @@ Dedica un momento a leer los archivos de instrucciones incluidos en este reposit 11. Por último, abre `.github/instructions/drizzle.instructions.md` y desplázate hasta el final. Observa los vínculos a otros archivos de instrucciones, como `unit-tests.instructions.md`, y a archivos existentes del proyecto. De este modo puedes dividir conjuntos de instrucciones grandes en archivos más pequeños y reutilizables, y señalar a Copilot ejemplos que debe seguir al generar código. Las rutas 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 programación 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 comentarios de cabecera de archivo. +> Compara las directrices existentes con la incidencia real de estándares de programación antes de añadir reglas. Esta lección se centra en comentarios que explican la intención, documentación de funciones exportadas de la capa de datos y contratos de `Props` de Astro, no en cabeceras obligatorias para todos los archivos ni en comentarios que repiten el código. ## Empezar desde la incidencia sobre instrucciones -En la lección anterior iniciaste una sesión con una indicación directa. Sin embargo, la mayor parte del trabajo comienza con una incidencia. Vamos a crear una sesión basada en una incidencia presentada para actualizar los archivos de instrucciones y, después, solicitaremos la actualización. +Confirma que la PR 1 está combinada antes de crear esta sesión. Inicia un worktree nuevo para la PR 2; no continúes en la rama de valoraciones por estrellas. La mayor parte del trabajo comienza con una incidencia, así que utiliza la de estándares de programación para aportar los requisitos. > [!NOTE] > Como los archivos de instrucciones influyen mucho en el código que genera Copilot, debes asegurarte de que lo orienten con claridad. Pedir a Copilot que cree una primera versión, como harás en esta lección, es un buen enfoque, siempre que después la revises para confirmar que las actualizaciones cumplen tus requisitos. 1. Selecciona **My work** en la barra lateral. 2. Selecciona la incidencia titulada **Update our repository coding standards** para abrirla. -3. Selecciona **New session** en la esquina superior derecha para iniciar una sesión basada en la incidencia. +3. Selecciona **New session** en la esquina superior derecha, elige **new working tree** y selecciona el modo **Interactive**. ![Vista de una incidencia en la aplicación GitHub Copilot con una flecha que señala el botón New session de la esquina superior derecha](../../_images/app-new-session-from-issue.png) -4. Utiliza la indicación siguiente para pedir a Copilot que actualice los archivos de instrucciones de acuerdo con los requisitos documentados en la incidencia: +4. Utiliza la siguiente indicación. Actualizar la rama de la nueva sesión antes de editar hace que el último `main` combinado sea el punto de partida real, aunque la copia local de la aplicación estuviera desactualizada: - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + Antes de editar, identifica esta copia de trabajo y su rama, confirma que es un worktree nuevo y limpio, obtén los cambios de origin y actualiza la rama de esta sesión mediante un avance rápido hasta origin/main. Confirma que HEAD coincide con origin/main e incluye la PR de valoraciones por estrellas combinada. Detente si hay cambios pendientes, divergencias o falta esa combinación; no restablezcas, no descartes trabajo ni crees otra rama. + + Lee la incidencia "Update our repository coding standards" y las instrucciones existentes del repositorio. Añade una convención de documentación específica: explica la intención en lugar de la mecánica; documenta las funciones exportadas de db/ y src/lib/ con TSDoc/JSDoc que cubra propósito, parámetros, valores de retorno y argumentos db inyectables cuando existan; 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, sin duplicaciones ni contradicciones, y enlaza o resume el estándar actualizado en README. Conserva las directrices existentes de formato y lint. No exijas cabeceras para todos los archivos, no migres herramientas de formato, no reescribas la documentación de toda la aplicación ni implementes el filtrado. Muéstrame las diferencias de las instrucciones y después detente para que las revise. No crees una habilidad o un agente, no crees commits, no envíes cambios ni crees una PR. + ``` Copilot realizará las actualizaciones. ## Revisar el cambio -Vamos a leer las actualizaciones de Copilot y también a pedirle un ejemplo del código que generará a partir de las instrucciones actualizadas. +Lee las directrices actualizadas y demuestra su efecto en un archivo real. Un fragmento propuesto por sí solo no demuestra que las instrucciones del repositorio hayan influido en un cambio de código. 1. Selecciona **Changes** en la esquina superior derecha para abrir los cambios de código. ![Pestañas del panel de sesión de la aplicación GitHub Copilot con una flecha que señala la pestaña Changes](../../_images/app-select-changes.png) -2. Revisa el archivo de instrucciones actualizado. Confirma que contiene las directrices para añadir documentación y comentarios al código. +2. Revisa los archivos de instrucciones actualizados y la referencia en README. Confirma que las reglas coinciden con la filosofía de comentarios, la documentación de funciones exportadas y los contratos de componentes de la incidencia, sin inventar un requisito general de cabeceras de archivo. > [!NOTE] > Como la IA es probabilística y no determinista, el texto exacto puede variar. -3. Utiliza la indicación siguiente para pedir a Copilot que cree un ejemplo del código que generará ahora: +3. Tras revisar las instrucciones, solicita una demostración acotada en esta misma sesión: + + ```plaintext + Demuestra la convención de documentación actualizada en una pequeña función auxiliar exportada de TypeScript existente en db/ o src/lib/, o en un componente reutilizable de Astro. Examina el repositorio para elegir un archivo existente adecuado; no des por hecho que existe una función auxiliar de editores. Realiza una pequeña mejora de legibilidad que conserve el comportamiento y aplica las directrices pertinentes de documentación de funciones o contratos de Props. Explica las intenciones no evidentes sin añadir comentarios que se limiten a repetir el código. - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + Limita el cambio a esa demostración y las pruebas directamente relacionadas. No implementes el filtrado ni crees una funcionalidad nueva. Ejecuta las comprobaciones npm existentes pertinentes, informa de lo que ha cambiado y de cómo la instrucción ha influido en el código y detente para que lo revise. Pregunta antes de instalar cualquier cosa. No crees commits, no envíes cambios ni crees una PR. + ``` -4. Revisa el código que propone Copilot. Observa los comentarios de documentación TSDoc y el comentario de cabecera de archivo que incluye, exactamente lo que solicitan las instrucciones actualizadas. +4. Revisa las diferencias reales del archivo, no solo la respuesta del chat. Comprueba que la documentación explica el comportamiento real y que la mejora de legibilidad lo conserva. Revisa los resultados pertinentes de pruebas, lint y comprobaciones de tipos; resuelve los fallos antes de continuar. Ya has actualizado los archivos de instrucciones del proyecto y has comprobado el efecto que tendrán. @@ -124,17 +132,23 @@ Ya has actualizado los archivos de instrucciones del proyecto y has comprobado e Los archivos de instrucciones pasan a ser recursos del repositorio y, por tanto, se comparten con el resto del equipo. Vamos a crear una solicitud de incorporación de cambios con nuestro trabajo, igual que haríamos con cualquier otro recurso. -1. En la esquina superior derecha, selecciona **Create PR**. +Primero autoriza conjuntamente las instrucciones y la demostración revisadas: + +```plaintext +Revisa todas las diferencias de las instrucciones de estándares de programación, la referencia en README y la demostración de código acotada, incluidas las pruebas relacionadas. Resume la verificación y crea un commit con estos cambios revisados en la rama de esta sesión. Envía la rama y crea una única solicitud de incorporación de cambios destinada a main, con la plantilla de PR del repositorio y un enlace a la incidencia de estándares de programación. Descríbela como contribución parcial salvo que se cumplan todos los criterios de aceptación de la incidencia; no utilices palabras clave de cierre para trabajo incompleto. No la combines. +``` + +1. Abre el enlace de la PR en la sesión. Si la aplicación muestra una confirmación **Create PR**, selecciónala sin crear una PR duplicada. 2. Si se solicita, selecciona **Sign in with your browser** y sigue las indicaciones para autenticarte. 3. Copilot comenzará a crear la solicitud de incorporación de cambios. -Una vez creada, Copilot supervisará los flujos de trabajo del repositorio que deban ejecutarse. Después de unos instantes, el botón de la esquina superior derecha cambiará a **Ready to merge**. Esto indica que la solicitud está lista para combinarse. +Examina todas las diferencias de la PR en **My work**, incluidos los cambios de instrucciones y código. Revisa los resultados de CI del repositorio del participante y las revisiones obligatorias. Resuelve los fallos antes de seleccionar **Ready to merge**; CI no sustituye la demostración ni tu revisión. 4. Selecciona **Ready to merge**. 5. Selecciona **Merge pull request** en el nuevo cuadro de diálogo para combinar la solicitud. > [!NOTE] -> Una vez combinado el estándar en la rama predeterminada, pasa a formar parte del proyecto para todo el equipo y para cada sesión nueva. Cuando inicies la sesión de filtrado de la siguiente lección desde una rama predeterminada actualizada, el agente seguirá este estándar automáticamente. Verás que el código TypeScript que genera incluye comentarios de documentación TSDoc sin que se lo pidas: una demostración pequeña pero real de cómo las instrucciones determinan el código generado. +> Confirma que la PR 2 se ha combinado en `main` antes de empezar el filtrado. Un worktree nuevo por sí solo no garantiza código actualizado: en la Lección 4 obtendrás los cambios y actualizarás la rama de la nueva sesión mediante un avance rápido hasta `origin/main`, y verificarás que ambas combinaciones anteriores están presentes antes de planificar. ## Resumen y pasos siguientes @@ -142,10 +156,10 @@ Has explorado cómo la aplicación obtiene contexto de los archivos de instrucci - has explorado el archivo `copilot-instructions.md` del repositorio y los archivos `*.instructions.md` limitados por ruta. - has iniciado una sesión desde la incidencia sobre instrucciones de la lista de trabajo pendiente. -- has pedido al agente que añada un estándar de documentación a `.github/copilot-instructions.md`. -- has revisado el cambio y lo has combinado como una solicitud de incorporación de cambios. +- has pedido al agente que añada reglas de documentación específicas a los archivos de instrucciones adecuados y las referencie desde README. +- has examinado el efecto del estándar en un cambio de código real, validado el resultado y combinado ambos como PR 2. -A continuación, crearás la funcionalidad de filtrado en una sesión nueva y comprobarás cómo adopta el estándar que acabas de combinar. Continúa con la [Lección 4 - Crear una funcionalidad con Autopilot][next-lesson]. +A continuación, crearás la funcionalidad de filtrado en una sesión nueva y comprobarás que sigue el estándar que acabas de combinar. Continúa con la [Lección 4 - Crear el filtrado con Plan y Autopilot][next-lesson]. ## Recursos @@ -154,6 +168,7 @@ A continuación, crearás la funcionalidad de filtrado en una sesión nueva y co - [Procedimientos recomendados para crear instrucciones personalizadas][instructions-best-practices] - [Awesome Copilot: colección de archivos de instrucciones y otros recursos][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/es-es/app/4-build-filtering.md b/docs/es-es/app/4-build-filtering.md index 39105d16..d802226d 100644 --- a/docs/es-es/app/4-build-filtering.md +++ b/docs/es-es/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "Lección 4 - Crear una funcionalidad con Autopilot" -description: "Utiliza los modos Plan y Autopilot de la aplicación GitHub Copilot para crear una funcionalidad de filtrado estática en el cliente, comprobar que hereda el estándar de documentación y verificarla con una habilidad de agente." +title: "Lección 4 - Crear el filtrado con Plan y Autopilot" +description: "Planifica el filtrado desde su incidencia, aprueba Autopilot explícitamente, valida con las comprobaciones npm existentes y una visita manual al navegador, y guarda un punto de control." authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -Hasta ahora hemos realizado un par de pequeñas actualizaciones en el proyecto. Sin embargo, los cambios más amplios requieren un proceso más sólido. La aplicación GitHub Copilot está diseñada para integrarse en nuestro flujo actual y garantizar que creemos lo correcto de la forma adecuada. Esta es la primera de tres lecciones en las que seguirás un proceso de desarrollo habitual: empezarás por utilizar una incidencia para generar una funcionalidad nueva y una habilidad de agente para ejecutar las pruebas de validación y los linters. +Has combinado las valoraciones por estrellas y el estándar de documentación con su demostración en código. Ahora crea la funcionalidad de filtrado. Este es el inicio de un hito de PR más amplio: mantén esta misma sesión, worktree y rama durante las Lecciones 4–8. En esta lección: -- iniciarás una sesión nueva desde la incidencia sobre filtrado. -- utilizarás el modo **Plan** para planificar la funcionalidad y, después, **Autopilot** para crearla. -- confirmarás que el código generado sigue el estándar de documentación que combinaste anteriormente. -- verificarás el trabajo con la habilidad `quality-checks` del proyecto. +- partirás de `main` actualizado y leerás la incidencia real de filtrado. +- resolverás los requisitos en modo **Plan** antes de aprobar explícitamente **Autopilot**. +- revisarás el filtrado y las pruebas y después ejecutarás las cuatro comprobaciones npm existentes. +- visitarás la funcionalidad manualmente en un navegador y guardarás un punto de control. + +La habilidad, la validación MCP, el perfil QA y la PR de la funcionalidad llegarán en módulos posteriores. No los crees durante este paso de implementación. ## Escenario -La página de inicio muestra todos los juegos, pero los visitantes no pueden restringir la lista. La incidencia sobre filtrado solicita que puedan filtrar los juegos por **categoría** y **editor**. Vamos a utilizar Copilot para implementar esta funcionalidad. +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. -## Contexto +## Modos de sesión -Introducir agentes de programación con IA en el flujo de desarrollo no cambia los principios fundamentales. De hecho, adquieren aún más importancia. La mayoría de los desarrolladores siguen un flujo similar al siguiente: +El selector de modo situado debajo de la indicación controla la autonomía del agente: -1. Abrir una incidencia que detalle lo que debe hacerse. -2. Crear un plan de lo que debe desarrollarse. -3. Crear y revisar el código. -4. Ejecutar las pruebas para validar el código. -5. Validar manualmente la nueva funcionalidad. -6. Crear una solicitud de incorporación de cambios (PR). -7. Una vez revisado el código y completado correctamente el proceso de integración continua, combinarlo. +- **Interactive** te mantiene al tanto mientras el agente trabaja y solicita información. +- **Plan** prepara un plan para revisarlo antes de la implementación. +- **Autopilot** implementa e itera de forma autónoma dentro del alcance y los permisos aprobados. -> [!NOTE] -> Los detalles concretos variarán según el equipo y la organización, pero la mayoría de los procesos serán una variante del flujo anterior. +Planifica primero, aprueba de forma explícita y vuelve a Interactive antes de crear personalizaciones reutilizables. -Al mantener este enfoque estándar, te aseguras de que el código generado por IA cumpla los requisitos establecidos y pase por el mismo proceso de validación que el código escrito manualmente. +## Partir de main actualizado -## Modos de sesión +Confirma que la PR 1 y la PR 2 están combinadas en GitHub. Crea un worktree nuevo para el filtrado en lugar de continuar en cualquiera de las ramas anteriores. -El **modo de sesión** controla el grado de autonomía del agente. Puedes establecerlo en el menú desplegable situado debajo del campo de indicaciones y cambiarlo en cualquier momento: +1. Selecciona **My work** y busca **Allow users to filter games by category and publisher** por su título. Ábrela y copia su URL real; los números de incidencia varían entre repositorios. +2. Selecciona **New session** y elige **new working tree**. Mantén el modo **Interactive** para actualizar el estado inicial. -- **Interactive**: trabajas junto con el agente. El agente sugiere cambios y espera tus indicaciones antes de continuar. -- **Plan**: el agente crea primero un plan. Revisas y apruebas el plan antes de que el agente lo ejecute. -- **Autopilot**: el agente trabaja de forma totalmente autónoma, escribe código, ejecuta pruebas e itera sin esperar indicaciones. + ![Vista de una incidencia en la aplicación GitHub Copilot con una flecha que señala el botón New session](../../_images/app-new-session-from-issue.png) -## Planificar la funcionalidad de filtrado +3. Envía esta solicitud de preparación antes de planificar o editar: -El mejor momento para detectar un posible problema es antes de escribir código, y una breve planificación previa es la mejor forma de hacerlo. Al planificar con Copilot, le pedirás que genere una serie de pasos y documente el enfoque que seguirá. Después podrás revisar el plan y proponer mejoras antes de permitir que Copilot genere el código a partir de él. - -Vamos a abrir la incidencia, iniciar una sesión nueva y crear un plan. Para ello, cambiaremos al modo Plan y enviaremos la solicitud. + ```plaintext + Prepara esta nueva sesión de filtrado sin implementar nada. Identifica la copia de trabajo y la rama, confirma que el worktree está limpio, obtén los cambios de origin y actualiza la rama de esta sesión mediante un avance rápido hasta origin/main. Confirma que HEAD coincide con origin/main e incluye las PR combinadas de valoraciones por estrellas y estándares de programación. -1. Selecciona **My work** en la pestaña de navegación. -2. Selecciona la incidencia titulada **Allow users to filter games by category and publisher**. -3. Selecciona **New session** en la esquina superior derecha. + Detente y explica el motivo si hay cambios pendientes, divergencias o falta cualquiera de las combinaciones. No restablezcas ni descartes trabajo, no cambies de rama, no crees otra rama ni edites archivos de la aplicación. Informa de la revisión de partida. + ``` - ![Vista de una incidencia en la aplicación GitHub Copilot con una flecha que señala el botón New session de la esquina superior derecha](../../_images/app-new-session-from-issue.png) +4. Comprueba el estado inicial comunicado. Obtener los cambios no actualiza por sí solo el worktree: la rama de la sesión actual debe avanzar mediante un avance rápido y su `HEAD` debe coincidir con el `origin/main` obtenido antes de empezar a trabajar. -4. Selecciona Shift+Tab hasta que el modo muestre **Plan**. +## Planificar la funcionalidad de filtrado - ![Cuadro de indicaciones de la aplicación GitHub Copilot con una flecha que señala el selector de modo establecido en Plan](../../_images/app-4-plan-mode.png) +Cambia el selector de modo a **Plan**. Sustituye el marcador de posición de la incidencia por la URL que has copiado. -5. Envía la indicación siguiente. La incidencia sobre filtrado ya está en el contexto de esta sesión porque la has iniciado desde ella: +```plaintext +Planifica la funcionalidad de filtrado a partir de esta incidencia: . Lee todos sus criterios de aceptación y las instrucciones del repositorio y después examina la aplicación estática de Astro actual, sus funciones auxiliares de acceso a datos y sus pruebas existentes. No implementes nada todavía. - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +Cubre la selección de varias categorías, el filtrado por editor, la combinación de categorías y editor, las funciones auxiliares de acceso a datos adecuadas, los controles accesibles y la cobertura unitaria y de un extremo a otro que exige la incidencia. Pregúntame para resolver comportamientos no especificados, como la combinación de varias categorías, el borrado de filtros y los resultados vacíos, en lugar de inventar requisitos sin decirlo. No introduzcas una API de servidor a menos que los requisitos y la arquitectura existente lo justifiquen. -6. El agente puede plantear preguntas de seguimiento mientras crea el plan. Respóndelas según cómo desarrollarías la funcionalidad. +Propón un plan de implementación y verificación acotado que siga la convención de documentación del repositorio y añada o actualice las pruebas unitarias y de un extremo a otro necesarias. Tras confirmar los comandos en package.json, planifica la ejecución de npm run lint, npm run test:unit, npm run test:e2e y npm run typecheck:all con las herramientas existentes del proyecto. Registra la URL de la incidencia y mis aclaraciones aprobadas en el plan para que pueda reutilizarlas en QA. -> [!NOTE] -> Como Copilot es probabilístico, las preguntas de seguimiento exactas pueden variar. Incluso es posible que no formule ninguna. Es completamente normal. +Incluye estas medidas de seguridad de ejecución en el plan antes de que lo apruebe: identifica la copia de trabajo y el servidor que se prueban; examina los requisitos previos antes de ejecutar las comprobaciones; pregunta antes de instalar software, dependencias o navegadores; no reutilices el servidor de otro worktree; detén solo los servidores que hayas iniciado; e informa de otros conflictos de puerto en lugar de detener procesos ajenos. Los requisitos previos ausentes y las comprobaciones omitidas deben comunicarse como bloqueos, no como comprobaciones superadas. -7. Cuando termine, Copilot ofrecerá un resumen del plan. Revísalo. Debería proponer crear consultas, añadir controles de filtrado y, por supuesto, pruebas. Si quieres, proporciona comentarios para perfeccionarlo; el agente incorporará las sugerencias en una versión nueva. +Incluye este límite de implementación en el plan: después de que apruebe explícitamente Autopilot, implementa solo la funcionalidad de filtrado acordada y sus pruebas en este mismo worktree y rama, ejecuta las cuatro comprobaciones, informa de la implementación y de todos los resultados, incluidos fallos o bloqueos, y después detente para que revise el trabajo y lo compruebe manualmente en el navegador. No crees habilidades ni agentes personalizados, no configures MCP, no cambies de rama, no crees commits, no envíes cambios ni abras una PR durante la implementación. La comprobación manual del navegador y el commit de punto de control tendrán lugar después, bajo mis instrucciones por separado. -## Crear la funcionalidad con Autopilot +Por ahora, mantén el modo Plan y detente con el plan para que lo revise. No implementes, no crees habilidades ni agentes personalizados, no configures MCP, no cambies de rama, no crees commits, no envíes cambios ni abras una PR. +``` -Con el plan preparado, vamos a dejar que Copilot cree la implementación. +Responde a las preguntas aclaratorias y revisa el plan frente a la incidencia. Busca los cambios de acceso a datos, los controles accesibles y las pruebas, en lugar de aceptar una implementación solo de interfaz. Guarda la URL real de la incidencia y las aclaraciones aprobadas del plan para las Lecciones 6 y 7; utiliza `none` cuando no hagan falta criterios adicionales. -1. En la lista de opciones del cuadro de diálogo **Plan summary**, selecciona la opción más parecida a **Approve and implement with autopilot**. +Antes de aprobar, confirma que el propio plan contiene las cuatro comprobaciones, la convención de documentación, las medidas de seguridad sobre requisitos previos y servidores, el requisito de mantener el mismo worktree y rama y la parada tras la implementación y la verificación. Debe prohibir las habilidades, agentes y configuración MCP posteriores, los commits, los envíos de cambios y las PR durante la implementación. Si falta algún límite, solicita un plan revisado mientras sigues en modo **Plan** y examina la revisión antes de aprobar. -Copilot comenzará a trabajar en la implementación. +## Aprobar Autopilot explícitamente -> [!NOTE] -> Si Copilot no empieza a crear automáticamente el código necesario, puedes pedírselo con una indicación como "Go ahead and start building out the plan!". -> -> Las actualizaciones necesarias tardarán varios minutos. El agente edita y crea archivos, escribe y ejecuta pruebas e itera. Es un buen momento para repasar lo que has explorado hasta ahora o tomar algo. +Solo cuando el plan revisado contenga tus requisitos y todos los límites de ejecución, selecciona **Approve and implement with autopilot** en los controles de aprobación del plan, o la opción explícita de Autopilot equivalente de tu versión. Confirma que el indicador de modo muestra **Autopilot**. -## Revisar los cambios +La aprobación puede iniciar la ejecución inmediatamente. Por tanto, todo el alcance de implementación, las reglas de seguridad y los límites de parada deben estar en el plan revisado antes de aprobar; no confíes en añadirlos mediante un mensaje posterior cuando la ejecución ya haya empezado. -Todo el código generado por IA debe revisarse antes de combinarlo. Vamos a revisar el código y ejecutar el sitio para comprobar que todo funciona correctamente. +Autopilot puede escribir código y pruebas e iterar sobre los fallos, pero este permiso no autoriza a completar módulos posteriores del taller. La falta de un requisito previo es un bloqueo que debe resolverse con aprobación, no una comprobación superada. -1. Selecciona **Changes** en la esquina superior derecha para abrir los cambios de código. +## Revisar y verificar la implementación - ![Pestañas del panel de sesión de la aplicación GitHub Copilot con una flecha que señala la pestaña Changes](../../_images/app-select-changes.png) +1. Abre **Changes** y examina la implementación del filtrado y las pruebas. +2. Compara el resultado con la incidencia y las aclaraciones aprobadas, incluidas las combinaciones de varias categorías y editores. Comprueba que las funciones auxiliares nuevas o modificadas siguen el estándar de documentación de la Lección 3. +3. Examina la salida real de los comandos de las cuatro comprobaciones npm. Ahora se ejecutan directamente porque aún no has creado la habilidad quality-checks. +4. Resuelve los fallos y repite las comprobaciones afectadas antes de aceptar la implementación. La configuración E2E de Playwright compila y sirve una vista previa y puede reutilizar un servidor local; asegúrate de que el servidor probado pertenece a este worktree, no a una lección anterior. -2. Revisa los cambios. Deberías ver nuevos archivos de TypeScript y Astro, además de archivos de prueba. Observa que las nuevas funciones auxiliares incluyen comentarios de documentación TSDoc y un comentario de cabecera de archivo: el estándar de documentación que combinaste en la Lección 3, aplicado automáticamente sin solicitarlo. -3. En el panel de revisión situado a la derecha de la aplicación Copilot, selecciona **Terminal**. Si no aparece el botón **Terminal**, selecciona **+** (con la etiqueta **Open in panel**) y, después, **Terminal**. +## Comprobar la funcionalidad manualmente - ![Botón Terminal del panel de revisión de la aplicación GitHub Copilot](../../_images/app-terminal-screenshot.png) +Vuelve al modo **Interactive** antes de la revisión manual y mantenlo para la Lección 5. -4. Introduce el comando siguiente en la ventana de terminal para iniciar el servidor de desarrollo de la aplicación web: +1. Abre **Terminal** en el panel de revisión de esta sesión. Si es necesario, selecciona **+** y después **Terminal**. +2. Confirma que la terminal está en el worktree de filtrado y ejecuta: ```shell npm run dev ``` -5. Cuando se inicie el servidor, lo que solo tardará un momento, abre una ventana del navegador. -6. Ve a http://localhost:4321. -7. Ahora deberías ver filtros en la página de inicio. -8. Si algo no parece correcto, puedes pedir a Copilot que lo actualice. -9. Cuando estés conforme, vuelve a la ventana de terminal. -10. Selecciona Ctrl+C para detener el servidor de desarrollo. - -## Verificar el trabajo con la habilidad quality-checks +3. Abre en el navegador la URL que muestra este servidor, normalmente `http://localhost:4321`. Si el puerto está ocupado, identifica a quién pertenece en lugar de detener un proceso ajeno o suponer que el servidor existente contiene tus cambios. +4. Prueba la selección de categorías, la selección de editor y su combinación según el comportamiento aprobado. Comprueba el acceso mediante teclado y el comportamiento acordado de borrado de filtros y resultados vacíos. +5. Si algo falla, solicita una corrección específica, revisa las diferencias, repite las comprobaciones automatizadas afectadas y las comprobaciones pertinentes del navegador. +6. Vuelve a la terminal y pulsa Control+C (Mac) o Ctrl+C (Windows/Linux) para detener el servidor que has iniciado. Confirma que se ha detenido antes de la ejecución E2E del siguiente módulo. -Podrías revisar visualmente las diferencias y dar el trabajo por terminado, pero el equipo ha definido un nivel de calidad y una forma repetible de comprobarlo. +Esta es tu observación manual en el navegador. La observación en el navegador dirigida por el agente mediante MCP llegará en la Lección 6. -Las **habilidades de agente** permiten proporcionar a Copilot directrices para realizar tareas repetibles, como ejecutar pruebas, generar compilaciones o crear solicitudes de incorporación de cambios. Una habilidad es una carpeta con instrucciones, scripts y recursos que el agente puede cargar bajo demanda. [Agent Skills es un estándar abierto][agent-skills-repo] que utilizan distintos agentes, por lo que la misma habilidad funciona en Copilot Chat en modo agente, el agente en la nube de Copilot, Copilot CLI y la aplicación GitHub Copilot. +## Guardar un punto de control -Las habilidades se almacenan en la carpeta `.github/skills` de un proyecto o de forma global en `~/.copilot/skills`. Cada habilidad es una carpeta que contiene un archivo `SKILL.md` con frontmatter YAML, formado por un `name` y una `description`, seguido de las instrucciones en Markdown: +Tras revisar los cambios y la verificación, autoriza un commit local: -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +Revisa las diferencias actuales y crea un commit de control para la implementación del filtrado y sus pruebas. Mantén esta misma rama y worktree de filtrado. No crees habilidades ni agentes, no configures MCP, no envíes cambios ni abras una solicitud de incorporación de cambios. ``` -Las habilidades también pueden incluir subcarpetas con scripts, recursos y material de referencia. La estructura completa se describe en la [especificación de habilidades de agente][agent-skills-spec]. - -> [!TIP] -> Las habilidades se cargan de forma dinámica. El agente decide cuál se aplica según el campo `description`; una descripción clara y específica del escenario marca la diferencia entre una habilidad que se utiliza y otra que se ignora. - -## Explorar la habilidad quality-checks - -Vamos a explorar la habilidad para ver qué hace. - -1. Si el panel de revisión aún no está visible, selecciona **Toggle review panel** en la esquina superior derecha para abrirlo. - - ![Barra de herramientas superior de la aplicación GitHub Copilot con una flecha que señala el botón Toggle review panel situado a la derecha de Create PR](../../_images/app-2-review-panel.png) - -2. Selecciona **+** para añadir un elemento nuevo al panel de revisión. -3. Selecciona **File**. -4. Busca `SKILL.md`. -5. Selecciona `SKILL.md .github/skills/quality-checks` en la lista de archivos para abrirlo. -6. Observa los campos `name` y `description`. La descripción indica al agente *cuándo* debe utilizar la habilidad: siempre que sea necesario probar, analizar con un linter o verificar cambios de código antes de una confirmación, un envío o una combinación. -7. Lee la habilidad. Observa que documenta qué script ejecuta cada conjunto de pruebas, como las pruebas unitarias, las pruebas de un extremo a otro de Playwright y ESLint, en qué orden y cómo depurar errores habituales. Así, el agente ejecuta las comprobaciones según el proceso del equipo en lugar de adivinarlo. - -## Ejecutar las comprobaciones - -En la misma sesión de filtrado, pide al agente que verifique el trabajo. No mencionarás el nombre de la habilidad; el agente la identificará a partir de la solicitud. - -1. Vuelve a la aplicación Copilot. -2. Llama directamente a la habilidad mediante el comando de barra diagonal `/quality-checks` y selecciona Enter. -3. Siguiendo la habilidad, el agente ejecutará las pruebas unitarias, el linter y las pruebas de un extremo a otro, y comunicará los resultados. Si algo falla, pídele que corrija el problema y vuelva a ejecutar las comprobaciones hasta que todo se complete correctamente. -4. **Mantén abierta esta sesión.** En la siguiente lección añadirás el servidor MCP de Playwright y lo utilizarás para comprobar la funcionalidad de filtrado en un navegador real. - ## Resumen y pasos siguientes -Has creado una funcionalidad real de principio a fin y la has verificado según el nivel de calidad del equipo. En concreto: - -- has iniciado una sesión nueva desde la incidencia sobre filtrado en un proyecto actualizado. -- has utilizado el modo Plan para planificar la funcionalidad y Autopilot para crearla. -- has confirmado que la función auxiliar generada sigue el estándar de documentación que combinaste en la Lección 3. -- has verificado el trabajo con la habilidad `quality-checks`. - -A continuación, conectarás el servidor MCP de Playwright y pedirás al agente que explore la funcionalidad de filtrado en un navegador real. Continúa con la [Lección 5 - Realizar pruebas con el servidor MCP de Playwright][next-lesson]. +Has acordado los requisitos de filtrado, revisado la implementación y las pruebas, y comprobado la funcionalidad manualmente. Este punto de control forma parte de la PR 3, no de una PR independiente. Mantén el modo **Interactive** en la misma sesión para la [Lección 5 - Crear y utilizar una habilidad quality-checks][next-lesson]. ## Recursos - [Trabajar con sesiones de agente en la aplicación GitHub Copilot][agent-sessions] -- [Acerca de Agent Skills][about-agent-skills] -- [Personalizar la aplicación GitHub Copilot][customize-app] - [Acerca de los entornos aislados locales y en la nube para GitHub Copilot][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification \ No newline at end of file diff --git a/docs/es-es/app/5-agent-skills.md b/docs/es-es/app/5-agent-skills.md new file mode 100644 index 00000000..f0cad762 --- /dev/null +++ b/docs/es-es/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +title: "Lección 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-09-11 +--- + +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 las Lecciones 4–8; esta lección no crea una solicitud de incorporación de cambios. + +En esta lección: + +- 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. + +## Escenario + +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. + +## Instrucciones, scripts y recursos + +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. + +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. + +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. + +## Crear la habilidad + +Vuelve a poner la sesión de filtrado en modo **Interactive** mediante el selector de modo 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. + +```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. + +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. + +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. + +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. +``` + +## Examinar la habilidad + +1. Abre **Changes** para revisar los archivos generados. También puedes utilizar **+**, **File** en el panel de revisión y después buscar `SKILL.md` o los nombres de los scripts. +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. + +> [!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. + +## Ejecutar la habilidad + +Confirma que el servidor de desarrollo de la lección 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. + +Si la aplicación 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. + +```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. + +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. +``` + +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. + +## Guardar un punto de control + +Cuando hayas revisado la habilidad y sus resultados, autoriza un punto de control local: + +```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 pasos siguientes + +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 de la Lección 8. Continúa en esta misma sesión con la [Lección 6 - Validar la funcionalidad con MCP de Playwright][next-lesson]. + +## Ejemplos adicionales de habilidades + +Estos ejemplos de la comunidad son referencias, no tareas adicionales. Revisa sus requisitos previos y su comportamiento antes de adoptarlos: + +- [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]. + +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-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/app/5-mcp-playwright.md b/docs/es-es/app/5-mcp-playwright.md deleted file mode 100644 index 705fe8cd..00000000 --- a/docs/es-es/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Lección 5 - Realizar pruebas con el servidor MCP de Playwright" -description: "Añade el servidor MCP de Playwright a la aplicación GitHub Copilot y pide al agente que pruebe manualmente la funcionalidad de filtrado en un navegador real." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -En la lección anterior creaste y verificaste la funcionalidad de filtrado con el conjunto de pruebas automatizadas del proyecto. Las pruebas automatizan la validación del código, pero permitir que el agente confirme el comportamiento también resulta muy útil. Así puede responder a los problemas que detecte en la interfaz de usuario que está creando. Vamos a explorar cómo MCP proporciona a los agentes de IA acceso a capacidades externas y a añadir el servidor MCP de Playwright para que Copilot pueda interactuar directamente con el sitio que estás desarrollando. - -En esta lección: - -- comprenderás qué es Model Context Protocol (MCP) y cómo lo utiliza la aplicación GitHub Copilot. -- añadirás el servidor MCP de Playwright desde la configuración de la aplicación. -- pedirás al agente que controle un navegador y explore la funcionalidad de filtrado. - -## Escenario - -Aunque las pruebas unitarias y de un extremo a otro son importantes, validar las actualizaciones de la interfaz de usuario requiere interactuar con ella. Quieres que Copilot pueda utilizar el sitio web en el que trabajas como lo haría un usuario para automatizar aún más los cambios y aumentar la confianza en que las actualizaciones funcionan según lo previsto. - -## ¿Qué es Model Context Protocol (MCP)? - -[Model Context Protocol (MCP)][mcp-blog-post] proporciona a los agentes de IA una forma de comunicarse con herramientas y servicios externos. Mediante MCP, los agentes de IA pueden comunicarse con ellos 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 gestiona la comunicación entre el agente de IA y las herramientas externas, como API existentes o herramientas locales, por ejemplo, paquetes NPM. Cada servidor MCP representa un conjunto diferente de herramientas y recursos a los que puede acceder el agente de IA. - -Dos servidores MCP populares son: - -- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): proporciona acceso a un conjunto de API para gestionar repositorios de GitHub. Permite al agente de IA realizar acciones como crear repositorios, actualizar los existentes y gestionar incidencias y solicitudes de incorporación de cambios. -- [**Playwright MCP Server**][playwright-mcp-server]: proporciona capacidades de automatización del navegador mediante Playwright. Permite al agente de IA realizar acciones como visitar páginas web, completar formularios y seleccionar botones. - -Hay muchos otros servidores MCP que proporcionan acceso a distintas herramientas y recursos. GitHub aloja un [registro de MCP](https://github.com/mcp) para facilitar su descubrimiento y las contribuciones al ecosistema. - -> [!CAUTION] -> Trata los servidores MCP como cualquier otra dependencia del proyecto. Antes de utilizar uno, revisa atentamente su código fuente, verifica el editor y considera las implicaciones de seguridad. Utiliza únicamente servidores MCP de confianza y ten cuidado al conceder acceso a recursos u operaciones confidenciales. - -## Añadir el servidor MCP de Playwright - -Los servidores MCP se añaden y gestionan desde la configuración de la aplicación. La aplicación incluye un catálogo de servidores populares, por lo que el [servidor MCP de Playwright][playwright-mcp-server] está a solo un par de selecciones. - -1. Selecciona Ctrl+, para abrir la página de configuración de la aplicación Copilot. -2. Selecciona **MCP servers**. -3. En el cuadro de búsqueda, escribe `Playwright`. -4. Selecciona **Playwright** en la lista de **Popular MCP servers**. -5. Selecciona **Add server** para añadirlo a la lista de servidores MCP disponibles. -6. Selecciona Esc para cerrar el cuadro de diálogo de configuración. - -Ya has añadido el servidor MCP de Playwright. - -## Pedir a Copilot que explore la funcionalidad mediante Playwright - -Vamos a pedir a Copilot que pruebe manualmente la funcionalidad mediante el servidor MCP de Playwright. - -1. Utiliza la indicación siguiente para pedir a Copilot que valide la nueva funcionalidad: - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -Copilot iniciará un navegador mediante el servidor MCP de Playwright, recorrerá cada paso y comunicará lo que encuentre. Verás cómo abre un navegador en el sistema para realizar las tareas. - -2. Compara el resumen con los criterios de aceptación de la incidencia. Si algo no parece correcto, formula preguntas de seguimiento o pide al agente que corrija el código antes de abrir una solicitud de incorporación de cambios. -3. Mantén abierta esta sesión, ya que la completaremos en la siguiente lección. - -Copilot también ha validado la funcionalidad en el navegador mediante la exploración de la característica como lo haría un usuario. - -## Resumen y pasos siguientes - -Has utilizado el servidor MCP de Playwright para explorar la funcionalidad en un navegador real desde la aplicación GitHub Copilot. En resumen: - -- has aprendido qué es Model Context Protocol (MCP) y cómo la aplicación pone a disposición las herramientas MCP. -- has añadido el servidor MCP de Playwright desde la configuración de la aplicación. -- has pedido al agente que controle un navegador y explore la funcionalidad de filtrado. - -La funcionalidad está creada, verificada y en funcionamiento. Ahora toca publicarla mediante **Agent Merge**, que abrirá y combinará la solicitud de incorporación de cambios. Continúa con la [Lección 6 - Combinar cambios con Agent Merge][next-lesson]. - -## Recursos - -- [¿Qué es MCP y por qué todo el mundo habla de él?][mcp-blog-post] -- [Servidor MCP de Playwright de Microsoft][playwright-mcp-server] -- [Configurar servidores MCP en la aplicación GitHub Copilot][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/6-agent-merge.md b/docs/es-es/app/6-agent-merge.md deleted file mode 100644 index b29b7903..00000000 --- a/docs/es-es/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Lección 6 - Combinar cambios con Agent Merge" -description: "Abre la solicitud de incorporación de cambios del filtrado, revísala en My work y deja que Agent Merge corrija los bloqueos y la combine por ti, el nivel más alto de la automatización de combinaciones." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -La funcionalidad de filtrado está creada, verificada y en funcionamiento en un navegador. El último paso es combinarla. Ya has combinado dos cambios en este recorrido; en ambos casos abriste la solicitud de incorporación de cambios y la combinaste personalmente en github.com. Esta vez dejarás que la aplicación se encargue del trabajo con **Agent Merge**, que guía una solicitud durante todo su ciclo de vida desde la aplicación. - -En esta lección: - -- aprenderás qué es Agent Merge y cómo automatiza el ciclo de vida de una combinación. -- habilitarás Agent Merge en la sesión de filtrado. -- observarás cómo crea la solicitud de incorporación de cambios, ejecuta CI y la combina cuando todo se completa correctamente. - -## Escenario - -En los últimos módulos has explorado distintos niveles de automatización, desde crear código hasta permitir que Copilot valide directamente una interfaz de usuario. Para acelerar aún más el desarrollo, Tailspin Toys quiere averiguar si las solicitudes de incorporación de cambios que ya se han revisado y validado pueden combinarse automáticamente. - -## Introducción a Agent Merge - -**Agent Merge** permite automatizar el último tramo de la incorporación de una solicitud de cambios mediante la aplicación Copilot. Al habilitarlo, la sesión de la aplicación lee la solicitud y resuelve lo que la bloquea: corrige comprobaciones de CI con errores, responde a comentarios de revisión y reorganiza la base cuando es necesario. Después la combina en cuanto GitHub lo permite. Se ejecuta en segundo plano, continúa tras reiniciar la aplicación y se desactiva cuando se combina la solicitud. - -Hasta ahora, tú seleccionabas **Merge pull request** en github.com. Agent Merge transfiere esa responsabilidad al agente para que puedas pasar a la siguiente tarea mientras este guía la solicitud hasta completarla. Sigues revisando y aprobando el trabajo; el agente se ocupa del proceso mecánico final. - -## Utilizar Agent Merge para gestionar la solicitud - -Has revisado el código manualmente, ejecutado pruebas e incluso permitido que Copilot valide la interfaz de usuario. Ha llegado el momento de combinar el código nuevo con el código base. Vamos a permitir que Agent Merge guíe la solicitud durante la integración continua (CI) y la combine. - -1. Vuelve a la sesión que mantuviste abierta en el módulo anterior mientras añadías la funcionalidad de filtrado. -2. En la esquina superior derecha, selecciona el menú desplegable situado junto a **Create PR**. -3. Selecciona **Agent merge** para habilitar Agent Merge. - - ![Menú desplegable Create PR de la aplicación GitHub Copilot abierto, con una flecha que señala la opción Agent merge](../../_images/app-enable-agent-merge.png) - -4. El texto del botón cambia a **Agent merge**. -5. Selecciona el botón **Agent merge** para iniciar el proceso. - -La aplicación Copilot comenzará a crear y gestionar la solicitud. Primero explora el proyecto para determinar la mejor forma de crearla y, después, genera la nueva solicitud. - -Transcurridos unos instantes, observarás que Copilot vuelve a trabajar y examina las condiciones de la solicitud, incluido el proceso de CI que ejecuta todas las pruebas del repositorio. Comunicará el estado de las revisiones de otros miembros del equipo, las comprobaciones que deben ejecutarse y si la solicitud puede combinarse. - -6. Permite que Agent Merge combine la solicitud seleccionando el menú desplegable situado junto a **Agent merge** y, después, **Merge pull request**. - - ![Menú desplegable Agent merge con las acciones permitidas al agente —Address reviews, Fix CI failures y Resolve conflicts— y una flecha que señala Merge pull request](../../_images/app-agent-merge-merge.png) - -7. Cuando todos los procesos de CI estén en verde, lo que significa que las pruebas han finalizado correctamente, Copilot combinará la solicitud. - -## Resumen y pasos siguientes - -Has automatizado varias partes del proceso de desarrollo, como la generación, las pruebas y la validación de código, y ahora también el proceso de solicitud de incorporación de cambios. En concreto: - -- has aprendido qué es Agent Merge y cómo automatiza el ciclo de vida de una combinación. -- has habilitado Agent Merge en la sesión de filtrado. -- has observado cómo crea la solicitud de incorporación de cambios, ejecuta CI y la combina cuando todo se completa correctamente. - -A continuación, explorarás los **lienzos**, una forma más completa de planificar y visualizar el trabajo con el agente. Continúa con la [Lección 7 - Planificar con lienzos][next-lesson]. - -## Recursos - -- [Gestionar incidencias y solicitudes de incorporación de cambios con la aplicación GitHub Copilot][managing-issues-prs] -- [Acerca de la aplicación GitHub Copilot][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/6-mcp-playwright.md b/docs/es-es/app/6-mcp-playwright.md new file mode 100644 index 00000000..82712159 --- /dev/null +++ b/docs/es-es/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "Lección 6 - Validar la funcionalidad con MCP de Playwright" +description: "Configura MCP de Playwright mediante Customize y observa el filtrado en un navegador desde el worktree existente de la funcionalidad." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +En la lección anterior agrupaste y ejecutaste las comprobaciones del proyecto mediante tu habilidad quality-checks. Ahora da al agente acceso a un navegador para que pueda observar directamente la interfaz de filtrado. Permanece en la misma sesión, worktree y rama de filtrado. Esta lección aporta pruebas de observación en el navegador, no otra funcionalidad, una nueva ejecución de todo el conjunto de pruebas ni una PR. + +En esta lección: + +- comprenderás qué es Model Context Protocol (MCP) y cómo lo utiliza la aplicación GitHub Copilot. +- añadirás el servidor MCP de Playwright mediante **Customize**. +- pedirás al agente que controle un navegador y explore la funcionalidad de filtrado. + +## Escenario + +Aunque las pruebas unitarias y de un extremo a otro son importantes, validar las actualizaciones de la interfaz de usuario requiere interactuar con ella. Quieres que Copilot pueda utilizar el sitio web en el que trabajas como lo haría un usuario para automatizar aún más los cambios y aumentar la confianza en que las actualizaciones funcionan según lo previsto. + +## ¿Qué es Model Context Protocol (MCP)? + +[Model Context Protocol (MCP)][mcp-blog-post] proporciona a los agentes de IA una forma de comunicarse con herramientas y servicios externos. Mediante MCP, los agentes de IA pueden comunicarse con ellos 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 gestiona la comunicación entre el agente de IA y las herramientas externas, como API existentes o herramientas locales, por ejemplo, paquetes NPM. Cada servidor MCP representa un conjunto diferente de herramientas y recursos a los que puede acceder el agente de IA. + +Dos servidores MCP populares son: + +- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): proporciona acceso a un conjunto de API para gestionar repositorios de GitHub. Permite al agente de IA realizar acciones como crear repositorios, actualizar los existentes y gestionar incidencias y solicitudes de incorporación de cambios. +- [**Playwright MCP Server**][playwright-mcp-server]: proporciona capacidades de automatización del navegador mediante Playwright. Permite al agente de IA realizar acciones como visitar páginas web, completar formularios y seleccionar botones. + +Hay muchos otros servidores MCP que proporcionan acceso a distintas herramientas y recursos. GitHub aloja un [registro de MCP](https://github.com/mcp) para facilitar su descubrimiento y las contribuciones al ecosistema. + +> [!CAUTION] +> Trata los servidores MCP como cualquier otra dependencia del proyecto. Antes de utilizar uno, revisa atentamente su código fuente, verifica el editor y considera las implicaciones de seguridad. Utiliza únicamente servidores MCP de confianza y ten cuidado al conceder acceso a recursos u operaciones confidenciales. + +## Añadir el servidor MCP de Playwright + +La [documentación actual de personalización de la aplicación][customize-app] utiliza **Customize** en la barra lateral para descubrir y gestionar MCP. Los servidores MCP configurados para tus repositorios o Copilot CLI pueden estar ya disponibles en la aplicación; examina los servidores instalados antes de añadir un duplicado. + +1. Selecciona **Customize** en la barra lateral. +2. Selecciona **MCP** y comprueba en **Installed** si ya existe un servidor de Playwright. +3. Si es necesario, busca **Playwright** entre los servidores disponibles o utiliza el procedimiento de servidor personalizado documentado por el editor. +4. Revisa el editor, la configuración y cualquier solicitud de instalación antes de aprobarla. Sigue las indicaciones para añadir el servidor; las directivas de la organización o la falta de requisitos previos pueden bloquear la configuración. +5. Vuelve a la sesión de filtrado existente y mantén el modo **Interactive**. Confirma que las herramientas de navegador de MCP de Playwright están disponibles antes de solicitar la validación. No crees un worktree nuevo de la funcionalidad para solucionar problemas de configuración. + +Si la configuración falla, resuelve el problema de configuración o permisos en lugar de aceptar una afirmación de que el agente ha navegado sin herramientas. La visibilidad del navegador depende de la configuración del servidor; la actividad real de las herramientas y las observaciones son las pruebas. + +## Pedir a Copilot que explore la funcionalidad mediante Playwright + +Utiliza la URL real de la incidencia y las aclaraciones aprobadas que guardaste en la Lección 4. Detén cualquier servidor de desarrollo manual de lecciones anteriores antes de que el agente inicie el suyo. Debe identificar la copia de trabajo y el servidor que está probando. + +1. Utiliza la indicación siguiente para pedir a Copilot que valide la nueva funcionalidad: + + ```plaintext + Utiliza el servidor MCP de Playwright configurado para observar la funcionalidad de filtrado según esta incidencia: . Estas son mis aclaraciones de planificación aprobadas: . Permanece en este worktree y rama de filtrado. + + Identifica la copia de trabajo, inicia su servidor de desarrollo y utiliza herramientas reales de navegador para probar la selección de varias categorías, el filtrado por editor, el filtrado combinado, los controles accesibles y cualquier comportamiento acordado de borrado de filtros o resultados vacíos. Informa de las observaciones frente a los criterios, incluidos fallos o comprobaciones bloqueadas. No afirmes comportamientos que no hayas observado. + + Este paso es una observación en el navegador, no otra ejecución automatizada completa de pruebas. No cambies código de la aplicación, pruebas, habilidades ni perfiles de agente, no crees commits, no envíes cambios ni crees una PR. Informa como bloqueadas las herramientas MCP o los requisitos previos ausentes y pregunta antes de instalar cualquier cosa. No reutilices el servidor de otra copia de trabajo ni detengas procesos ajenos. Al terminar, detén solo el servidor que hayas iniciado. + ``` + +Examina las llamadas a herramientas MCP de Playwright, la URL probada y las observaciones comunicadas del navegador. Un relato basado solo en el código fuente o en resultados E2E anteriores no demuestra el uso de MCP. + +2. Compara el resumen con la incidencia y las aclaraciones aprobadas. Si hay un defecto, autoriza por separado una corrección específica, revisa las diferencias y repite las comprobaciones automatizadas y observaciones del navegador pertinentes. Las pruebas anteriores a la corrección no demuestran la revisión resultante. +3. Confirma que el agente ha detenido su propio servidor. Mantén abierta esta sesión de filtrado y permanece en modo **Interactive** antes de crear el perfil QA en la Lección 7. + +Esta etapa aporta observación directa, no sustituye la cobertura automatizada. Los fallos y las observaciones bloqueadas siguen siendo visibles para QA. + +## Resumen y pasos siguientes + +Has utilizado el servidor MCP de Playwright para explorar la funcionalidad en un navegador real desde la aplicación GitHub Copilot. En resumen: + +- has aprendido qué es Model Context Protocol (MCP) y cómo la aplicación pone a disposición las herramientas MCP. +- has configurado el servidor MCP de Playwright mediante **Customize**. +- has pedido al agente que controle un navegador y explore la funcionalidad de filtrado. + +A continuación, reúne los requisitos, las observaciones del navegador, la cobertura y la habilidad en un perfil especializado. Continúa en esta misma sesión con la [Lección 7 - Crear y utilizar un agente QA][next-lesson]. No crees todavía la PR de la funcionalidad. + +## Recursos + +- [¿Qué es MCP y por qué todo el mundo habla de él?][mcp-blog-post] +- [Servidor MCP de Playwright de Microsoft][playwright-mcp-server] +- [Configurar servidores MCP en la aplicación GitHub Copilot][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/7-canvases.md b/docs/es-es/app/7-canvases.md deleted file mode 100644 index 2272a3bc..00000000 --- a/docs/es-es/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Lección 7 - Planificar con lienzos" -description: "Crea un lienzo compartido y dirigido por agentes en la aplicación GitHub Copilot para planificar y realizar el seguimiento del trabajo junto con el agente." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Hasta ahora has dirigido a los agentes mediante el chat. Sin embargo, gran parte del trabajo no reside en una conversación, sino en un tablero, un documento o una lista de comprobación. Los **lienzos** ofrecen al agente y a ti una superficie compartida para ese tipo de trabajo, directamente en la aplicación. En esta lección crearás un lienzo sencillo para planificar y realizar el seguimiento de la lista de trabajo pendiente que has estado abordando. - -En esta lección: - -- comprenderás qué es un lienzo y cuándo utilizarlo. -- crearás un lienzo compartido con un tablero Kanban para clasificar la lista de trabajo pendiente. -- guardarás el lienzo en el repositorio y lo combinarás para el equipo. -- abrirás el lienzo en una sesión nueva y empezarás a trabajar desde él. - -## Escenario - -Examinar una lista de incidencias puede resultar abrumador, incluso en las mejores circunstancias. Los desarrolladores de Tailspin Toys buscan una herramienta que les permita clasificar las incidencias con rapidez y empezar a trabajar en ellas desde la aplicación Copilot. - -## ¿Qué es un lienzo? - -Un [lienzo][canvas-docs] es una superficie interactiva y compartida para un recurso de trabajo, como un plan, un tablero de clasificación, una lista de comprobación de versiones, un panel o un documento. Aunque el chat resulta adecuado para describir intenciones y razonar sobre ambigüedades, la mayor parte del trabajo se realiza en una *superficie*. Los lienzos permiten colaborar con el agente directamente sobre ella. - -Los lienzos son **bidireccionales**: el agente puede actualizar el lienzo mientras trabaja y tú puedes editar la misma superficie. Cuando creas un lienzo, el agente lo genera a partir de la indicación y el flujo de trabajo, y puedes pedirle que añada, elimine o revise capacidades a medida que avanzas. Una vez creado, el lienzo se abre en el panel derecho de la aplicación. - -Algunos ejemplos habituales son: - -- **Lienzos de Markdown** para planificar el día y priorizar incidencias y solicitudes de incorporación de cambios. -- **Tableros Kanban con agentes** en los que las personas y los agentes añaden tarjetas y desplazan el trabajo entre columnas. -- **Tableros de clasificación de incidencias** que resumen las incidencias principales y los temas recurrentes de un repositorio. - -## ¿Por qué utilizar un lienzo? - -Utiliza un lienzo cuando una tarea requiera estructura, iteración y verificación, y un chat no sea suficiente. Un lienzo permite: - -- basar el trabajo del agente en un recurso real que se adapte al flujo de trabajo. -- orientar o corregir el trabajo directamente en la superficie compartida y, después, permitir que el agente continúe a partir de los cambios. -- inspeccionar el progreso como cambios visibles en un recurso, no solo como respuestas del chat. - -## Crear un lienzo para realizar el seguimiento del trabajo - -Has publicado numerosos cambios: la valoración por estrellas, el estándar de documentación y la funcionalidad de filtrado ya están combinados. Sin embargo, todavía quedan elementos en la lista de trabajo pendiente. Vamos a crear el lienzo para clasificar el trabajo con rapidez. - -1. Vuelve a la aplicación GitHub Copilot o ábrela. -2. Selecciona **Home screen**. -3. Comprueba que `tailspin-toys` esté seleccionado como repositorio. -4. En el cuadro de indicaciones, utiliza la indicación siguiente para crear un lienzo que satisfaga nuestras necesidades: - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -Copilot comenzará a crear el lienzo. - -> [!NOTE] -> La creación tardará unos minutos. Como se trata de una tarea compleja, es posible que la primera versión no te satisfaga. Puedes seguir enviando indicaciones hasta crear la herramienta que necesitas. - -## Guardar el lienzo y combinarlo con el repositorio - -Los lienzos pueden convertirse en recursos del repositorio, al igual que los archivos de instrucciones y las habilidades. Vamos a pedir a Copilot que lo añada al repositorio y lo combine para que pueda utilizarlo todo el equipo. - -1. En la misma sesión, pide a Copilot que guarde el lienzo en el repositorio mediante la indicación siguiente: - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Cuando Copilot haya guardado los archivos del lienzo, selecciona el menú desplegable situado junto a **Create PR** en la esquina superior derecha. -3. Selecciona **Agent merge** para habilitar Agent Merge. - - ![Menú desplegable Create PR de la aplicación GitHub Copilot abierto, con una flecha que señala la opción Agent merge](../../_images/app-enable-agent-merge.png) - -4. El texto del botón cambia a **Agent merge**. -5. Selecciona el botón **Agent merge** para iniciar el proceso. - -La aplicación Copilot comenzará a crear y gestionar la solicitud. Primero explora el proyecto para determinar la mejor forma de crearla y, después, la genera. - -Transcurridos unos instantes, observarás que Copilot vuelve a trabajar y examina las condiciones de la solicitud, incluido el proceso de CI que ejecuta todas las pruebas del repositorio. Comunicará el estado de las revisiones de otros miembros del equipo, las comprobaciones que deben ejecutarse y si la solicitud puede combinarse. - -6. Permite que Agent Merge combine la solicitud seleccionando el menú desplegable situado junto a **Agent merge** y, después, **Merge pull request**. - - ![Menú desplegable Agent merge con las acciones permitidas al agente —Address reviews, Fix CI failures y Resolve conflicts— y una flecha que señala Merge pull request](../../_images/app-agent-merge-merge.png) - -7. Espera a que todos los procesos de CI se completen correctamente y se muestren en verde. Cuando terminen, Copilot combinará automáticamente la solicitud. - -Ya has creado un lienzo compartido para el equipo. - -## Trabajar en el lienzo - -Con el lienzo creado, vamos a iniciar una sesión nueva y utilizarlo. - -1. En la aplicación Copilot, selecciona **New session** junto a **tailspin-toys** para iniciar una sesión nueva. -2. Pide a Copilot que abra el lienzo de clasificación mediante la indicación siguiente: - - ```plaintext - Open the triage issues canvas - ``` - -3. El lienzo que has creado debería abrirse en la sesión nueva. -4. Selecciona **Add to current context** en una de las incidencias que más te interese. -5. Copilot empezará a trabajar en la incidencia. - -Has utilizado un lienzo creado por ti para agilizar el proceso de desarrollo. - -## Resumen y pasos siguientes - -Has creado una superficie compartida en la que puedes colaborar con el agente. En concreto: - -- has aprendido qué son los lienzos y cuándo utilizarlos. -- has creado con el agente un lienzo compartido con un tablero Kanban para clasificar incidencias. -- has guardado y combinado el lienzo con el repositorio mediante Agent Merge. -- has abierto el lienzo en una sesión nueva y lo has utilizado para empezar a trabajar. - -Con la lista de trabajo pendiente organizada, da un paso atrás para revisar todo lo que has creado y descubrir cómo continuar. Continúa con la [Lección 8 - Repaso y pasos siguientes][next-lesson]. - -## Recursos - -- [Trabajar con extensiones de lienzo en la aplicación GitHub Copilot][canvas-docs] -- [Lienzos en Awesome Copilot][awesome-copilot-canvases] -- [Acerca de la aplicación GitHub Copilot][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/7-qa-agent.md b/docs/es-es/app/7-qa-agent.md new file mode 100644 index 00000000..bf1b1f08 --- /dev/null +++ b/docs/es-es/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +title: "Lección 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-14 +--- + +En las lecciones anteriores, creaste una habilidad quality-checks y diste a Copilot acceso a un navegador mediante MCP de Playwright. Ahora reúne esas capacidades con un **agente personalizado de QA** que revise la funcionalidad de filtrado frente a sus requisitos. + +En esta lección: + +- comprenderás cómo trabaja un agente personalizado con instrucciones, habilidades y herramientas MCP. +- crearás y examinarás un perfil de QA reutilizable. +- seleccionarás el agente de QA y revisarás sus conclusiones frente a la incidencia de filtrado. +- guardarás el perfil y las pruebas justificadas para la PR de la funcionalidad. + +## Escenario + +Tailspin Toys se prepara para publicar el filtrado por categoría y editor. Las comprobaciones automatizadas y la exploración en el navegador han aportado información útil al equipo, pero superar las pruebas no demuestra por sí solo que se cubran todos los requisitos acordados. Antes de abrir la PR, el equipo quiere revisar de forma específica qué se pidió, qué se implementó y qué sigue pendiente. + +Crearás un agente de QA que parta de la incidencia y de las decisiones de planificación aprobadas, examine la cobertura y utilice la habilidad y las herramientas del navegador para reunir pruebas de verificación. Su función es identificar carencias y explicar si la funcionalidad está lista para revisión, no aprobar su propio trabajo ni combinar la PR. + +## ¿Qué es un agente personalizado? + +Un agente personalizado es un rol especializado reutilizable definido en un perfil Markdown. Sus instrucciones orientan cómo aborda Copilot una tarea; al seleccionar el perfil, aplicas ese rol a la conversación. En este taller, definirás el rol en `.github/agents/qa.agent.md` y lo seleccionarás en la aplicación. + +Las personalizaciones que has creado tienen funciones distintas. Las instrucciones del repositorio describen los estándares del equipo. La habilidad quality-checks reúne comprobaciones repetibles. MCP de Playwright proporciona herramientas de navegador. El perfil de QA indica a Copilot cómo usar esas capacidades para evaluar requisitos e informar de sus conclusiones. No las sustituye ni requiere otra sesión de agente. + +## Crear el perfil de QA + +Continúa en la sesión de filtrado de la Lección 6, manteniendo el mismo worktree y rama. Confirma que la sesión está en modo **Interactive**, que la habilidad quality-checks está presente y que MCP de Playwright está disponible. La PR de la funcionalidad llegará en la Lección 8; esta lección añade un perfil y, solo cuando sea necesario, pruebas. + +Envía la siguiente indicación al agente habitual de Copilot. Examinarás el archivo resultante antes de seleccionar QA: + +```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 + +1. Abre **Changes** y selecciona `.github/agents/qa.agent.md`. También puedes encontrarlo en el panel de revisión de archivos. +2. Lee el frontmatter. `description` es obligatorio y `name: QA` permite reconocer el perfil en el selector. Deja `model` y `tools` sin especificar en este ejercicio para usar el modelo seleccionado y las herramientas disponibles; los permisos habituales siguen vigentes. +3. Lee las instrucciones como una lista de revisión: ¿parten de los requisitos, utilizan la habilidad y las herramientas del navegador, añaden pruebas solo para carencias reales y distinguen los fallos de las comprobaciones bloqueadas? +4. Pide a Copilot que corrija las carencias antes de seleccionar el perfil. Confirma que ha creado la definición sin iniciar QA ni cambiar la aplicación. + +> [!NOTE] +> Un perfil especializado orienta el comportamiento; no garantiza un resultado correcto. Debes seguir examinando la actividad de las herramientas, los cambios en las pruebas y el informe del agente. + +## 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. Mantén la misma copia de trabajo y rama de filtrado. + +1. En la sesión actual, abre el selector de agentes del cuadro de la indicación o introduce `/agent`, como describe la [documentación de personalización de la aplicación][customize-app]. +2. Selecciona **QA** y verifica que la aplicación identifica visiblemente a **QA** como agente activo antes de enviar la indicación de ejecución. +3. Si **QA** no aparece o no puedes confirmar que está activo, detente y pregunta a la persona que dirige el taller, conservando este worktree y rama. No crees otra sesión de funcionalidad, no inventes una secuencia de recarga ni sustituyas este paso por una solicitud al agente predeterminado para que lea `qa.agent.md`. + +El selector documentado está disponible durante una sesión, pero el descubrimiento de un perfil de repositorio recién creado puede depender de la versión de la aplicación. No trates la creación del archivo como prueba de activación. + +Sustituye ambos marcadores por la URL real de la incidencia de filtrado y las aclaraciones aprobadas en la Lección 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 + +Lee el informe junto con la incidencia de filtrado y las aclaraciones aprobadas: + +1. Comprueba que cada criterio se relaciona con pruebas adecuadas y comportamiento observable. Por ejemplo, combinar categorías y un editor exige verificar los juegos devueltos, no solo si responden los controles. +2. Examina la actividad real de las herramientas MCP de Playwright y confirma que el servidor probado pertenece a esta copia de trabajo. Las comprobaciones de navegador y E2E automatizadas no deben reutilizar un servidor obsoleto ni otra copia de trabajo. +3. Revisa los resultados de lint, pruebas unitarias, pruebas E2E y comprobaciones de tipos. Las cuatro deben ejecutarse mediante los scripts de la habilidad quality-checks; resumir comandos previstos no equivale a ejecutarlos. +4. Abre **Changes** para examinar las pruebas añadidas y compararlas con las carencias del informe. + +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 + +La función de QA es verificar, así que vuelve al agente habitual antes de solicitar un commit: + +1. Conserva el informe de QA, la URL de la incidencia, las aclaraciones aprobadas y la revisión probada para la lección sobre la PR. +2. En la misma sesión, utiliza el selector de agentes para volver al agente habitual de Copilot y confirma que **QA** ya no está seleccionado. +3. Mantén el mismo worktree y rama. Si no encuentras la opción del agente habitual, pregunta a la persona que dirige el taller en lugar de iniciar otra sesión de funcionalidad o enviar instrucciones de commit a QA. + +Cuando hayas revisado el perfil, los cambios de pruebas y las pruebas de verificación resultantes, envía la solicitud de punto de control al agente habitual con ese contexto de QA: + +```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 añadido un rol especializado reutilizable al flujo de trabajo y revisado su trabajo. En esta lección: + +- creaste y examinaste un perfil de QA que parte de los requisitos. +- lo seleccionaste para evaluar la cobertura y reunir pruebas de verificación mediante la habilidad y MCP de Playwright. +- revisaste las conclusiones y guardaste el perfil con los cambios de pruebas justificados en la rama de filtrado. + +Ya tienes los elementos para revisar la funcionalidad: la implementación, la habilidad, el perfil de QA, las pruebas y el informe de verificación. Conserva los hallazgos pendientes; un resultado fallido o bloqueado no autoriza la combinación. Continúa con la [Lección 8 - Crear y combinar la PR de la funcionalidad][next-lesson] para revisar el hito completo y utilizar Agent Merge. + +## Recursos + +- [Personalizar la aplicación GitHub Copilot, incluida la selección de agentes personalizados][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/es-es/app/8-create-pull-request.md b/docs/es-es/app/8-create-pull-request.md new file mode 100644 index 00000000..f495c902 --- /dev/null +++ b/docs/es-es/app/8-create-pull-request.md @@ -0,0 +1,89 @@ +--- +title: "Lección 8 - Crear y combinar la PR de la funcionalidad" +description: "Revisa conjuntamente el filtrado, la habilidad, el perfil QA y las pruebas, crea la PR 3 y autoriza Agent Merge explícitamente." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +La implementación del filtrado, la habilidad quality-checks, el perfil QA y las pruebas asociadas están guardados en commits de control en una sola rama. Revísalos juntos y utiliza las pruebas de verificación actuales de QA para preparar la PR 3. Ya has combinado explícitamente las PR de valoraciones por estrellas e instrucciones. Esta vez utilizarás **Agent Merge** dentro del flujo de PR, no como una funcionalidad o rama independiente. + +En esta lección: + +- aprenderás qué es Agent Merge y cómo automatiza el ciclo de vida de una combinación. +- examinarás la PR completa de la funcionalidad y las pruebas de verificación. +- autorizarás Agent Merge solo después de la revisión y confirmarás que la PR está combinada. + +## Escenario + +En los últimos módulos has explorado distintos niveles de automatización, desde crear código hasta permitir que Copilot valide directamente una interfaz de usuario. Para acelerar aún más el desarrollo, Tailspin Toys quiere averiguar si las solicitudes de incorporación de cambios que ya se han revisado y validado pueden combinarse automáticamente. + +## Introducción a Agent Merge + +**Agent Merge** permite automatizar el último tramo de la incorporación de una solicitud de cambios mediante la aplicación Copilot. Al habilitarlo, la sesión de la aplicación lee la solicitud y resuelve lo que la bloquea: corrige comprobaciones de CI con errores, responde a comentarios de revisión y reorganiza la base cuando es necesario. Después la combina en cuanto GitHub lo permite. Se ejecuta en segundo plano, continúa tras reiniciar la aplicación y se desactiva cuando se combina la solicitud. + +Hasta ahora has seleccionado **Merge pull request** personalmente. Agent Merge puede asumir esa responsabilidad, pero su capacidad de editar código y combinar sigue necesitando tu autorización explícita. Revisa sus acciones permitidas y el trabajo antes de conceder permiso para combinar. + +## Revisar el hito completo + +Permanece en la sesión de filtrado de las Lecciones 4–7. Comprueba todas las diferencias de la rama frente a `main`, no solo el último punto de control: deben contener el filtrado, `.github/skills/quality-checks/SKILL.md`, los scripts incluidos, `.github/agents/qa.agent.md` y las pruebas asociadas. + +Utiliza el selector de agentes para volver de **QA** al agente general de Copilot antes de solicitar commits o acciones de PR y mantén el modo **Interactive**. El trabajo del perfil QA era verificar, no publicar. Cambiar el agente seleccionado no debe cambiar la sesión, la copia de trabajo ni la rama de filtrado. + +Este taller combina deliberadamente el trabajo de la funcionalidad y la infraestructura de calidad reutilizable en una sola PR. Un equipo de producción podría separarlos; aquí, los commits de control conservan pasos revisables sin ramas apiladas ni PR adicionales. + +Revisa el informe QA de la Lección 7. Reutiliza sus pruebas de verificación solo si cubren la revisión final que se va a enviar, con las cuatro comprobaciones y las observaciones pertinentes del navegador completadas. Si los cambios de código, los conflictos o las correcciones de CI alteran lo que se probó, repite las comprobaciones y observaciones afectadas y actualiza las pruebas de verificación. Un informe **NO-GO** con fallos o bloqueos no autoriza la combinación. + +Cuando las diferencias y las pruebas de verificación estén listas, envía: + +```plaintext +Revisa todas las diferencias de la rama de filtrado frente a main, incluidas la funcionalidad de filtrado, la habilidad quality-checks y sus scripts, la definición del agente QA y las pruebas asociadas. Resume los criterios de la incidencia, las aclaraciones aprobadas y las pruebas de verificación actuales de QA. Reutiliza la verificación solo si sigue siendo válida para la revisión final; informa de pruebas de verificación desactualizadas, ausentes o con fallos antes de continuar. + +Si los cambios revisados y la verificación están listos, crea un commit con los cambios aprobados restantes del hito, envía esta rama y crea una única PR de la funcionalidad destinada a main con la plantilla de PR del repositorio y la URL real de la incidencia de filtrado. Mantén el historial de puntos de control en esta rama. No utilices una habilidad de contribución, no crees otra rama o PR ni combines todavía. +``` + +Abre la PR en **My work** y examina **Files changed**, su descripción, las revisiones y los resultados de las comprobaciones. Examina los archivos de flujos de trabajo propios de Tailspin Toys y las comprobaciones obligatorias; no supongas que todas las comprobaciones locales u observaciones del navegador se ejecutan en CI. La compilación Astro y el comprobador de enlaces que publican el taller pertenecen a otro repositorio y no validan esta funcionalidad. + +## Utilizar Agent Merge para gestionar la solicitud + +Tras revisar la PR existente, configura Agent Merge en esta misma sesión. No crees una segunda PR. + +1. Vuelve a la sesión de filtrado y confirma que está vinculada a la PR 3. +2. Abre el menú desplegable de acciones de PR en la esquina superior derecha. Antes de que exista una PR, está junto a **Create PR**; la etiqueta puede cambiar cuando hay una PR vinculada. +3. Selecciona **Agent merge** para habilitar Agent Merge. +4. Revisa los permisos disponibles, incluidos **Address reviews**, **Fix CI failures**, **Resolve conflicts** y **Merge pull request**. Mantén desactivado el permiso de combinación mientras haya hallazgos o verificaciones pendientes. +5. Antes de iniciarlo, envía el alcance y la autorización siguientes y después selecciona **Agent merge**: + + ```plaintext + Gestiona esta PR de filtrado existente con Agent Merge. Resuelve los bloqueos de revisión o CI solo dentro del alcance de esta PR. No debilites las pruebas ni los requisitos y pregunta antes de realizar cambios ajenos o instalaciones. Cualquier cambio de la revisión probada exige actualizar las comprobaciones pertinentes y las pruebas de observación del navegador; no trates resultados QA anteriores como prueba de código modificado. + + No combines hasta que habilite explícitamente Merge pull request tras revisar las diferencias finales y las pruebas de verificación. No crees otra PR ni empieces la tarea del lienzo. + ``` + +6. Revisa los cambios posteriores y los resultados actualizados. Cuando las diferencias finales estén aprobadas, CI y las revisiones obligatorias se hayan completado correctamente y las pruebas de QA correspondan a esa revisión, autoriza explícitamente la combinación seleccionando el menú desplegable junto a **Agent merge** y después **Merge pull request**. + + ![Menú desplegable Agent merge con las acciones permitidas al agente —Address reviews, Fix CI failures y Resolve conflicts— y una flecha que señala Merge pull request](../../_images/app-agent-merge-merge.png) + +7. Confirma que GitHub muestra la PR 3 como **Merged**, no solo como combinable o en cola. Agent Merge no elude las protecciones del repositorio ni los permisos ausentes; resuelve esos bloqueos antes de continuar. + +Solo después de esa combinación debes iniciar el hito del lienzo. La Lección 9 crea un worktree nuevo y actualiza su rama de sesión mediante un avance rápido hasta el último `origin/main` para que el lienzo parta de la funcionalidad completa combinada. + +## Resumen y pasos siguientes + +Has automatizado varias partes del proceso de desarrollo, como la generación, las pruebas y la validación de código, y ahora también el proceso de solicitud de incorporación de cambios. En concreto: + +- has aprendido qué es Agent Merge y cómo automatiza el ciclo de vida de una combinación. +- has revisado todas las diferencias de filtrado, habilidad, perfil QA y pruebas como PR 3. +- has reutilizado las pruebas de QA actuales, examinado CI y autorizado Agent Merge explícitamente. + +A continuación, explorarás los **lienzos**, una forma más completa de planificar y visualizar el trabajo con el agente. Continúa con la [Lección 9 - Crear un lienzo de clasificación de incidencias][next-lesson]. + +## Recursos + +- [Gestionar incidencias y solicitudes de incorporación de cambios con la aplicación GitHub Copilot][managing-issues-prs] +- [Acerca de la aplicación GitHub Copilot][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/8-review.md b/docs/es-es/app/8-review.md deleted file mode 100644 index 7f9a64f2..00000000 --- a/docs/es-es/app/8-review.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Lección 8 - Repaso y pasos siguientes" -description: "Repasa el recorrido de la aplicación GitHub Copilot, automatiza el trabajo recurrente y descubre cómo continuar." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Durante las últimas lecciones, has llevado una funcionalidad desde la idea hasta la combinación mediante la aplicación GitHub Copilot. Entre otras cosas, has aprendido a: - -- conectar un repositorio y familiarizarte con el espacio de trabajo de la aplicación y la lista de trabajo pendiente inicial. -- iniciar sesiones desde una tarea directa y desde incidencias, y utilizar los modos Plan y Autopilot para controlar cómo trabaja el agente. -- orientar al agente con instrucciones personalizadas y una habilidad reutilizable. -- probar el trabajo con el servidor MCP de Playwright en un navegador real. -- colaborar con el agente en un lienzo compartido. -- publicar cambios con niveles crecientes de automatización de combinaciones, desde combinarlos personalmente en github.com hasta permitir que **Agent Merge** incorpore una solicitud de cambios. - -Vamos a automatizar parte del trabajo recurrente, comentar procedimientos recomendados y descubrir cómo continuar. - -## Automatizar el trabajo recurrente - -La aplicación puede ejecutar agentes según una programación o bajo demanda mediante **automatizaciones**, una opción muy útil para tareas rutinarias como clasificar incidencias nuevas o resumir la actividad reciente. Vamos a crear una automatización sencilla y no destructiva. - -1. Selecciona **Automations** en la barra lateral y, después, **New automation**. -2. Asigna un nombre, como `Recap my recent work`. -3. Elige un desencadenador. **Manual** permite ejecutarla bajo demanda; **On a schedule** la ejecuta automáticamente; **When an issue is created** responde a incidencias nuevas. Para esta lección, elige **Manual**. -4. Introduce una indicación de solo lectura para que la automatización no pueda modificar nada, por ejemplo: - - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` - -5. Elige el proyecto, tu repositorio de Tailspin Toys, y crea la automatización. -6. Ejecútala bajo demanda para ver el resultado. - -> [!TIP] -> Las automatizaciones pueden ejecutarse en local o en la nube. Habilita **Run in the cloud** y elige las **Tools** que puede utilizar una automatización cuando quieras que se ejecute sin supervisión según una programación. Mantén las automatizaciones programadas bien delimitadas y sin acciones destructivas hasta que confíes en sus resultados. - -## Procedimientos recomendados - -Al utilizar cualquier herramienta de IA, la infraestructura que la rodea determina la calidad de los resultados. Los archivos de instrucciones, las habilidades y los agentes personalizados han contribuido al trabajo de este taller. Invierte en ellos y reutilízalos entre sesiones. - -Adapta el **modo y el modelo** a la tarea. Utiliza **Plan** para razonar sobre un enfoque antes de desarrollar, **Interactive** para mantener el control durante cambios concretos y **Autopilot** solo para tareas aisladas y bien delimitadas. Elige un modelo más rápido para las modificaciones rutinarias y otro más capaz, con mayor esfuerzo de razonamiento, para el trabajo complejo. - -El contexto sigue siendo tan importante como la infraestructura. Describir con claridad *qué* quieres crear, *por qué* y *cómo* cambia sustancialmente el resultado. Los chats rápidos son un buen lugar para delimitar una idea antes de dedicarle una sesión completa. - -## Más opciones para explorar - -Ya conoces el flujo de trabajo principal. Estas son algunas funcionalidades adicionales que merece la pena explorar: - -- **Quick chats** para preguntas rápidas y desechables que no necesitan una sesión completa. -- **Rubber duck** para razonar sobre un problema y obtener comentarios pertinentes antes de desarrollar. -- [**Agentes personalizados**][custom-agents] para encapsular un rol, sus herramientas y sus instrucciones con el fin de realizar trabajo especializado y repetible. -- [`/chronicle`][chronicle] para generar una narración de lo sucedido en una sesión. -- [Usar tu propia clave (BYOK)][byok] para utilizar modelos de tu propio proveedor, incluidos modelos locales mediante Ollama, Foundry Local o LM Studio. -- [Entornos aislados en la nube][sandboxes] para ejecutar sesiones en un entorno aislado hospedado en GitHub. -- [Vínculos profundos][deep-links] para abrir la aplicación directamente en un repositorio, una sesión o una indicación. - -## Pasos siguientes - -La mejor forma de mejorar con cualquier herramienta es seguir utilizándola. Úsala para código de producción, proyectos personales o esa pequeña aplicación que llevas años pensando en crear. Comparte lo que aprendas con el equipo y aprende de sus experiencias. Y, como siempre, consulta la documentación. - -Para explorar más elementos del ecosistema de GitHub Copilot, consulta el [recorrido de VS Code](../../vscode/), el [recorrido de Copilot CLI](../../cli/) o el [recorrido del agente en la nube](../../cloud/). - -## Recursos - -- [Acerca de la aplicación GitHub Copilot][about-copilot-app] -- [Introducción a la aplicación GitHub Copilot][getting-started] -- [Personalizar la aplicación GitHub Copilot][customize] -- [Utilizar automatizaciones][using-automations] -- [Trabajar con extensiones de lienzo][canvas-docs] -- [Acerca de los entornos aislados locales y en la nube][sandboxes] - -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app -[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started -[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app -[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle -[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models -[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/es-es/app/9-canvases.md b/docs/es-es/app/9-canvases.md new file mode 100644 index 00000000..bf7737fd --- /dev/null +++ b/docs/es-es/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "Lección 9 - Crear un lienzo de clasificación de incidencias" +description: "Crea y revisa un lienzo de clasificación guardado en el repositorio, combina la PR 4 y vuelve a abrirlo para añadir contexto de incidencias sin iniciar otra funcionalidad." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Hasta ahora has dirigido a los agentes mediante el chat. Sin embargo, gran parte del trabajo no reside en una conversación, sino en un tablero, un documento o una lista de comprobación. Los **lienzos** ofrecen al agente y a ti una superficie compartida para ese tipo de trabajo, directamente en la aplicación. En esta lección crearás un lienzo sencillo para planificar y realizar el seguimiento de la lista de trabajo pendiente que has estado abordando. + +En esta lección: + +- comprenderás qué es un lienzo y cuándo utilizarlo. +- crearás un lienzo compartido con un tablero Kanban para clasificar la lista de trabajo pendiente. +- guardarás el lienzo en el repositorio y lo combinarás para el equipo. +- volverás a abrir el lienzo y añadirás contexto de incidencias sin implementar otra funcionalidad. + +## Escenario + +Examinar una lista de incidencias puede resultar abrumador. Los desarrolladores de Tailspin Toys quieren una herramienta para clasificarlas y añadir sus detalles al contexto de una sesión. Añadir contexto no autoriza a implementar una incidencia; este ejercicio termina con un tablero reutilizable, no con una quinta PR. + +## ¿Qué es un lienzo? + +Un [lienzo][canvas-docs] es una superficie interactiva y compartida para un recurso de trabajo, como un plan, un tablero de clasificación, una lista de comprobación de versiones, un panel o un documento. Aunque el chat resulta adecuado para describir intenciones y razonar sobre ambigüedades, la mayor parte del trabajo se realiza en una *superficie*. Los lienzos permiten colaborar con el agente directamente sobre ella. + +Los lienzos son **bidireccionales**: el agente puede actualizar el lienzo mientras trabaja y tú puedes editar la misma superficie. Cuando creas un lienzo, el agente lo genera a partir de la indicación y el flujo de trabajo, y puedes pedirle que añada, elimine o revise capacidades a medida que avanzas. Una vez creado, el lienzo se abre en el panel derecho de la aplicación. + +Algunos ejemplos habituales son: + +- **Lienzos de Markdown** para planificar el día y priorizar incidencias y solicitudes de incorporación de cambios. +- **Tableros Kanban con agentes** en los que las personas y los agentes añaden tarjetas y desplazan el trabajo entre columnas. +- **Tableros de clasificación de incidencias** que resumen las incidencias principales y los temas recurrentes de un repositorio. + +## ¿Por qué utilizar un lienzo? + +Utiliza un lienzo cuando una tarea requiera estructura, iteración y verificación, y un chat no sea suficiente. Un lienzo permite: + +- basar el trabajo del agente en un recurso real que se adapte al flujo de trabajo. +- orientar o corregir el trabajo directamente en la superficie compartida y, después, permitir que el agente continúe a partir de los cambios. +- inspeccionar el progreso como cambios visibles en un recurso, no solo como respuestas del chat. + +## Crear un lienzo para realizar el seguimiento del trabajo + +Confirma que la PR 3 se ha combinado. Las valoraciones por estrellas, el estándar de documentación, la funcionalidad de filtrado, la habilidad de calidad y el perfil QA deben estar en `main` antes de empezar el lienzo. Utiliza una sesión nueva y una rama para este último hito de PR. + +1. Vuelve a la aplicación GitHub Copilot o ábrela. +2. Selecciona **Home screen**. +3. Comprueba que `tailspin-toys` esté seleccionado como repositorio. +4. Elige **new working tree** y el modo **Interactive**. Envía esta solicitud de estado inicial antes de crear archivos: + + ```plaintext + Prepara esta nueva sesión de lienzo sin implementar nada. Confirma que es un worktree nuevo y limpio, obtén los cambios de origin y actualiza la rama de la sesión actual mediante un avance rápido hasta origin/main. Informa de la copia de trabajo, la rama y las revisiones coincidentes de HEAD y origin/main. Verifica que la PR de filtrado está combinada y que están presentes la funcionalidad de filtrado, la habilidad quality-checks y el perfil QA. + + Detente si hay cambios pendientes, divergencias o falta la combinación anterior. No restablezcas, no descartes trabajo, no cambies de rama ni crees otra rama. Detente después de comunicar el estado inicial. + ``` + +5. Comprueba el informe del estado inicial y solicita el lienzo guardado en el repositorio: + + ```plaintext + Crea un lienzo Kanban básico de clasificación de incidencias guardado en este repositorio mediante el flujo de extensiones de lienzo compatible con la aplicación. Guarda su definición en .github/extensions/ para que el equipo pueda reutilizarlo. Examina las extensiones existentes y consérvalas; no sobrescribas el explorador de base de datos incluido. + + Lee las incidencias abiertas actuales. Destaca las tres con más probabilidades de necesitar atención y muestra las demás debajo. Incluye en cada incidencia destacada su título, un resumen del contenido, la URL y una justificación de su prioridad. Trata la clasificación como sugerencia, no como instrucción para modificar incidencias. + + Proporciona en cada tarjeta una acción Add to current context que adjunte los detalles de la incidencia solo a esta sesión. No debe iniciar la implementación, crear sesiones o ramas, cambiar el estado de la incidencia ni crear PR. Mantén el alcance del lienzo acotado y hazlo accesible mediante teclado. + + Muéstrame los archivos generados y abre el lienzo para revisarlo. No cambies el código de la aplicación, no crees commits, no envíes cambios ni crees una PR. Pregunta antes de instalar cualquier cosa o añadir dependencias. + ``` + +Copilot crea los archivos del lienzo y abre la superficie compartida. Revisa la extensión generada antes de confiar en sus acciones; es contenido ejecutable del repositorio, no solo una imagen. + +> [!NOTE] +> Si la primera versión necesita mejoras, solicita cambios específicos dentro del alcance de clasificación de incidencias. No conviertas este ejercicio en la implementación de una incidencia pendiente. + +## Revisar y probar el lienzo + +1. Abre **Changes** y confirma que la definición del lienzo se guarda en el repositorio bajo `.github/extensions/`, no solo para tu usuario o sesión. Comprueba que las extensiones existentes y los archivos de la aplicación no han cambiado. +2. Compara el tablero con las incidencias abiertas reales y evalúa las explicaciones de la clasificación. +3. Comprueba que las tarjetas y los controles se leen bien y se pueden utilizar con teclado. +4. Selecciona **Add to current context** en una incidencia y confirma que solo sus detalles se añaden a la conversación. No debe iniciarse ninguna implementación ni cambio de estado de la incidencia. +5. Revisa las correcciones y pide a Copilot que ejecute la validación existente aplicable a los archivos modificados. Registra resultados y bloqueos, en lugar de suponer que una superficie interactiva funciona correctamente solo porque se ha abierto. + +## Guardar el lienzo y combinarlo con el repositorio + +El lienzo ya es un recurso del repositorio. Crea un commit y envía solo el trabajo revisado del lienzo como PR 4: + +1. En la misma sesión, envía: + + ```plaintext + Revisa las diferencias del lienzo de clasificación guardado en el repositorio y sus pruebas de validación. Crea un commit con los archivos del lienzo aprobados en la rama de esta sesión, envíala y crea una única PR destinada a main con la plantilla de PR del repositorio. Describe el comportamiento del lienzo y cómo hemos verificado que añadir una incidencia solo añade contexto. No combines todavía ni implementes una incidencia pendiente. + ``` + +2. Revisa todas las diferencias y comprobaciones de la PR en **My work**. Confirma que contiene el lienzo, no trabajo de la aplicación ajeno a la tarea. +3. En la misma sesión del lienzo, abre el menú desplegable de acciones de PR y selecciona **Agent merge**. Revisa sus acciones permitidas y mantén **Merge pull request** desactivado hasta aprobar el resultado final. +4. Define el alcance antes de iniciar Agent Merge: + + ```plaintext + Gestiona esta PR de lienzo existente con Agent Merge. Resuelve solo los bloqueos de revisión y CI dentro del alcance; pregunta antes de realizar cambios ajenos o instalaciones. Si cambia el lienzo, repite la validación afectada y actualiza las pruebas de verificación. No combines hasta que habilite explícitamente Merge pull request tras la revisión. No implementes incidencias pendientes ni crees otra PR. + ``` + +5. Selecciona **Agent merge** y revisa los cambios posteriores. Examina las comprobaciones reales de CI del repositorio del participante y resuelve los fallos; CI no sustituye las pruebas de uso del lienzo. + +6. Cuando las diferencias finales y las pruebas de verificación actuales estén aprobadas y se hayan superado las comprobaciones y revisiones obligatorias, autoriza explícitamente a Agent Merge a combinar seleccionando su menú desplegable y después **Merge pull request**. + + ![Menú desplegable Agent merge con las acciones permitidas al agente —Address reviews, Fix CI failures y Resolve conflicts— y una flecha que señala Merge pull request](../../_images/app-agent-merge-merge.png) + +7. Confirma que GitHub muestra la PR 4 como **Merged** antes de continuar. + +Ya has creado un lienzo compartido para el equipo. + +## Volver a abrir el lienzo sin iniciar otra funcionalidad + +Vuelve a abrir el lienzo guardado en el repositorio en la misma sesión del lienzo después de combinar su PR. Es un paso de inspección, no otra rama ni otro hito de PR. + +1. Vuelve a la sesión del lienzo, mantén el modo **Interactive** y cierra el panel del lienzo si sigue abierto. +2. Envía: + + ```plaintext + Vuelve a abrir el lienzo de clasificación de incidencias del repositorio en esta misma sesión. Añadiré una incidencia al contexto solo para examinar sus detalles. No edites archivos, no implementes la incidencia, no cambies su estado, no crees otra sesión o rama, no crees commits, no envíes cambios ni abras una PR. + ``` + +3. Confirma que el lienzo guardado se abre de nuevo sin regenerar su definición. +4. Selecciona **Add to current context** en una de las incidencias que más te interese. +5. Confirma que los detalles de la incidencia seleccionada aparecen en el contexto sin iniciar la implementación. Detente aquí: el taller tiene cuatro hitos de PR, no cinco. + +Has utilizado un lienzo creado por ti para agilizar el proceso de desarrollo. + +## Resumen y pasos siguientes + +Has creado una superficie compartida en la que puedes colaborar con el agente. En concreto: + +- has aprendido qué son los lienzos y cuándo utilizarlos. +- has creado con el agente un lienzo compartido con un tablero Kanban para clasificar incidencias. +- has guardado y combinado el lienzo con el repositorio mediante Agent Merge. +- has vuelto a abrir el lienzo combinado y añadido contexto de incidencias sin iniciar otra funcionalidad. + +Con la lista de trabajo pendiente organizada, da un paso atrás para revisar todo lo que has creado y descubrir cómo continuar. Continúa con la [Lección 10 - Repaso y pasos siguientes][next-lesson]. + +## Recursos + +- [Trabajar con extensiones de lienzo en la aplicación GitHub Copilot][canvas-docs] +- [Lienzos en Awesome Copilot][awesome-copilot-canvases] +- [Acerca de la aplicación GitHub Copilot][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/es-es/app/README.md b/docs/es-es/app/README.md index 3607a893..e6be0557 100644 --- a/docs/es-es/app/README.md +++ b/docs/es-es/app/README.md @@ -3,12 +3,14 @@ slug: es-es/app title: "Aplicación GitHub Copilot" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- La [**aplicación GitHub Copilot**](https://docs.github.com/copilot/concepts/agents/github-copilot-app) es una aplicación de escritorio basada en Copilot CLI que reúne el desarrollo dirigido por agentes en un único espacio de trabajo específico. Añade sesiones de agente en paralelo, modos de sesión intercambiables, lienzos compartidos y gestión nativa de incidencias y solicitudes de incorporación de cambios de GitHub, incluido **Agent Merge**, que guía una solicitud durante reorganizaciones de base, comentarios de revisión, correcciones de CI y la combinación. -A lo largo de estas lecciones instalarás la aplicación y configurarás el proyecto. Después, conocerás el espacio de trabajo de la aplicación y la lista de trabajo pendiente que la plantilla ha creado para ti. Empezarás con un cambio pequeño, añadir una valoración por estrellas, y luego añadirás desde una incidencia un estándar de instrucciones personalizadas, crearás una funcionalidad de filtrado en una sesión de agente aislada y la verificarás con una habilidad reutilizable. Añadirás el servidor MCP de Playwright para explorar la funcionalidad en un navegador real y avanzarás por niveles crecientes de automatización de combinaciones hasta que **Agent Merge** incorpore la solicitud. Por último, colaborarás en un lienzo compartido y automatizarás el trabajo recurrente: un ciclo completo desde la idea hasta una funcionalidad combinada. +Las Lecciones 0–1 de configuración preparan el proyecto y el espacio de trabajo de la aplicación. Los nueve módulos principales, las Lecciones 2–10, empiezan con una mejora rápida de valoraciones por estrellas y una convención de documentación demostrada en código real. Después planificarás y crearás el filtrado, crearás y ejecutarás una habilidad quality-checks con scripts de shell, observarás la funcionalidad mediante MCP de Playwright y crearás un agente personalizado QA para evaluar requisitos y cobertura. Revisarás la PR completa de la funcionalidad y autorizarás Agent Merge; después crearás y combinarás un lienzo compartido de clasificación de incidencias. + +El taller tiene cuatro hitos de PR: valoraciones por estrellas; instrucciones con su demostración; filtrado con la habilidad, el perfil QA y las pruebas; y, por último, el lienzo. Empieza cada hito desde `main` actualizado, con una rama por PR en lugar de una por módulo. Las Lecciones 4–8 permanecen en la misma sesión, worktree y rama de filtrado. Volver a abrir el lienzo añade contexto de incidencias sin iniciar otra funcionalidad ni una quinta PR. Las automatizaciones se enlazan como siguiente paso, no como ejercicio adicional. ## Lecciones @@ -16,13 +18,15 @@ A lo largo de estas lecciones instalarás la aplicación y configurarás el proy |--------|-------|-------------| | [0. Requisitos previos][ex0] | Configuración | Instala Node.js y crea tu copia del proyecto Tailspin Toys | | [1. Instalar la aplicación Copilot][ex1] | Configuración | Instala la aplicación, conecta el proyecto y familiarízate con el espacio de trabajo | -| [2. Ejecutar tu primera sesión de agente][ex2] | Primer cambio | Inicia una sesión y publica un pequeño cambio como tu primera solicitud de incorporación de cambios | -| [3. Guiar a Copilot con instrucciones personalizadas][ex3] | Contexto | Añade un estándar de documentación desde una incidencia y combínalo | -| [4. Crear una funcionalidad con Autopilot][ex4] | Funcionalidad principal | Utiliza Plan y Autopilot para crear el filtrado y verifícalo con una habilidad | -| [5. Realizar pruebas con MCP de Playwright][ex5] | Herramientas externas | Añade el servidor MCP de Playwright y explora la funcionalidad en un navegador | -| [6. Combinar cambios con Agent Merge][ex6] | Combinación | Deja que Agent Merge corrija e incorpore la solicitud de filtrado | -| [7. Planificar con lienzos][ex7] | Colaboración | Crea un lienzo compartido para planificar y realizar el seguimiento del trabajo | -| [8. Repaso y pasos siguientes][ex8] | Resumen | Automatiza tareas recurrentes y descubre cómo continuar | +| [2. Añadir valoraciones por estrellas: una mejora rápida][ex2] | Primer cambio | Muestra las valoraciones existentes y la alternativa para null y combina la PR 1 | +| [3. Guiar a Copilot con instrucciones personalizadas][ex3] | Contexto | Añade un estándar de documentación y una demostración real y combina la PR 2 | +| [4. Crear el filtrado con Plan y Autopilot][ex4] | Implementación | Aprueba el plan, implementa y comprueba el filtrado y guarda un punto de control | +| [5. Crear y utilizar una habilidad quality-checks][ex5] | Comprobaciones repetibles | Crea, revisa y ejecuta los scripts de shell incluidos | +| [6. Validar la funcionalidad con MCP de Playwright][ex6] | Observación en el navegador | Configura MCP mediante Customize y examina el comportamiento del filtrado | +| [7. Crear y utilizar un agente QA][ex7] | Requisitos y cobertura | Selecciona un perfil especializado y reúne pruebas de verificación final | +| [8. Crear y combinar la PR de la funcionalidad][ex8] | Revisión y combinación | Revisa el filtrado, la habilidad, el perfil QA y las pruebas y autoriza Agent Merge para la PR 3 | +| [9. Crear un lienzo de clasificación de incidencias][ex9] | Colaboración | Comparte un lienzo guardado en el repositorio en la PR 4 y añade contexto de incidencias | +| [10. Repaso y pasos siguientes][ex10] | Resumen | Revisa el flujo, los recursos creados y otros materiales | ## Requisitos previos @@ -50,9 +54,11 @@ Antes de asistir a este taller, asegúrate de disponer de: [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students \ No newline at end of file diff --git a/docs/ja-jp/README.md b/docs/ja-jp/README.md index 04db18c9..3ecea3e1 100644 --- a/docs/ja-jp/README.md +++ b/docs/ja-jp/README.md @@ -27,7 +27,7 @@ GitHub Copilot は、どの環境で作業していても利用できます。 ### 🤖 [Copilot App](app/) -**GitHub Copilot app** は、Copilot CLI を基盤とするデスクトップ アプリケーションです。複数のエージェント セッションを並行して実行し、セッション モードの切り替え、キャンバスでの共同作業、GitHub Issue と pull request の管理をアプリ内で行えます。さらに **Agent Merge** を使用すると、リベース、レビュー フィードバックへの対応、CI の修正、マージまで、pull request の一連の作業を進められます。 +**GitHub Copilot app** は、Copilot CLI を基盤とするデスクトップ アプリケーションです。同じセットアップと9つのコアモジュールを通じて、星評価、指示、フィルター機能、スキル、MCP、QA、機能の PR という流れに取り組みます。アプリの分離されたセッションと **Agent Merge** を使用します。4つ目の pull request のマイルストーンとして、リポジトリに保存するキャンバスを作成してマージし、最後に振り返ります。 ### ☁️ [Copilot Cloud Agent](../cloud/) diff --git a/docs/ja-jp/app/0-prerequisites.md b/docs/ja-jp/app/0-prerequisites.md index 10329a2d..909ca044 100644 --- a/docs/ja-jp/app/0-prerequisites.md +++ b/docs/ja-jp/app/0-prerequisites.md @@ -15,18 +15,18 @@ GitHub Copilot app は、Copilot と GitHub の両方を一元的に扱うデス ## Node.js をインストールする -いくつかのレッスンでは、エージェントに機能を構築させ、Tailspin Toys のテストスイートをローカルで実行します。そのためには [**Node.js**][nodejs] (プロジェクトに必要な唯一のランタイム) が必要です。バージョン **22 以降**をインストールしてください。現在の **LTS** リリースを選ぶと安心です。 +いくつかのレッスンでは、エージェントに機能を構築させ、Tailspin Toys のテストスイートをローカルで実行します。そのためには [**Node.js**][nodejs] が必要です。**Node.js 22.13 以降**を使用し、チェックアウトの `package.json` と README でサポートされるバージョンを確認してください。 どのプラットフォームでも、公式インストーラーを使うのが最も簡単です。 1. Windows Terminal、macOS のターミナル、または普段使用しているターミナルを開きます。 -2. 次のコマンドを実行し、Node.js 22 以降がインストールされていることを確認します。 +2. 次のコマンドを実行し、Node.js 22.13 以降がインストールされていることを確認します。 ```shell node --version ``` -3. `v22` 以上のバージョン番号が表示された場合は、次のセクションに進めます。 +3. 表示されたバージョンが `v22.13.0` 以降で、プロジェクトでサポートされている場合は、次のセクションに進めます。 > [!TIP] > Node.js がインストールされていない場合、または更新が必要な場合にのみ、以降の手順を実行してください。 @@ -41,10 +41,10 @@ GitHub Copilot app は、Copilot と GitHub の両方を一元的に扱うデス node --version ``` -9. `v22.x.x` 以上が表示されることを確認します。 +9. 表示されたバージョンが `v22.13.0` 以降で、プロジェクトでサポートされていることを確認します。 -> [!TIP] -> コンテナーを使用する場合、[**Docker**][docker] があれば、Node.js をローカルにインストールする代わりにリポジトリの [dev container][dev-containers] を使用できます。dev container には Node.js が含まれているため、両方を用意する必要はありません。 +> [!IMPORTANT] +> この App の学習パスではローカルのワークツリーを使用します。コンテナー内にだけインストールしたランタイムは、ローカルセッションでは利用できません。各ワークツリーには、プロジェクトの依存関係と E2E チェック用の Playwright Chromium も必要です。ワークツリーの準備では学習用リポジトリの README に従い、インストールの要求は内容を確認してから承認してください。 ## ラボ用リポジトリを設定する @@ -64,6 +64,8 @@ Tailspin Toys プロジェクトの自分用コピーを使って作業します > [!NOTE] > テンプレートからリポジトリを作成すると、GitHub Issue のバックログが自動的に作成されます。ワークショップ全体を通してこれらの Issue を使用するため、自分で作成する必要はありません。 +改訂済みテンプレートの新しいコピーを使用してください。リポジトリの指示、アプリケーションコード、テスト、既存のキャンバス拡張機能が含まれますが、カスタムエージェントやスキルは同梱されていません。ワークショップ中に独自の quality-checks スキルと QA プロファイルを作成します。古いコピーを使う場合は、既存のカスタマイズを上書きせず、内容を確認してください。 + ## まとめと次のステップ 準備が整いました。プロジェクトをコンピューター上でビルドしてテストできるように Node.js をインストールし、テンプレートから Tailspin Toys リポジトリの自分用コピーを作成しました。 @@ -79,7 +81,5 @@ Tailspin Toys プロジェクトの自分用コピーを使って作業します [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/1-install-copilot-app.md b/docs/ja-jp/app/1-install-copilot-app.md index 39325f0d..554abc19 100644 --- a/docs/ja-jp/app/1-install-copilot-app.md +++ b/docs/ja-jp/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ GitHub Copilot app を使用するには、まずアプリをインストール プロジェクトを接続したら、各領域を確認します。アプリのサイドバーは、主に次の領域で構成されています。 -- **Sessions** - エージェントが作業する場所です。各セッションは分離された独自のワークスペースで実行されるため、変更が競合することなく複数のセッションを同時に実行できます。次のレッスンで最初のセッションを開始します。 +- **Sessions** - エージェントが作業する場所です。このワークショップでは **new working tree** を選択し、各 PR マイルストーンに専用の分離されたチェックアウトとブランチを用意します。ほかのワークスペースの選択肢もありますが、ここでは使用しません。 - **Quick chats** - 独自のブランチやワークスペースを必要としない、質問やブレインストーミング向けの簡易的な会話です。このレッスンの最後に試します。 - **My work** - アプリの **GitHub ネイティブ統合**を通じて表示される Issue と pull request です。アプリを離れずに、Issue と pull request の参照や絞り込み、CI ステータスの確認、Issue からのセッション開始、pull request のレビューを行えます。 -- **Automations** - スケジュールまたはオンデマンドで実行する、保存済みのエージェントタスクです。ハーネスの終盤で作成します。 +- **Customize** - MCP server、スキル、キャンバスを検索・管理します。Playwright MCP の設定に使用します。 +- **Automations** - スケジュールまたはオンデマンドで実行する、保存済みのエージェントタスクです。振り返りでは次のステップとしてリンクを紹介し、追加の演習にはしません。 ### 用意されたバックログを確認する アプリは GitHub とネイティブに統合されているため、リポジトリで待機中の作業がアプリ内に表示されます。テンプレートからリポジトリを作成したときに、バックログとなる Issue が用意されています。表示されていることを確認します。 1. サイドバーで **My work** を選択します。 -2. テンプレートはバックログに 8 件の Issue を用意しています。このハーネスでは次の 3 件に焦点を当てます。表示されていることを確認してください。 +2. Issue 番号を決めつけず、次のタイトルで検索します。 - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. Issue を選択して詳細を読みます。各 Issue はエージェントセッションの開始点にもなります。ハーネスの後半では、これらの Issue から作業を開始します。 +3. Issue を選択して詳細を読みます。各 Issue はエージェントセッションの開始点にもなります。ハーネスの後半では、これらの Issue から作業を開始します。ほかのバックログの Issue はキャンバスのコンテキストとして使用し、追加の実装タスクにはしません。 > [!NOTE] > My work の項目一覧は自動的に絞り込まれ、Copilot app に追加したリポジトリの項目だけが表示されます。ほかのリポジトリの作業項目を表示するには、そのリポジトリをアプリに追加してください。 @@ -70,7 +70,7 @@ GitHub Copilot app を使用するには、まずアプリをインストール 2. アプリのセッションがどのように動作するかを尋ねます。 ```plaintext - How does the GitHub Copilot app use worktrees? + GitHub Copilot app はワークツリーをどのように使用しますか。 ``` 3. 会話ビューで回答を読みます。各セッションが分離された独自の git worktree で実行されるため、変更が競合することなく複数のエージェントを並列実行できることがわかります。会話はいつでも継続でき、新しいチャットも開始できます。 @@ -84,7 +84,13 @@ GitHub Copilot app をインストールし、プロジェクトを接続して - ワークスペースを確認し、**My work** で用意されたバックログを見つける。 - クイックチャットを使って、その場限りの簡単な質問をする。 -次は、最初のエージェントセッションを開始し、ゲームカードに星評価を表示する最初の変更をプロジェクトに加えます。[レッスン 2「最初のエージェントセッションの実行」][next-lesson]に進んでください。 +## PR マイルストーンを分ける + +4つの PR をマージします。星評価、指示と小さな実証、フィルター機能とスキル・QA プロファイル・テスト、そしてトリアージキャンバスです。PR マイルストーンごとに1つのブランチを使用します。レッスン4~8では同じフィルター機能のセッション、ワークツリー、ブランチを維持し、追加の PR ではなくチェックポイントコミットを作成します。 + +App の新しいワークツリーは、古いローカル状態から始まる場合があります。各マイルストーンでファイルを編集する前にリポジトリをフェッチし、新しいセッションのブランチを最新の `origin/main` まで fast-forward してください。以降のレッスンで手順を明示します。ブランチを積み重ねたり、以前の作業を cherry-pick したり、作業中のフィルター機能のセッションを別のブランチに切り替えたりしないでください。 + +次は、最初のエージェントセッションを開始し、ゲームカードに星評価を表示する最初の変更をプロジェクトに加えます。[レッスン 2「星評価の追加で小さな成果を得る」][next-lesson]に進んでください。 ## リソース @@ -92,7 +98,7 @@ GitHub Copilot app をインストールし、プロジェクトを接続して - [GitHub Copilot app の概要][getting-started] - [GitHub Copilot app でのエージェントセッションの操作][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/ja-jp/app/10-review.md b/docs/ja-jp/app/10-review.md new file mode 100644 index 00000000..ff5b5200 --- /dev/null +++ b/docs/ja-jp/app/10-review.md @@ -0,0 +1,87 @@ +--- +title: "レッスン 10 - 振り返りと次のステップ" +description: "App の9つのコアモジュール、4つの PR マイルストーン、再利用可能な品質管理ワークフローを振り返り、追加のリソースを確認します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +ここ数回のレッスンでは、GitHub Copilot app を使い、アイデアから機能のマージまでを実践しました。取り組んだ内容は次のとおりです。 + +- リポジトリを接続し、アプリのワークスペースと用意されたバックログを確認した。 +- 直接指定したタスクと Issue からセッションを開始し、Plan モードと Autopilot モードでエージェントの動作を制御した。 +- カスタム指示でエージェントをガイドし、シェルスクリプトを含む再利用可能なスキルの作成を依頼して、スクリプトを確認した後、lint、単体テスト、エンドツーエンドテスト、型チェックを実行した。 +- Playwright MCP server を使い、実際のブラウザーで作業をテストした。 +- 要件、カバレッジ、スキルのスクリプトの結果、ブラウザーでの証拠を評価する QA カスタムエージェントを作成して選択した。 +- 共有キャンバスでエージェントと共同作業した。 +- 最初の PR を自分で明示的にマージし、その後、機能とキャンバスの PR ワークフローで **Agent Merge** を承認した。 + +セットアップのレッスン0~1から、9つのコアモジュールであるレッスン2~10に進みました。成果物と次のステップを振り返りましょう。この振り返りで追加の実習タスクを始めることはありません。 + +## リリースしたもの + +ワークショップには4つの PR マイルストーンがあり、それぞれ更新済みの `main` から作成した専用のブランチを使用します。 + +1. **星評価:** ゲームカードに既存の `starRating` と明示的な未評価状態を表示します。 +2. **指示と実証:** ドキュメント規約を追加し、小さな実際のコード変更で効果を検証します。 +3. **フィルター機能と品質管理ワークフロー:** Issue を実装し、シェルスクリプトを同梱した `quality-checks` スキルと QA プロファイルを作成して、関連するテストも含めます。 +4. **リポジトリに保存したトリアージキャンバス:** 別の機能を自動実装せず、Issue のコンテキストを追加するボードを共有します。 + +レッスン4~8では、同じフィルター機能のセッション、ワークツリー、ブランチを使用しました。チェックポイントコミットで PR 3 内の進捗を保存し、スキル、MCP 設定、QA のために別の機能ブランチは必要ありませんでした。後のマイルストーンは、前の PR がマージされ、新しいセッションのブランチを `origin/main` から更新した後にのみ開始しました。 + +## 検証方法の違い + +最初の機能では既存の npm チェックを使用しました。フィルター機能では手動のブラウザー確認を追加しました。スキルは同梱のスクリプトで4つのチェックを繰り返し実行できるようにし、MCP はエージェントによる直接のブラウザー観察を追加し、QA は要件とカバレッジを最終検証と組み合わせました。PR では、提出するリビジョンに適用できる場合にのみ QA の証拠を再利用しました。 + +追加するテストは実際の不足を補うものにします。新しいテストが不要な QA 実行も正しい結果になり得ます。ツールの不足、スキップされたチェック、失敗は明示すべき阻害要因であり、成功ではありません。マージを承認する前にコードと証拠をレビューし、変更後は関連する証拠を更新してください。 + +## ベストプラクティス + +AI ツールを使用するときは、その周辺の基盤が出力の品質を左右します。このワークショップでは指示、スキル、QA プロファイルを作成しました。これらをレビューし、セッション間で再利用してください。カスタムエージェントは専門家としての役割と指示を定義し、利用可能なツールは設定とハーネスの権限によって決まります。スキルは、必要に応じて読み込む再利用可能なタスクの指示、実行可能なスクリプト、補助リソースをまとめます。カスタムエージェントも、スキルに同梱されたものを含め、スクリプトを実行できます。説得力のある説明だけを信頼せず、実際のスクリプト実行とカスタムエージェントの選択を確認してください。 + +タスクに合わせて**モードとモデル**を選択します。構築前にアプローチを検討するには **Plan**、対象を絞った変更で作業に関与し続けるには **Interactive**、範囲が明確で分離されたタスクに限って **Autopilot** を使用します。定型的な編集には高速なモデルを選び、複雑な作業には推論能力が高く、より多くの推論を行うモデルを選びます。 + +基盤と同じくらい、コンテキストも重要です。何を、なぜ、どのように構築するかを明確に説明すると、出力は大きく変わります。アイデアを本格的なセッションに移す前に範囲を決める場所として、Quick chats が役立ちます。 + +## さらに確認する機能 + +コアワークフローを学習しました。ほかにも確認する価値がある機能があります。 + +- 完全なセッションを必要としない、その場限りの簡単な質問に使用する **Quick chats**。 +- 最近の作業の要約など、定期的またはオンデマンドのタスクに使用する [**Automations**][using-automations]。導入前にスケジュール、権限、範囲をレビューしてください。自動化の作成は次のステップであり、このワークショップの一部ではありません。 +- 構築前に問題について対話し、重要なフィードバックを得るための **Rubber duck**。 +- ロール、その tools、指示をまとめ、繰り返し使用する専門的な作業に対応する [**Custom agents**][custom-agents]。 +- セッションで起きたことの記録を生成する [`/chronicle`][chronicle]。 +- Ollama、Foundry Local、LM Studio を介したローカルモデルなど、独自のプロバイダーのモデルを使用する [Bring your own key (BYOK)][byok]。 +- GitHub がホストする分離環境でセッションを実行する [Cloud sandboxes][sandboxes]。 +- アプリを直接リポジトリ、セッション、プロンプトの画面で開く [Deep links][deep-links]。 + +## 次のステップ + +ツールを使いこなす最良の方法は、使い続けることです。実稼働コード、趣味のコード、長年構想していながら構築できていなかった小さなアプリなどに活用してください。学んだことをチームと共有し、チームからも学びましょう。そして、引き続きドキュメントを確認してください。 + +GitHub Copilot エコシステムをさらに学ぶには、[VS Code ハーネス][vscode-harness]、[Copilot CLI ハーネス][cli-harness]、[Cloud agent ハーネス][cloud-harness]を確認してください。 + +## リソース + +- [GitHub Copilot app について][about-copilot-app] +- [GitHub Copilot app の概要][getting-started] +- [GitHub Copilot app のカスタマイズ][customize] +- [Automations の使用][using-automations] +- [Canvas extensions の操作][canvas-docs] +- [クラウドサンドボックスとローカルサンドボックスについて][sandboxes] + +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app +[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started +[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app +[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes +[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle +[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents +[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models +[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/ja-jp/app/2-add-star-rating.md b/docs/ja-jp/app/2-add-star-rating.md index b1edad2c..046a81da 100644 --- a/docs/ja-jp/app/2-add-star-rating.md +++ b/docs/ja-jp/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "レッスン 2 - 最初のエージェントセッションの実行" +title: "レッスン 2 - 星評価の追加で小さな成果を得る" description: "GitHub Copilot app で最初のエージェントセッションを開始し、ゲームカードに小さな変更を加えて、最初の pull request としてマージします。" authors: - geektrainer @@ -22,7 +22,7 @@ Tailspin Toys の各ゲームには星評価を設定でき、ゲーム詳細ペ ## セッションの構造 -**セッション**とは、分離された独自のワークスペースで実行されるエージェントとの会話です。すべてのセッションに**専用の git worktree とブランチ**が割り当てられます。そのため、一方では機能を追加し、もう一方ではバグを修正するなど、変更を競合させずに複数のセッションを同時に実行できます。セッションはリポジトリごとにグループ化されてサイドバーに表示され、選択すると切り替えられます。 +**セッション**とは、エージェントとの会話です。このワークショップでは **new working tree** を選択し、セッション専用のチェックアウトとブランチを用意します。レッスンごとにブランチを分けず、各 PR マイルストーンを分離できます。セッションはリポジトリごとにグループ化されてサイドバーに表示され、選択すると切り替えられます。 セッション内には、エージェントとの**会話**、ファイルを調査および編集するときのエージェントの**ツールアクティビティ**、差分付きの**変更済みファイル**一覧という3つの要素が表示されます。 @@ -36,16 +36,20 @@ Tailspin Toys の各ゲームには星評価を設定でき、ゲーム詳細ペ ![リポジトリセレクターに tailspin-toys が設定され、プロンプトの下にモデルセレクターが表示された GitHub Copilot app のプロンプトボックス](../../_images/app-2-start-session.png) -4. 次のプロンプトを使って変更を依頼します。 +4. プロンプトボックスの下で **new working tree** と **Interactive** モードを選択します。次のプロンプトを使って変更を依頼します。 ```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. + 編集前にチェックアウトとブランチを特定し、未コミットの変更がない新しいワークツリーであることを確認して、origin をフェッチし、このセッションのブランチを origin/main まで fast-forward してください。HEAD と origin/main が一致することを確認してください。未コミットの変更、分岐、更新できない問題がある場合は停止して説明し、リセットや作業の破棄はしないでください。 + + ゲームカードに各ゲームの星評価を表示してください。Game 型には starRating フィールドがすでにあり、5点満点の数値、または未評価の場合は null が入ります。src/components/GameCard.astro の各カードに表示し、starRating が null の場合は代わりに "No rating yet" と表示してください。変更は小さく保ち、カードのレイアウトの再構成やデータモデルの変更はしないでください。 + + リポジトリの指示に従い、適切なテストを追加または更新して、関連する既存の npm チェックを実行してください。前提条件を調べ、インストールの前に確認してください。変更したファイルとチェック結果を報告したら、レビューのために停止してください。コミット、プッシュ、pull request の作成、別の機能の実装はしないでください。 ``` > [!NOTE] > プロンプトに、Copilot が更新するファイル名が含まれていることに注目してください。Copilot が作業に含めるファイルを指定する必要はありませんが、方向性を示すことで、コードをすばやく生成し、トークン使用量を削減できます。 -5. Enter を選択して、プロンプトを Copilot に送信します。 +5. Enter を押して、プロンプトを Copilot に送信します。 Copilot app は、最初にプロジェクトの分離されたコピーである新しい worktree を作成して作業を開始します。次にプロジェクトを調査し、新機能の追加に必要な更新対象ファイルを見つけて、必要なコードを作成します。これで Copilot app を使って新機能を追加できました。 @@ -76,7 +80,9 @@ AI が生成したすべての変更は、どれほど小さくてもマージ ## 変更を確認する -コードを読むだけで動作すると判断せず、視覚的にもテストします。そのためには、ターミナルからアプリを起動して、すべてが動作することを確認する必要があります。Copilot app にはターミナルが組み込まれています。 +ブラウザーを開く前に、エージェントの自動チェック結果をレビューします。まだ作成していないスキルではなく、プロジェクトの既存の npm スクリプトを使い、数値の `starRating` と `null` の場合の代替表示をテストしていることを確認します。前提条件が不足していたり、チェックがスキップされていたりする場合は成功ではありません。 + +次にセッション内蔵のターミナルでアプリを手動確認します。サーバーを起動する前にワークツリーを特定し、別のチェックアウトのサーバーを再利用しないでください。 1. Copilot app の右側にあるレビューパネルで **Terminal** を選択します。**Terminal** ボタンがない場合は、**+** (**Open in panel** というラベルが付いています) を選択してから **Terminal** を選択します。 @@ -89,26 +95,30 @@ AI が生成したすべての変更は、どれほど小さくてもマージ ``` 3. サーバーが起動したら、ブラウザーウィンドウを開きます。起動には少し時間がかかります。 -4. http://localhost:4321 に移動します。 -5. ランディングページのすべてのゲームに星評価が表示されていることを確認します。 +4. サーバーが出力したローカル URL を開きます。通常は `http://localhost:4321` です。ポートが使用中の場合は、無関係なプロセスを停止せず所有者を特定します。 +5. 評価済みのゲームカードに5点満点の値が表示されることを確認します。未評価のデータがある場合は **No rating yet** が表示されることを確認します。ない場合は、観察したと主張せず、自動テストで null のケースを検証します。 6. ターミナルウィンドウに戻ります。 -7. Ctrl+C を選択して開発サーバーを停止します。 +7. Control+C (Mac) または Ctrl+C (Windows/Linux) を押し、自分で起動した開発サーバーを停止します。 ## 最初の pull request を作成してマージする -変更に問題がないことを確認できたので、リリースします。エージェントに pull request の作成を依頼し、github.com で自分でレビューしてマージします。今回は手動で管理します。後のレッスンでは、Copilot でこの作業の一部を自動的に処理する方法を確認します。 +変更に問題がないことを確認できたので、PR 1 を作成します。まず、実装とは別にコミットと PR の作成を承認します。 + +```plaintext +星評価の変更とそのテストの差分全体をレビューし、検証結果をまとめて、レビュー済みの変更をこのセッションのブランチにコミットしてください。ブランチをプッシュし、リポジトリの PR テンプレートを使って main を対象とする pull request を作成してください。マージはしないでください。 +``` -1. 右上隅にある **Create PR** を選択します。 +1. セッション内の作成済み PR のリンクを開きます。アプリに **Create PR** の確認が表示された場合は、それを選択して依頼を承認し、2つ目の PR は作成しないでください。 2. 求められた場合は **Sign in with your browser** を選択し、画面の指示に従って認証します。 3. Copilot が PR の作成を開始します。 -PR が作成されると、Copilot はリポジトリで実行する必要があるワークフローを監視します。しばらくすると、右上のボタンが **Ready to merge** に変わります。これは PR をマージする準備が整ったことを示します。 +PR が作成されたら、**My work** で PR の差分全体とチェックを確認します。学習用リポジトリのワークフロー結果を読み、必須のチェックとレビューが完了するのを待ち、失敗に対処してからマージします。**Ready to merge** は、変更のレビューやローカルで得た証拠の代わりにはなりません。 4. チャットのすぐ上にある **PR** バブルを選択し、レビューペインで PR を開いて pull request を確認します。必要に応じて、ここで PR をレビューできます。 5. 準備ができたら **Ready to merge** を選択します。 6. 新しいダイアログウィンドウで **Merge pull request** を選択し、pull request をマージします。 -これで Web サイトに新機能を反映できました。 +続行前に PR 1 が `main` にマージされたことを確認します。学習用リポジトリのマージだけで Web サイトがデプロイされるわけではありません。次のレッスンでは新しいワークツリーを開始し、`origin/main` から更新してこの PR を取り込みます。 ## まとめと次のステップ @@ -118,7 +128,7 @@ PR が作成されると、Copilot はリポジトリで実行する必要があ - ゲームカードに小規模で対象を絞った変更を加えるようエージェントに指示した。 - ワークスペースの差分ビューで変更をレビューした。 - アプリをローカルで実行し、ブラウザーで星評価を確認した。 -- pull request を作成し、github.com で自分でマージした。 +- PR 1 を作成し、チェックをレビューして、明示的にマージした。 次は、アプリを使ってリポジトリにカスタム指示の標準を追加します。バックログ内の Issue の1つから作業を開始します。[レッスン 3「カスタム指示による Copilot のガイド」][next-lesson]に進んでください。 @@ -129,6 +139,7 @@ PR が作成されると、Copilot はリポジトリで実行する必要があ - [GitHub Copilot app での Issue と pull request の管理][managing-issues-prs] [prior-lesson]: ../1-install-copilot-app/#github-copilot-app-をインストールして構成する +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/ja-jp/app/3-custom-instructions.md b/docs/ja-jp/app/3-custom-instructions.md index 8b801657..51030e7d 100644 --- a/docs/ja-jp/app/3-custom-instructions.md +++ b/docs/ja-jp/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "レッスン 3 - カスタム指示による Copilot のガイド" -description: "GitHub Copilot app を使い、バックログの Issue から始めてカスタム指示の標準をリポジトリに追加し、変更を pull request としてマージします。" +description: "ドキュメント標準を追加し、小さな既存のヘルパーまたはコンポーネントで効果を確認して、両方を2つ目の pull request としてマージします。" authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- 生成 AI を扱うとき、コンテキストは重要です。タスクを特定の方法で実行する必要がある場合や、Copilot が把握しておくべき背景情報がある場合は、そのコンテキストを利用できるようにします。特に強力なツールの1つが[指示ファイル][instruction-files]です。指示ファイルには、必要なコードの内容だけでなく、その構成方法も記述します。このレッスンでは、リポジトリにドキュメント標準を追加します。ここから先の多くの作業と同様に、バックログの Issue から開始し、エージェントに変更を行わせます。 @@ -12,15 +12,17 @@ lastUpdated: 2026-07-09 - リポジトリ指示とパス固有の指示ファイルがエージェントにどのように渡されるかを確認する。 - バックログ内の指示に関する Issue からセッションを開始する。 -- `.github/copilot-instructions.md` にドキュメント標準を追加するようエージェントに依頼する。 -- 変更をレビューし、pull request としてマージする。 +- 適切なリポジトリの指示ファイルに、対象を絞ったドキュメント標準を追加するようエージェントに依頼する。 +- 小さな実際のコード変更で標準の効果を確認し、検証して PR 2 をマージする。 ## シナリオ 優れた開発組織と同様に、Tailspin Toys にも開発プラクティスのガイドラインと要件があります。内容は次のとおりです。 -- TSDoc doc comment の形式でコードにドキュメントを追加する。 -- フォーマット方法を文書化し、lint によって適用する。 +- コメントはコードを言い換えるのではなく、意図や自明ではない判断を説明する。 +- `db/` と `src/lib/` のエクスポートされた関数には、目的、パラメーター、戻り値を TSDoc/JSDoc で記載し、注入可能な `db` 引数があればそれも説明する。 +- 再利用可能な Astro コンポーネントには `Props` の契約を文書化し、関連コードが変わったらコメントも最新に保つ。 +- 既存のフォーマットと lint のガイダンスを保持する。 指示ファイルを使用すると、示されたプラクティスに沿ってタスクを実行するために必要な情報を Copilot に提供できます。 @@ -28,13 +30,13 @@ lastUpdated: 2026-07-09 カスタム指示を使うと、Copilot にコンテキストと設定を提供でき、コーディングスタイルや要件をより正確に理解させることができます。Copilot をガイドし、より関連性の高い提案やコードスニペットを得るための強力な機能です。希望するコーディング規約、ライブラリ、コードに含めるコメントの種類まで指定できます。リポジトリ全体に適用する指示や、タスクレベルのコンテキストとして特定のファイル種類に適用する指示を作成できます。 -指示ファイルには2つの種類があります。 +このプロジェクトでは2種類の指示ファイルを使用します。 - `.github/copilot-instructions.md` は、リポジトリに対する**すべての**リクエストで Copilot に送信される単一の指示ファイルです。このファイルには、Copilot に送信するほとんどのチャットまたは CLI リクエストに関係する、プロジェクトレベルの情報を記載します。使用する技術スタック、構築するものの概要、ベストプラクティスなど、全体に適用するガイダンスを含められます。 - `.github/instructions/*.instructions.md` ファイルは、特定のタスクやファイル種類向けに作成できます。特定の言語 (TypeScript や Astro など) や、UI コンポーネントまたは新しい単体テスト一式の作成といったタスクに関するガイドラインを提供できます。 > [!NOTE] -> Copilot は AGENTS.md、CLAUDE.md、GEMINI.md を通じて指示のガイダンスを取り込むほかの標準もサポートしており、常に適切なコンテキストを提供できます。 +> ほかの指示形式やサポート状況はハーネスによって異なります。特定の形式を利用する前に、[カスタム指示のサポートリファレンス][custom-instructions-support]を確認してください。 ### 指示ファイルを管理するためのベストプラクティス @@ -74,49 +76,55 @@ AI の使い方に唯一の方法がないのと同様に、指示ファイル 11. 最後に `.github/instructions/drizzle.instructions.md` を開き、末尾まで移動します。ほかの指示ファイル (`unit-tests.instructions.md` など) と、プロジェクト内の既存ファイルへのリンクに注目してください。これにより、大きな指示セットを小さく再利用可能なファイルに分割し、コード生成時に参照する例を Copilot に提示できます。そこに記載されたパスは、リポジトリのルートではなく指示ファイルを基準とします。 > [!NOTE] -> `copilot-instructions.md` の **Code formatting requirements** セクションにはプロジェクトのコーディング標準が記載されていますが、コード内のドキュメントはまだ必須ではありません。次の手順で、TSDoc doc comment とファイルコメントヘッダーの規則を追加します。 +> 規則を追加する前に、既存のガイダンスと実際のコーディング標準の Issue を比較してください。このレッスンでは、すべてのファイルへの一律のヘッダーやコードの言い換えではなく、意図を説明するコメント、エクスポートされたデータレイヤー関数のドキュメント、Astro の `Props` の契約に焦点を当てます。 ## 指示に関する Issue から開始する -前のレッスンでは、直接入力したプロンプトからセッションを開始しました。しかし、多くの作業は Issue から始まります。指示ファイルを更新するために登録された Issue に基づいて新しいセッションを作成し、更新を依頼します。 +このセッションを作成する前に PR 1 がマージされたことを確認します。PR 2 用の新しいワークツリーを開始し、星評価のブランチでは続けないでください。多くの作業は Issue から始まるため、コーディング標準の Issue を要件として使用します。 > [!NOTE] > 指示ファイルは Copilot が生成するコードに大きな影響を与えるため、Copilot を明確にガイドする内容になっていることを慎重に確認してください。このレッスンのように、Copilot で最初のバージョンを作成した後、自分でレビューして更新内容が要件を満たすことを確認する方法が効果的です。 1. サイドバーで **My work** を選択します。 2. **Update our repository coding standards** というタイトルの Issue を選択して開きます。 -3. 右上の **New session** を選択し、Issue に基づく新しいセッションを開始します。 +3. 右上の **New session** を選択し、**new working tree** と **Interactive** モードを選択します。 ![GitHub Copilot app の Issue ビューで、右上の New session ボタンを矢印で示した画面](../../_images/app-new-session-from-issue.png) -4. 次のプロンプトを使い、Issue に記載された要件を満たすように指示ファイルを更新することを Copilot に依頼します。 +4. 次のプロンプトを使用します。編集前に新しいセッションのブランチを更新することで、アプリのローカルチェックアウトが古くても、マージ済みの最新の `main` から確実に開始できます。 - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + 編集前にチェックアウトとブランチを特定し、未コミットの変更がない新しいワークツリーであることを確認して、origin をフェッチし、このセッションのブランチを origin/main まで fast-forward してください。HEAD と origin/main が一致し、マージ済みの星評価の PR が含まれることを確認してください。未コミットの変更、分岐、そのマージの不足がある場合は停止し、リセット、作業の破棄、別のブランチの作成はしないでください。 + + "Update our repository coding standards" という Issue と既存のリポジトリの指示を読んでください。対象を絞ったドキュメント規約を追加してください。処理の仕組みではなく意図を説明し、db/ と src/lib/ のエクスポートされた関数には TSDoc/JSDoc で目的、パラメーター、戻り値、存在する場合は注入可能な db 引数を記載してください。再利用可能な Astro コンポーネントの Props の契約を文書化し、関連コードの変更時にはコメントを最新に保つようにしてください。 + + 各規則を適切な既存の指示ファイルに重複や矛盾なく配置し、README から更新した標準にリンクするか、その概要を記載してください。既存のフォーマットと lint のガイダンスを保持してください。一律のファイルヘッダーの要求、フォーマットツールの移行、アプリケーション全体のドキュメントの書き換え、フィルター機能の実装はしないでください。指示の差分を提示したらレビューのために停止してください。スキルやエージェントの作成、コミット、プッシュ、PR の作成はしないでください。 + ``` Copilot が更新を行います。 ## 変更をレビューする -Copilot が行った更新を読み、更新された指示に基づいて生成するコード例も提示させます。 +更新したガイダンスを読み、実際のファイルで効果を確認します。コードスニペットの提案だけでは、リポジトリの指示がコード変更に影響したことは示せません。 1. 右上の **Changes** を選択してコードの変更を開きます。 ![GitHub Copilot app のセッションパネルにあるタブで、Changes タブを矢印で示した画面](../../_images/app-select-changes.png) -2. 更新された指示ファイルをレビューします。コードにドキュメントとコメントを追加するためのガイドラインが含まれていることを確認します。 +2. 更新された指示ファイルと README の参照をレビューします。一律のファイルヘッダーを要求せず、Issue のコメント方針、エクスポートされた関数のドキュメント、コンポーネントの契約に規則が合っていることを確認します。 > [!NOTE] > AI は決定論的ではなく確率的に動作するため、実際のテキストは異なります。 -3. 次のプロンプトを使い、Copilot が今後生成するコード例を作成するよう依頼します。 +3. 指示をレビューした後、この同じセッションで範囲を限定した実証を依頼します。 + + ```plaintext + db/ または src/lib/ の小さな既存のエクスポートされた TypeScript ヘルパー1つ、または再利用可能な Astro コンポーネント1つで、更新したドキュメント規約を実証してください。リポジトリを調べて適切な既存ファイルを選び、publishers ヘルパーが存在すると決めつけないでください。動作を変えずに可読性を少し改善し、該当する関数ドキュメントや Props の契約のガイダンスを適用してください。コードを言い換えるだけのコメントは追加せず、自明ではない意図を説明してください。 - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + 変更はその実証と直接関連するテストに限定してください。フィルター機能の実装や新機能の作成はしないでください。関連する既存の npm チェックを実行し、変更内容と指示がコードに与えた影響を報告して、レビューのために停止してください。インストールの前には確認してください。コミット、プッシュ、PR の作成はしないでください。 + ``` -4. Copilot が提案するコードをレビューします。更新された指示で求めたとおり、TSDoc doc comment とファイルヘッダーコメントが含まれていることを確認します。 +4. チャットの応答だけでなく、実際のファイルの差分をレビューします。ドキュメントが実際の動作を説明し、可読性の改善によって動作が変わっていないことを確認します。関連するテスト、lint、型チェックの結果を確認し、失敗を解消してから続けます。 これでプロジェクトの指示ファイルを更新し、その効果を確認できました。 @@ -124,17 +132,23 @@ Copilot が行った更新を読み、更新された指示に基づいて生成 指示ファイルはリポジトリのアセットとなり、チームのほかのメンバーと共有されます。ほかのアセットと同様に、作業内容を含む PR を作成します。 -1. 右上隅にある **Create PR** を選択します。 +まず、レビュー済みの指示と実証コードをまとめて承認します。 + +```plaintext +コーディング標準の指示、README の参照、範囲を限定した実証コードについて、関連するテストも含めて差分全体をレビューしてください。検証結果をまとめ、レビュー済みの変更をこのセッションのブランチにコミットしてください。ブランチをプッシュし、リポジトリの PR テンプレートを使用してコーディング標準の Issue にリンクした、main を対象とする pull request を1つ作成してください。Issue のすべての受け入れ条件を満たしていない限り、部分的な貢献として説明し、未完了の作業に Issue を閉じるキーワードを使用しないでください。マージはしないでください。 +``` + +1. セッション内の PR のリンクを開きます。アプリに **Create PR** の確認が表示された場合は、重複する PR を作成せず、その確認を選択します。 2. 求められた場合は **Sign in with your browser** を選択し、画面の指示に従って認証します。 3. Copilot が PR の作成を開始します。 -PR が作成されると、Copilot はリポジトリで実行する必要があるワークフローを監視します。しばらくすると、右上のボタンが **Ready to merge** に変わります。これは PR をマージする準備が整ったことを示します。 +**My work** で指示とコードの変更を含む PR の差分全体を確認します。学習用リポジトリの CI 結果と必須のレビューを確認してください。失敗に対処してから **Ready to merge** を選択します。CI は実証やレビューの代わりにはなりません。 4. **Ready to merge** を選択します。 5. 新しいダイアログウィンドウで **Merge pull request** を選択し、pull request をマージします。 > [!NOTE] -> 標準がデフォルトブランチにマージされると、すべてのメンバーと新しいセッションでプロジェクトの一部として利用できます。次のレッスンで最新のデフォルトブランチからフィルター機能のセッションを開始すると、エージェントは自動的にこの標準に従います。生成された TypeScript に、依頼していなくても TSDoc doc comment が含まれます。指示が生成コードを形作ることを示す、小さいながらも実際的な例です。 +> フィルター機能を始める前に、PR 2 が `main` にマージされたことを確認してください。新しいワークツリーを作るだけでは最新のコードは保証されません。レッスン4ではフェッチし、新しいセッションのブランチを `origin/main` まで fast-forward して、先の2つのマージが含まれることを確認してから計画を立てます。 ## まとめと次のステップ @@ -142,10 +156,10 @@ PR が作成されると、Copilot はリポジトリで実行する必要があ - リポジトリの `copilot-instructions.md` とパス固有の `*.instructions.md` ファイルを確認した。 - バックログ内の指示に関する Issue からセッションを開始した。 -- `.github/copilot-instructions.md` にドキュメント標準を追加するようエージェントに依頼した。 -- 変更をレビューし、pull request としてマージした。 +- 適切な指示ファイルに対象を絞ったドキュメント規則を追加し、README から参照するようエージェントに依頼した。 +- 実際のコード変更に対する標準の効果を確認し、結果を検証して、両方を PR 2 としてマージした。 -次は、新しいセッションでフィルター機能を構築し、先ほどマージした標準が適用される様子を確認します。[レッスン 4「Autopilot による機能の構築」][next-lesson]に進んでください。 +次は、新しいセッションでフィルター機能を構築し、先ほどマージした標準に従っていることを確認します。[レッスン 4「Plan と Autopilot によるフィルター機能の構築」][next-lesson]に進んでください。 ## リソース @@ -154,6 +168,7 @@ PR が作成されると、Copilot はリポジトリで実行する必要があ - [カスタム指示を作成するためのベストプラクティス][instructions-best-practices] - [Awesome Copilot - 指示ファイルなどのリソース集][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/ja-jp/app/4-build-filtering.md b/docs/ja-jp/app/4-build-filtering.md index 781f83d0..8a3ffb4f 100644 --- a/docs/ja-jp/app/4-build-filtering.md +++ b/docs/ja-jp/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "レッスン 4 - Autopilot による機能の構築" -description: "GitHub Copilot app の Plan モードと Autopilot モードを使って静的なクライアント側フィルター機能を構築し、ドキュメント標準が継承されることを確認して、エージェントスキルで検証します。" +title: "レッスン 4 - Plan と Autopilot によるフィルター機能の構築" +description: "Issue に基づいてフィルター機能を計画し、Autopilot を明示的に承認して、既存の npm チェックと手動のブラウザー確認で検証し、チェックポイントを保存します。" authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -ここまで、プロジェクトに小さな更新をいくつか加えました。しかし、より本格的な変更には、よりしっかりしたプロセスが必要です。GitHub Copilot app は既存のフローと連携できるように設計されており、適切なものを適切な方法で構築できます。このレッスンから3回にわたり、一般的な開発プロセスに従います。まず Issue を使って新機能を生成し、エージェントスキルで検証テストと linter を実行します。 +星評価と、実証コードを含むドキュメント標準をマージしました。次はフィルター機能を構築します。ここから1つの大きな PR マイルストーンが始まります。レッスン4~8では、この同じセッション、ワークツリー、ブランチを維持してください。 このレッスンでは、次の内容を学習します。 -- フィルター機能に関する Issue から新しいセッションを開始する。 -- **Plan** モードで機能を計画し、**Autopilot** で構築する。 -- 生成されたコードが、以前マージしたドキュメント標準に従っていることを確認する。 -- プロジェクトの `quality-checks` スキルで作業を検証する。 +- 更新済みの `main` から開始し、実際のフィルター機能の Issue を読む。 +- **Plan** モードで要件を明確にしてから、**Autopilot** を明示的に承認する。 +- フィルター機能とテストをレビューし、既存の4つの npm チェックを実行する。 +- ブラウザーで機能を手動確認し、チェックポイントを保存する。 + +スキル、MCP による検証、QA プロファイル、機能の PR は後のモジュールで扱います。この実装段階では作成しないでください。 ## シナリオ -ホームページにはすべてのゲームが一覧表示されますが、訪問者は一覧を絞り込めません。フィルター機能に関する Issue では、**カテゴリー**と**パブリッシャー**でゲームを絞り込めるようにすることが求められています。Copilot を使ってこの機能を実装します。 +Tailspin Toys のカタログが充実し、訪問者がカテゴリとパブリッシャーでゲームを絞り込める機能が必要になりました。バックログの Issue に機能は記載されていますが、カテゴリの組み合わせ方などはコーディング前に合意が必要です。Plan モードで決定事項を整理してから、Autopilot による範囲を限定した実装を承認します。 -## 背景 +## セッションモード -AI コーディングエージェントを開発フローに導入しても、基本は変わりません。むしろ、基本はさらに重要になります。多くの開発者は、次のようなフローに従います。 +プロンプト下のモードセレクターでエージェントの自律性を制御します。 -1. 必要な作業の詳細が記載された Issue を開く。 -2. 構築する内容の計画を作成する。 -3. コードを構築してレビューする。 -4. テストを実行してコードを検証する。 -5. 新機能を手動で検証する。 -6. pull request (PR) を作成する。 -7. コードのレビューと継続的インテグレーションプロセスが成功したら、コードをマージする。 +- **Interactive** では、エージェントが作業し、入力を求める中で継続的に関与します。 +- **Plan** では、実装前にレビューする計画を用意します。 +- **Autopilot** では、承認した範囲と権限内で自律的に実装と反復を進めます。 -> [!NOTE] -> 正確な手順はチームや Organization によって異なりますが、多くの場合は上記の流れを変形したものです。 +まず計画を立て、承認を明示し、再利用可能なカスタマイズを作成する前に Interactive に戻します。 -この標準的なアプローチを守ることで、AI が生成したコードが定められた要件を満たし、人間が作成したコードと同じ審査プロセスを通るようにできます。 +## 更新済みの main から開始する -## セッションモード +GitHub で PR 1 と PR 2 がマージされたことを確認します。以前のブランチを続けるのではなく、フィルター機能用の新しいワークツリーを作成します。 -**セッションモード**は、エージェントの自律性を制御します。プロンプトフィールド下のドロップダウンから設定し、いつでも変更できます。 +1. **My work** を選択し、**Allow users to filter games by category and publisher** をタイトルで検索します。開いて実際の URL をコピーしてください。Issue 番号はリポジトリによって異なります。 +2. **New session** を選択し、**new working tree** を選びます。開始状態の更新中は **Interactive** モードを維持します。 -- **Interactive**: ユーザーとエージェントが共同で作業します。エージェントは変更を提案し、続行前に入力を待ちます。 -- **Plan**: エージェントが最初に計画を作成します。計画実行前に内容をレビューして承認します。 -- **Autopilot**: エージェントが完全に自律して作業し、入力を待たずにコードの作成、テストの実行、反復を行います。 + ![GitHub Copilot app の Issue ビューで、New session ボタンを矢印で示した画面](../../_images/app-new-session-from-issue.png) -## フィルター機能を計画する +3. 計画や編集の前に、次の準備の依頼を送信します。 -潜在的な問題を見つける最適なタイミングは、コードを作成する前です。そのためには、事前に少し計画を立てるのが効果的です。Copilot と計画を立てると、一連の手順と採用するアプローチが生成されます。その計画をレビューし、改善案があれば提案してから、計画に基づいて Copilot にコードを生成させることができます。 - -Issue を開いて新しいセッションを開始し、Plan モードに切り替えて計画を作成します。 + ```plaintext + 何も実装せずに、この新しいフィルター機能のセッションを準備してください。チェックアウトとブランチを特定し、ワークツリーに未コミットの変更がないことを確認して、origin をフェッチし、このセッションのブランチを origin/main まで fast-forward してください。HEAD が origin/main と一致し、マージ済みの星評価とコーディング標準の PR が含まれることを確認してください。 -1. ナビゲーションタブから **My work** を選択します。 -2. **Allow users to filter games by category and publisher** というタイトルの Issue を選択します。 -3. 右上の **New session** を選択します。 + 未コミットの変更、分岐、いずれかのマージの不足がある場合は停止して説明してください。リセット、作業の破棄、ブランチの切り替え、別のブランチの作成、アプリケーションファイルの編集はしないでください。開始時点のリビジョンを報告してください。 + ``` - ![GitHub Copilot app の Issue ビューで、右上の New session ボタンを矢印で示した画面](../../_images/app-new-session-from-issue.png) +4. 報告された開始状態を確認します。フェッチだけではワークツリーは更新されません。作業前に現在のセッションのブランチを fast-forward し、`HEAD` がフェッチした `origin/main` と一致する必要があります。 -4. モードに **Plan** と表示されるまで Shift+Tab を選択します。 +## フィルター機能を計画する - ![モードセレクターが Plan に設定され、矢印で示された GitHub Copilot app のプロンプトボックス](../../_images/app-4-plan-mode.png) +モードセレクターを **Plan** に切り替えます。以下の Issue のプレースホルダーをコピーした URL に置き換えてください。 -5. 次のプロンプトを送信します。Issue から開始したため、フィルター機能の Issue はすでにこのセッションのコンテキストに含まれています。 +```plaintext +この Issue に基づいてフィルター機能を計画してください: 。受け入れ条件の全文とリポジトリの指示を読み、現在の静的な Astro アプリケーションと既存のデータアクセス用ヘルパー、テストを調べてください。まだ実装しないでください。 - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +Issue で求められる複数カテゴリーの選択、パブリッシャーによるフィルター、カテゴリーとパブリッシャーを組み合わせたフィルター、適切なデータアクセス用ヘルパー、アクセシブルな操作部品、単体テストとエンドツーエンドテストのカバレッジを扱ってください。複数カテゴリーの組み合わせ方、フィルターのクリア、結果が空の場合など、指定されていない動作は勝手に要件を作らず質問してください。要件と既存のアーキテクチャに照らして妥当でない限り、サーバー API は導入しないでください。 -6. 計画の作成中に、エージェントから追加の質問が提示される場合があります。自分で機能を構築するときの方針に基づいて回答します。 +リポジトリのドキュメント規約に従い、必要な単体テストとエンドツーエンドテストを追加または更新する、範囲を限定した実装・検証計画を提案してください。package.json でコマンドを確認したうえで、既存のプロジェクトツールを使って npm run lint、npm run test:unit、npm run test:e2e、npm run typecheck:all を実行する計画にしてください。QA で再利用できるよう、Issue の URL と承認した追加の取り決めを計画に記録してください。 -> [!NOTE] -> Copilot は確率的に動作するため、追加で尋ねられる質問は異なります。質問がまったくない場合もありますが、問題ありません。 +承認前の計画に、次の実行時の安全策を含めてください。テスト対象のチェックアウトとサーバーを特定し、チェック実行前に前提条件を確認してください。ソフトウェア、依存関係、ブラウザーのインストール前には確認してください。別のワークツリーのサーバーを再利用せず、自分で起動したサーバーだけを停止し、それ以外のポート競合は無関係なプロセスを停止せず報告してください。前提条件の不足とスキップされたチェックは、成功ではなく阻害要因として報告する必要があります。 -7. 完了すると、Copilot が計画の概要を提示します。計画をレビューしてください。クエリの構築、フィルターコントロールの追加、テストの作成が提案されているはずです。必要に応じてフィードバックを返して改善できます。エージェントは提案を新しいバージョンに反映します。 +計画に次の実装範囲を含めてください。私が Autopilot を明示的に承認した後、この同じワークツリーとブランチで合意したフィルター機能とテストだけを実装し、4つのチェックを実行してください。実装内容とすべてのチェック結果を、失敗や阻害要因も含めて報告し、レビューと手動のブラウザー確認のために停止してください。実装中は、スキルやカスタムエージェントの作成、MCP の設定、ブランチの変更、コミット、プッシュ、PR の作成をしないでください。手動のブラウザー確認とチェックポイントコミットは、後で私の別の指示に従って行います。 -## Autopilot で構築する +今は Plan モードを維持し、レビューできるよう計画を提示して停止してください。実装、スキルやカスタムエージェントの作成、MCP の設定、ブランチの変更、コミット、プッシュ、PR の作成はしないでください。 +``` -計画が完成したので、Copilot に実装を構築させます。 +確認の質問に回答し、Issue と照らし合わせて計画をレビューします。UI だけの実装を承認せず、データアクセスの変更、アクセシブルな操作部品、テストを確認してください。レッスン6と7で使うために、実際の Issue の URL と承認した追加の取り決めを計画から保存します。追加の条件が不要だった場合は `none` を使用します。 -1. **Plan summary** ダイアログのオプション一覧で、**Approve and implement with autopilot** に最も近いオプションを選択します。 +承認前に、計画自体に4つのチェック、ドキュメント規約、前提条件とサーバーの安全策、同じワークツリーとブランチを維持する要件、実装と検証後の停止が含まれることを確認してください。実装中に、後のスキルやエージェントの作成、MCP の設定、コミット、プッシュ、PR の作成を禁止している必要があります。境界条件が不足していれば、**Plan** モードのまま計画の修正を依頼し、修正版を確認してから承認します。 -Copilot が実装作業を開始します。 +## Autopilot を明示的に承認する -> [!NOTE] -> Copilot が必要なコードの作成を自動的に開始しない場合は、"Go ahead and start building out the plan!" のようなプロンプトを使って開始を依頼できます。 -> -> 必要な更新の作成には数分かかります。エージェントはファイルを編集および作成し、テストを作成して実行し、反復します。この時間に、ここまで学習した内容を振り返ったり、飲み物を用意したりできます。 +レビュー済みの計画に要件とすべての実行境界が含まれていることを確認してから、計画の承認操作で **Approve and implement with autopilot**、または使用中のバージョンで表示される同等の明示的な Autopilot オプションを選択します。モード表示が **Autopilot** になっていることを確認してください。 -## 変更をレビューする +承認するとすぐに実行が始まる場合があります。そのため、実装範囲、安全規則、停止条件はすべて承認前のレビュー済み計画に含める必要があります。実行が始まった後の追加メッセージで指定することを前提にしないでください。 -AI が生成したすべてのコードは、マージ前にレビューする必要があります。コードをレビューし、サイトを実行して問題がないことを確認します。 +Autopilot はコードとテストを作成し、失敗に対処して反復できます。ただし、これは後のモジュールまで完了させる許可ではありません。前提条件の不足は承認を得て解決する阻害要因であり、チェックの成功ではありません。 -1. 右上の **Changes** を選択してコードの変更を開きます。 +## 実装をレビューして検証する - ![GitHub Copilot app のセッションパネルにあるタブで、Changes タブを矢印で示した画面](../../_images/app-select-changes.png) +1. **Changes** を開き、フィルター機能の実装とテストを確認します。 +2. 複数カテゴリーとパブリッシャーの組み合わせも含め、結果を Issue と承認した追加の取り決めに照らし合わせます。新規または変更したヘルパーがレッスン3のドキュメント標準に従っていることを確認します。 +3. 4つの npm チェックすべての実際のコマンド出力を確認します。quality-checks スキルはまだ作成していないため、この段階では直接実行します。 +4. 実装を承認する前に失敗を解消し、該当するチェックを再実行します。Playwright の E2E 設定はビルドしてプレビューを配信し、ローカルサーバーを再利用できるため、テスト対象が以前のレッスンではなくこのワークツリーのサーバーであることを確認します。 -2. 変更をレビューします。新しい TypeScript ファイル、Astro ファイル、テストファイルが表示されます。新しいヘルパー関数には、レッスン3でマージしたドキュメント標準に従い、依頼していなくても TSDoc doc comment とファイルヘッダーコメントが含まれていることを確認します。 -3. Copilot app の右側にあるレビューパネルで **Terminal** を選択します。**Terminal** ボタンがない場合は、**+** (**Open in panel** というラベルが付いています) を選択してから **Terminal** を選択します。 +## 機能を手動確認する - ![GitHub Copilot app のレビューパネルにある Terminal ボタン](../../_images/app-terminal-screenshot.png) +手動レビューの前にセッションを **Interactive** モードに戻し、レッスン5でも維持します。 -4. ターミナルウィンドウに次のコマンドを入力し、Web アプリの開発サーバーを起動します。 +1. このセッションのレビューパネルで **Terminal** を開きます。必要であれば **+**、**Terminal** の順に選択します。 +2. ターミナルがフィルター機能のワークツリー内にあることを確認し、次を実行します。 ```shell npm run dev ``` -5. サーバーが起動したら、ブラウザーウィンドウを開きます。起動には少し時間がかかります。 -6. http://localhost:4321 に移動します。 -7. ランディングページでフィルターを使用できることを確認します。 -8. 問題がある場合は、Copilot に更新を依頼できます。 -9. 問題がなければ、ターミナルウィンドウに戻ります。 -10. Ctrl+C を選択して開発サーバーを停止します。 - -## quality-checks スキルで作業を検証する +3. このサーバーが出力した URL をブラウザーで開きます。通常は `http://localhost:4321` です。ポートが使用中の場合は、無関係なプロセスを停止したり既存のサーバーに変更が含まれると決めつけたりせず、所有者を特定します。 +4. 承認した動作に照らして、カテゴリー選択、パブリッシャー選択、それらの組み合わせを試します。キーボードでの操作と、合意したクリア操作や結果が空の場合の動作も確認します。 +5. 問題があれば、範囲を絞った修正を依頼し、差分をレビューして、関連する自動チェックとブラウザーでの確認を繰り返します。 +6. ターミナルに戻り、Control+C (Mac) または Ctrl+C (Windows/Linux) を押して、自分で起動したサーバーを停止します。次のモジュールの E2E 実行前に、停止したことを確認してください。 -差分を目視で確認するだけで完了とすることもできますが、このチームには明確な品質基準と、それを繰り返し確認する方法があります。 +これは手動のブラウザー観察です。MCP を使ったエージェントによるブラウザー観察はレッスン6で扱います。 -**エージェントスキル**を使うと、テストの実行、ビルドの生成、pull request の作成など、繰り返し発生するタスクの実行方法を Copilot に指示できます。スキルは、エージェントが必要に応じて読み込める指示、スクリプト、リソースのフォルダーです。[Agent Skills はオープン標準][agent-skills-repo]であり、さまざまなエージェントで使用されています。そのため、同じスキルをエージェントモードの Copilot Chat、Copilot cloud agent、Copilot CLI、GitHub Copilot app で使用できます。 +## チェックポイントを保存する -スキルはプロジェクトの `.github/skills` フォルダー、またはグローバルの `~/.copilot/skills` に配置します。各スキルは、YAML frontmatter (`name` と `description`) と、それに続く Markdown の指示が記載された `SKILL.md` ファイルを含むフォルダーです。 +変更と検証結果をレビューしたら、ローカルコミットを承認します。 -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +現在の差分をレビューし、フィルター機能の実装とテストのチェックポイントコミットを作成してください。この同じフィルター機能のブランチとワークツリーを維持してください。スキルやエージェントの作成、MCP の設定、プッシュ、pull request の作成はしないでください。 ``` -スキルには、スクリプト、アセット、参考資料を含むサブフォルダーも追加できます。完全な構造については、[エージェントスキルの仕様][agent-skills-spec]を参照してください。 - -> [!TIP] -> スキルは動的に読み込まれます。エージェントは `description` フィールドに基づいて適用するスキルを判断します。明確でシナリオに合った説明を記述することが、スキルが使用されるか無視されるかを左右します。 - -## quality-checks スキルを確認する - -スキルの内容を確認します。 - -1. レビューパネルが表示されていない場合は、右上の **Toggle review panel** を選択して開きます。 - - ![Create PR の右側にある Toggle review panel ボタンを矢印で示した GitHub Copilot app の上部ツールバー](../../_images/app-2-review-panel.png) - -2. **+** を選択し、レビューパネルに新しい項目を追加します。 -3. **File** を選択します。 -4. `SKILL.md` を検索します。 -5. ファイル一覧から `SKILL.md .github/skills/quality-checks` を選択して開きます。 -6. `name` と `description` を確認します。説明は、コード変更を commit、push、merge する前にテスト、lint、検証する必要がある場合に、このスキルを使用することをエージェントに伝えます。 -7. スキル全体を読みます。単体テスト、Playwright のエンドツーエンドテスト、ESLint の各スイートを実行するスクリプト、実行順序、一般的な失敗のデバッグ方法が記載されています。そのため、エージェントは推測するのではなく、チームの方法でチェックを実行できます。 - -## チェックを実行する - -同じフィルター機能のセッションで、エージェントに作業の検証を依頼します。スキル名を説明する必要はありません。エージェントがリクエストに一致するスキルを見つけます。 - -1. Copilot app に戻ります。 -2. スラッシュコマンド `/quality-checks` を使ってスキルを直接呼び出し、Enter を選択します。 -3. エージェントはスキルに従って単体テスト、linter、エンドツーエンドテストを実行し、結果を報告します。失敗したものがあれば、問題を修正して、すべて成功するまでチェックを再実行するよう依頼します。 -4. **このセッションを開いたままにします。** 次のレッスンでは Playwright MCP server を追加し、実際のブラウザーでフィルター機能が動作することを確認します。 - ## まとめと次のステップ -実際の機能をエンドツーエンドで構築し、チームの基準に照らして検証しました。具体的には、次の作業を行いました。 - -- 最新のプロジェクトで、フィルター機能に関する Issue から新しいセッションを開始した。 -- Plan モードで機能を計画し、Autopilot で構築した。 -- 生成されたヘルパーが、レッスン3でマージしたドキュメント標準に従っていることを確認した。 -- `quality-checks` スキルで作業を検証した。 - -次は Playwright MCP server を接続し、実際のブラウザーでフィルター機能を確認するようエージェントに依頼します。[レッスン 5「Playwright MCP server によるテスト」][next-lesson]に進んでください。 +フィルター機能の要件に合意し、実装とテストをレビューして、機能を手動確認しました。このチェックポイントは PR 3 の一部であり、別の PR ではありません。同じセッションの **Interactive** モードを維持して、[レッスン 5「quality-checks スキルの作成と使用」][next-lesson]に進んでください。 ## リソース - [GitHub Copilot app でのエージェントセッションの操作][agent-sessions] -- [Agent Skills について][about-agent-skills] -- [GitHub Copilot app のカスタマイズ][customize-app] - [GitHub Copilot のクラウドサンドボックスとローカルサンドボックスについて][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification \ No newline at end of file diff --git a/docs/ja-jp/app/5-agent-skills.md b/docs/ja-jp/app/5-agent-skills.md new file mode 100644 index 00000000..7a73f1fb --- /dev/null +++ b/docs/ja-jp/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +title: "レッスン 5 - quality-checks スキルの作成と使用" +description: "再利用可能なシェルスクリプト付き品質チェックスキルを Copilot に作成させ、内容を確認してフィルター機能のブランチで実行します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +フィルター機能を実装し、既存の npm コマンドでチェックしました。次は、これらのチェックを再利用可能な**エージェントスキル**にまとめます。レッスン4~8では同じフィルター機能のセッションとブランチを維持してください。このレッスンでは pull request を作成しません。 + +このレッスンでは、次のことを行います。 + +- カスタマイズを作成する前に **Interactive** モードに戻る。 +- Copilot に `quality-checks` を作成させ、確認のために停止させる。 +- 同梱のスクリプトを通じて4つすべてのチェックを実行し、単一のテストファイルを指定する引数が、そのファイルだけを選択することを実証する。 +- フィルター機能と同じブランチにスキルのチェックポイントを保存する。 + +## シナリオ + +Tailspin Toys では、フィルター機能を変更するたびに同じ品質チェックが必要です。毎回の会話でコマンドと前提条件を説明する代わりに、チームは再利用可能なスキルを求めています。スキルを作成してスクリプトを確認し、別のリクエストでもチェックを正しく実行できるか検証します。 + +## 指示、スクリプト、リソース + +スキルは、再利用可能なタスクの指示、実行可能なスクリプト、補助リソースをまとめたもので、エージェントが必要に応じて読み込みます。カスタムエージェントは、専門的な役割、指示、利用可能なツールを定義します。これらは補完関係にあります。カスタムエージェントは、スキルに同梱されたものを含め、スクリプトを実行できます。 + +リポジトリのスキルは `.github/skills//SKILL.md` に配置し、`name` と `description` のフロントマターと Markdown の指示を持ちます。スクリプトやほかのリソースは、その隣に置きます。完成済みの答えをコピーせず、Copilot に `.github/skills/quality-checks/SKILL.md` と同梱のスクリプトを生成するよう依頼します。[Agent Skills 仕様][skill-spec]に形式が説明されています。 + +Copilot は検出したスキルの説明を使い、いつ読み込むかを判断します。すでに開いているセッションで新しいスキルがすぐ検出されるとは限りません。実行の節では、明示的に読み込む代替手順も示します。形式に移植性があっても、シェルやプロジェクトの前提条件は必要です。 + +## スキルを作成する + +プロンプトを送る前に、モードセレクターでフィルター機能のセッションを **Interactive** モードに戻します。現在のチェックアウトとブランチを維持してください。古いテンプレートから始めてこのスキルがすでにある場合は、カスタマイズを上書きせず、確認して拡張します。 + +```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 の区切り文字 -- は1回だけ挿入し、呼び出し側は余分な -- を付けずにツールの引数を直接渡すようにしてください。ポートやプロセスは管理しないでください。 + +SKILL.md に name と description のフロントマター、4本のラッパーを実行する指示、前提条件、トラブルシューティング、既存の単体テストファイル1つを使う例を含む移植可能な呼び出し例を記載してください。Bash の例はすべて bash を明示的に呼び出し、PowerShell の実行ポリシーは決して回避しないでください。Playwright のサーバー再利用について説明してください。停止してよいのは自分で実際に起動したサーバーだけとし、それ以外の場合は質問するようにしてください。 + +スキルと必要なスクリプトだけを作成してください。チェックや調査用の試行、インストール、アプリケーションコードの変更、コミット、PR の作成はしないでください。内容を確認できるよう、そこで停止してください。 +``` + +## スキルを確認する + +1. **Changes** を開いて生成されたファイルをレビューします。レビューパネルの **+**、**File** の順に選び、`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 に置きます。停止できるのはエージェントが実際に起動したサーバーだけであることを確認してください。作業ディレクトリやプロセス名の一致だけでは、所有者であると判断できません。成果物にはスキル、必須のラッパー、必要な共有ヘルパーだけを含め、一時的な調査用ファイルやデバッグ用ファイルを残さないようにします。 + +> [!NOTE] +> 現在の Tailspin Toys には Node.js 22.13 以降、プロジェクトの依存関係、E2E チェック用の Playwright Chromium が必要です。チェックアウトの README と `package.json` で前提条件を確認してください。前提条件の不足や PowerShell の実行ポリシーによる制限は、承認を得て解消する必要があります。自動インストール、ポリシーの回避、断りなく npm の直接実行に切り替える方法で対処してはいけません。 + +## スキルを実行する + +前のレッスンの開発サーバーが停止していることを確認します。Playwright は E2E 用にビルドしてプレビューを配信しますが、ローカルの設定ではポート `4321` のサーバーを再利用できます。別のチェックアウトのサーバーは、この機能の有効な証拠にはなりません。 + +App に `/quality-checks` が表示される場合は、選択して検出済みのスキルを明示的に呼び出し、以下のリクエストを含めます。検出されていない場合は、このセッションで同じリクエストを直接送信します。この演習では、スキルを読み込む方法を代替手順として使用できます。 + +```plaintext +.github/skills/quality-checks/SKILL.md を読み、その指示に従ってこのチェックアウトのフィルター機能を検証してください。まず各ラッパーのコードを調べ、npm による祖先ディレクトリのパッケージ探索に依存せず、このチェックアウトで使う対象の package.json を含むディレクトリを導き出し、不正なルートでは明確に失敗する処理があることを確認してください。失敗を再現するために、リポジトリのファイルを移動、名前変更、削除、変更しないでください。lint、単体テスト、エンドツーエンドテスト、型チェック用の同梱スクリプトを実際に実行してください。記載された単体テストの1ファイルだけを実行する例も実行してください。npm の区切り文字 -- はラッパーが挿入するため、対象ツールの引数を直接渡してください。テストランナーの結果から指定したファイルだけが実行されたことを確認し、そのファイル名と実行されたテストファイル数を報告してください。引数の表示や終了コード 0 だけでは、正しく選択された証拠にはなりません。 + +各スクリプトの呼び出しと結果を、失敗、スキップしたチェック、不足する前提条件も含めて報告してください。使用できないスキルのスクリプトを、断りなく npm コマンドの直接実行で置き換えないでください。テスト対象のチェックアウトとサーバーを特定し、自分で起動したサーバーだけを停止してください。インストールや別のプロセスの停止前には確認してください。アプリケーションコードやブランチの変更、コミット、プッシュ、pull request の作成はしないでください。 +``` + +ツールの呼び出しと出力を確認します。4つすべてのスクリプトを実際に実行する必要があります。チェックの説明やスキップされたチェックは成功ではありません。単一ファイルの例では、指定したファイル名をランナーの実際のファイル別結果と報告された件数に照らし合わせ、そのファイルだけが実行されたことを確認します。ほかのファイルも実行された場合は、引数の表示や終了コード 0 では不十分です。失敗は有用な証拠です。スキルを修正するか、承認を得てセットアップの阻害要因を解消し、影響するチェックを再実行します。無関係なプロセスを停止したり、ポート競合を強引に解消したりしてはいけません。 + +## チェックポイントを保存する + +スキルと結果をレビューしたら、ローカルのチェックポイントを承認します。 + +```plaintext +現在の差分をレビューし、quality-checks スキルのファイルだけのチェックポイントコミットを作成してください。既存のフィルター機能のブランチを維持してください。プッシュや pull request の作成はしないでください。 +``` + +## まとめと次のステップ + +再利用可能な quality-checks スキルを作成して確認し、単一ファイルのテスト例も含めて実行しました。スキルのファイルは、レッスン8の機能 PR に、フィルター機能、QA プロファイル、関連テストと一緒に含めます。この同じセッションで[レッスン 6 - Playwright MCP で機能を検証する][next-lesson]に進みます。 + +## ほかのスキルの例 + +これらのコミュニティの例は参考資料であり、追加のタスクではありません。採用する前に前提条件と動作を確認してください。 + +- [コントリビューションのワークフロー: `make-repo-contribution`][contribution-example]。 +- [要件文書: `prd`][prd-example]。 +- [図と同梱のエクスポートスクリプト: `drawio`][drawio-example]。 +- [ブラウザーテスト: `webapp-testing`][browser-example]。 + +上流のコントリビューション例の名前は `make-repo-contribution` です。古い Tailspin テンプレートでは、異なる名前の `make-contribution` を使用していました。このワークショップは、どちらのコントリビューション用スキルにも依存しません。 + +[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/app/5-mcp-playwright.md b/docs/ja-jp/app/5-mcp-playwright.md deleted file mode 100644 index 4cfea9b8..00000000 --- a/docs/ja-jp/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "レッスン 5 - Playwright MCP server によるテスト" -description: "Playwright MCP server を GitHub Copilot app に追加し、実際のブラウザーでフィルター機能を手動テストするようエージェントに依頼します。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -前のレッスンでは、プロジェクトの自動テストスイートを使ってフィルター機能を作成し、検証しました。テストによってコードの検証を自動化できますが、エージェント自身が動作を確認できるようにすることも効果的です。実際に作成している UI で問題を見つけた場合に、エージェントが対応できるようになります。MCP を使って AI エージェントに外部機能へのアクセスを提供する方法を確認し、Copilot が構築中のサイトを直接操作できるように Playwright MCP server を追加します。 - -このレッスンでは、次の内容を学習します。 - -- Model Context Protocol (MCP) の概要と、GitHub Copilot app での使用方法を理解する。 -- アプリの設定から Playwright MCP server を追加する。 -- エージェントにブラウザーを操作させ、フィルター機能を確認する。 - -## シナリオ - -単体テストとエンドツーエンドテストは重要ですが、UI の更新を検証するには、実際に UI を操作する必要があります。変更作業をさらに自動化し、更新が期待どおりに動作するという確信を高めるために、ユーザーと同じ方法で Copilot が作業中の Web サイトを使用できるようにします。 - -## Model Context Protocol (MCP) とは - -[Model Context Protocol (MCP)][mcp-blog-post] は、AI エージェントが外部のツールやサービスと通信するための手段を提供します。MCP を使うと、AI エージェントは外部のツールやサービスとリアルタイムで通信できます。その結果、最新情報へのアクセス (resources を使用) や、ユーザーに代わる操作 (tools を使用) が可能になります。 - -これらの tools と resources には、AI エージェントと外部のツールやサービスをつなぐ MCP server を通じてアクセスします。MCP server は、AI エージェントと外部ツール (既存の API や NPM パッケージなどのローカルツール) 間の通信を管理します。各 MCP server は、AI エージェントがアクセスできる異なる tools と resources のセットを表します。 - -よく使われる既存の MCP server には、次のものがあります。 - -- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): GitHub リポジトリを管理するための API セットにアクセスできます。AI エージェントは、新しいリポジトリの作成、既存のリポジトリの更新、Issue と pull request の管理などを行えます。 -- [**Playwright MCP Server**][playwright-mcp-server]: Playwright を使ったブラウザー自動化機能を提供します。AI エージェントは、Web ページへの移動、フォームへの入力、ボタンの選択などを行えます。 - -さまざまな tools と resources にアクセスできる MCP server がほかにも多数あります。GitHub は、エコシステム内での発見と貢献を促進するために [MCP registry](https://github.com/mcp) をホストしています。 - -> [!CAUTION] -> MCP server は、プロジェクト内のほかの依存関係と同様に扱ってください。使用する前にソースコードを慎重に確認し、発行元を検証して、セキュリティ上の影響を考慮します。信頼できる MCP server だけを使用し、機密性の高いリソースや操作へのアクセスを許可するときは注意してください。 - -## Playwright MCP server を追加する - -MCP server はアプリの設定から追加して管理します。アプリには一般的なサーバーのカタログが含まれているため、[Playwright MCP server][playwright-mcp-server] は数回の操作で追加できます。 - -1. Ctrl+, を選択して、Copilot app の設定ページを開きます。 -2. **MCP servers** を選択します。 -3. 検索ダイアログに `Playwright` と入力します。 -4. **Popular MCP servers** の一覧から **Playwright** を選択します。 -5. **Add server** を選択し、利用可能な MCP server の一覧に追加します。 -6. Esc を選択して設定ダイアログを閉じます。 - -これで Playwright MCP server を追加できました。 - -## Playwright で機能を確認するよう Copilot に依頼する - -Playwright MCP server を使って機能を手動テストするよう Copilot に依頼します。 - -1. 次のプロンプトを使い、新しい機能を検証するよう Copilot に依頼します。 - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -Copilot は Playwright MCP server を通じてブラウザーを起動し、各手順を実行して、確認結果を報告します。タスクの実行中、システム上で実際にブラウザーが開く様子を確認できます。 - -2. Issue の受け入れ条件と照らし合わせて概要を読みます。問題がある場合は、pull request を作成する前に追加の質問をするか、コードを修正するよう依頼します。 -3. 次のレッスンでこの作業を完了するため、セッションを開いたままにします。 - -これで Copilot は、ユーザーと同じように機能を確認し、ブラウザーでも動作を検証しました。 - -## まとめと次のステップ - -GitHub Copilot app から Playwright MCP server を使い、実際のブラウザーで機能を確認しました。学習した内容は次のとおりです。 - -- Model Context Protocol (MCP) の概要と、アプリで MCP tools を利用する仕組みを学習した。 -- アプリの設定から Playwright MCP server を追加した。 -- エージェントにブラウザーを操作させ、フィルター機能を確認した。 - -機能の構築と検証が完了し、動作することも確認できました。次は、**Agent Merge** を使って pull request の作成とマージをエージェントに任せ、機能をリリースします。[レッスン 6「Agent Merge によるマージ」][next-lesson]に進んでください。 - -## リソース - -- [MCP とは何か、なぜ注目されているのか][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [GitHub Copilot app での MCP server の構成][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/6-agent-merge.md b/docs/ja-jp/app/6-agent-merge.md deleted file mode 100644 index eefc96ae..00000000 --- a/docs/ja-jp/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "レッスン 6 - Agent Merge によるマージ" -description: "フィルター機能の pull request を作成して My work でレビューし、マージを妨げる問題の修正とマージを Agent Merge に任せて、段階的なマージ自動化の最上位まで進みます。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -フィルター機能の構築と検証が完了し、ブラウザーで動作することも確認できました。最後のステップはマージです。このハーネスではすでに2回マージしており、どちらも pull request を作成して github.com で自分でマージしました。今回は、pull request のライフサイクル全体をアプリ内から管理する **Agent Merge** に処理を任せます。 - -このレッスンでは、次の内容を学習します。 - -- Agent Merge の概要と、マージのライフサイクルを自動化する仕組みを学ぶ。 -- フィルター機能のセッションで Agent Merge を有効にする。 -- pull request の作成、CI の実行、すべて成功した後のマージを確認する。 - -## シナリオ - -ここ数回のモジュールでは、コードの作成から Copilot による UI の直接検証まで、さまざまなレベルの自動化を確認しました。開発をさらに高速化するために、Tailspin Toys は審査および検証済みの pull request を自動的にマージする方法を検討しています。 - -## Agent Merge の概要 - -**Agent Merge** を使うと、Copilot app で pull request をマージするまでの最終工程を自動化できます。有効にすると、アプリのセッションが pull request を読み取り、失敗した CI チェックの修正、レビューコメントへの対応、必要に応じたリベースなど、マージを妨げる問題に対処します。そして GitHub で許可され次第、pull request をマージします。バックグラウンドで動作し、アプリを再起動しても継続し、pull request がマージされると自動的に無効になります。 - -ここまでは、github.com で自分で **Merge pull request** を選択していました。Agent Merge はその責任をエージェントに移すため、エージェントが PR の完了までを管理している間に次のタスクへ進めます。作業のレビューと承認は引き続き自分で行い、エージェントには機械的な最終工程だけを任せます。 - -## Agent Merge で PR を管理する - -コードを手動でレビューし、テストを実行し、Copilot による UI の検証も完了しました。新しいコードをコードベースにマージします。Agent Merge に PR を継続的インテグレーション (CI) のプロセスからマージまで管理させます。 - -1. 前のモジュールでフィルター機能を追加していたセッションに戻ります。 -2. 右上隅にある **Create PR** の横のドロップダウンを選択します。 -3. **Agent merge** を選択して Agent Merge を有効にします。 - - ![GitHub Copilot app で展開された Create PR ドロップダウンの Agent merge オプションを矢印で示した画面](../../_images/app-enable-agent-merge.png) - -4. ボタンのテキストが **Agent merge** に変わります。 -5. **Agent merge** ボタンを選択し、Agent Merge のプロセスを開始します。 - -Copilot app が PR の作成と管理を開始します。最初にプロジェクトを調査して PR の最適な作成方法を判断し、新しい PR を作成します。 - -しばらくすると、Copilot が再び作業を開始し、リポジトリ上ですべてのテストを実行する CI プロセスなど、PR の条件を確認します。ほかのチームメンバーによるレビュー、実行が必要なチェック (CI プロセス)、PR をマージできるかどうかのステータスを報告します。 - -6. **Agent merge** の横にあるドロップダウンを選択してから **Merge pull request** を選択し、Agent Merge に pull request のマージを許可します。 - - ![Agent merge ドロップダウンで、エージェントに許可された Address reviews、Fix CI failures、Resolve conflicts の操作と、矢印で示された Merge pull request](../../_images/app-agent-merge-merge.png) - -7. すべての CI プロセスが成功すると、つまりテストに合格すると、Copilot が pull request をマージします。 - -## まとめと次のステップ - -コードの生成、テストと検証、pull request のプロセスなど、開発プロセスの複数の部分を自動化しました。具体的には、次の作業を行いました。 - -- Agent Merge の概要と、マージのライフサイクルを自動化する仕組みを学習した。 -- フィルター機能のセッションで Agent Merge を有効にした。 -- pull request の作成、CI の実行、すべて成功した後のマージを確認した。 - -次は、エージェントと一緒に作業を計画して視覚化する、より高度な方法である**キャンバス**を確認します。[レッスン 7「キャンバスを使った計画」][next-lesson]に進んでください。 - -## リソース - -- [GitHub Copilot app での Issue と pull request の管理][managing-issues-prs] -- [GitHub Copilot app について][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/6-mcp-playwright.md b/docs/ja-jp/app/6-mcp-playwright.md new file mode 100644 index 00000000..a1a16b34 --- /dev/null +++ b/docs/ja-jp/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "レッスン 6 - Playwright MCP による機能の検証" +description: "Customize から Playwright MCP を設定し、既存の機能用ワークツリーのフィルター機能をブラウザーで観察します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +前のレッスンでは、プロジェクトのチェックを quality-checks スキルにまとめて実行しました。次は、エージェントがフィルター UI を直接観察できるよう、ブラウザーへのアクセスを提供します。同じフィルター機能のセッション、ワークツリー、ブランチを維持してください。このレッスンではブラウザーでの証拠を追加します。別の機能の実装、テストスイート全体の再実行、PR の作成は行いません。 + +このレッスンでは、次の内容を学習します。 + +- Model Context Protocol (MCP) の概要と、GitHub Copilot app での使用方法を理解する。 +- **Customize** から Playwright MCP server を追加する。 +- エージェントにブラウザーを操作させ、フィルター機能を確認する。 + +## シナリオ + +単体テストとエンドツーエンドテストは重要ですが、UI の更新を検証するには、実際に UI を操作する必要があります。変更作業をさらに自動化し、更新が期待どおりに動作するという確信を高めるために、ユーザーと同じ方法で Copilot が作業中の Web サイトを使用できるようにします。 + +## Model Context Protocol (MCP) とは + +[Model Context Protocol (MCP)][mcp-blog-post] は、AI エージェントが外部のツールやサービスと通信するための手段を提供します。MCP を使うと、AI エージェントは外部のツールやサービスとリアルタイムで通信できます。その結果、最新情報へのアクセス (resources を使用) や、ユーザーに代わる操作 (tools を使用) が可能になります。 + +これらの tools と resources には、AI エージェントと外部のツールやサービスをつなぐ MCP server を通じてアクセスします。MCP server は、AI エージェントと外部ツール (既存の API や NPM パッケージなどのローカルツール) 間の通信を管理します。各 MCP server は、AI エージェントがアクセスできる異なる tools と resources のセットを表します。 + +よく使われる既存の MCP server には、次のものがあります。 + +- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): GitHub リポジトリを管理するための API セットにアクセスできます。AI エージェントは、新しいリポジトリの作成、既存のリポジトリの更新、Issue と pull request の管理などを行えます。 +- [**Playwright MCP Server**][playwright-mcp-server]: Playwright を使ったブラウザー自動化機能を提供します。AI エージェントは、Web ページへの移動、フォームへの入力、ボタンの選択などを行えます。 + +さまざまな tools と resources にアクセスできる MCP server がほかにも多数あります。GitHub は、エコシステム内での発見と貢献を促進するために [MCP registry](https://github.com/mcp) をホストしています。 + +> [!CAUTION] +> MCP server は、プロジェクト内のほかの依存関係と同様に扱ってください。使用する前にソースコードを慎重に確認し、発行元を検証して、セキュリティ上の影響を考慮します。信頼できる MCP server だけを使用し、機密性の高いリソースや操作へのアクセスを許可するときは注意してください。 + +## Playwright MCP server を追加する + +現在の [App のカスタマイズドキュメント][customize-app]では、サイドバーの **Customize** で MCP の検索と管理を行います。リポジトリや Copilot CLI 向けに設定された MCP server は App でも利用できる場合があります。重複して追加する前に、インストール済みのサーバーを確認してください。 + +1. サイドバーで **Customize** を選択します。 +2. **MCP** を選択し、**Installed** で既存の Playwright サーバーを確認します。 +3. 必要な場合は利用可能なサーバーから **Playwright** を探すか、発行元が文書化したカスタムサーバーの追加手順を使用します。 +4. 発行元、設定、インストールの確認内容をレビューしてから承認します。画面の案内に従ってサーバーを追加してください。組織のポリシーや前提条件の不足により、セットアップがブロックされる場合があります。 +5. **Interactive** モードを維持して既存のフィルター機能のセッションに戻ります。検証を依頼する前に Playwright MCP のブラウザーツールが利用できることを確認します。セットアップの問題を回避するために新しい機能用ワークツリーを作成しないでください。 + +セットアップが失敗した場合は、ツールなしでブラウザーを操作したという主張を受け入れず、設定や権限の問題を解決します。ブラウザーが画面に表示されるかどうかはサーバー設定によります。実際のツールアクティビティと観察結果が証拠です。 + +## Playwright で機能を確認するよう Copilot に依頼する + +レッスン4で保存した実際の Issue の URL と承認済みの追加の取り決めを使用します。エージェントがサーバーを起動する前に、以前のレッスンで手動起動した開発サーバーを停止してください。エージェントはテスト対象のチェックアウトとサーバーを特定する必要があります。 + +1. 次のプロンプトを使い、新しい機能を検証するよう Copilot に依頼します。 + + ```plaintext + 設定済みの Playwright MCP server を使用し、この Issue に照らしてフィルター機能を観察してください: 。計画時に承認した追加の取り決めは次のとおりです: <合意した追加の取り決めを貼り付けるか、none と記入>。このフィルター機能のワークツリーとブランチを維持してください。 + + チェックアウトを特定してその開発サーバーを起動し、実際のブラウザーツールで、必要な複数カテゴリーの選択、パブリッシャーによるフィルター、組み合わせたフィルター、アクセシブルな操作部品、合意したクリア操作や結果が空の場合の動作を試してください。失敗やブロックされたチェックを含め、条件に対する観察結果を報告してください。観察していない動作を確認済みと主張しないでください。 + + この段階はブラウザーでの観察であり、自動テスト全体の再実行ではありません。アプリケーションコード、テスト、スキル、エージェントプロファイルの変更、コミット、プッシュ、PR の作成はしないでください。MCP ツールや前提条件の不足はブロックとして報告し、インストールの前に確認してください。別のチェックアウトのサーバーの再利用や無関係なプロセスの停止はしないでください。完了したら、自分で起動したサーバーだけを停止してください。 + ``` + +Playwright MCP のツール呼び出し、テスト対象の URL、報告されたブラウザーでの観察結果を確認します。ソースコードや以前の E2E 結果だけに基づく説明では MCP の使用を実証できません。 + +2. Issue と承認した追加の取り決めに照らして概要を読みます。不具合がある場合は、範囲を絞った修正を別途承認し、変更した差分をレビューして、関連する自動チェックとブラウザー観察を繰り返します。修正前の証拠は修正後のリビジョンを証明しません。 +3. エージェントが自分で起動したサーバーを停止したことを確認します。レッスン7で QA プロファイルを作成する前に、このフィルター機能のセッションを開いたまま **Interactive** モードを維持します。 + +この段階で得るのは直接観察の結果であり、自動テストのカバレッジの代わりではありません。失敗やブロックされた観察は、QA に引き継ぐため明示しておきます。 + +## まとめと次のステップ + +GitHub Copilot app から Playwright MCP server を使い、実際のブラウザーで機能を確認しました。学習した内容は次のとおりです。 + +- Model Context Protocol (MCP) の概要と、アプリで MCP tools を利用する仕組みを学習した。 +- **Customize** から Playwright MCP server を設定した。 +- エージェントにブラウザーを操作させ、フィルター機能を確認した。 + +次は、専門家のプロファイルで要件、ブラウザー観察、カバレッジ、スキルを組み合わせます。この同じセッションで[レッスン 7「QA エージェントの作成と使用」][next-lesson]に進んでください。機能の PR はまだ作成しません。 + +## リソース + +- [MCP とは何か、なぜ注目されているのか][mcp-blog-post] +- [Microsoft Playwright MCP Server][playwright-mcp-server] +- [GitHub Copilot app での MCP server の構成][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/7-canvases.md b/docs/ja-jp/app/7-canvases.md deleted file mode 100644 index 9af8465a..00000000 --- a/docs/ja-jp/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "レッスン 7 - キャンバスを使った計画" -description: "GitHub Copilot app でエージェント主導の共有キャンバスを作成し、エージェントと一緒に作業を計画して追跡します。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -ここまでは、チャットを通じてエージェントを指示してきました。しかし、多くの作業は会話の中ではなく、ボード、ドキュメント、チェックリスト上で行われます。**キャンバス**は、まさにそのような作業のために、アプリ内でユーザーとエージェントが共有できる領域です。このレッスンでは、ここまで取り組んできたバックログの計画と追跡に使用する、シンプルなキャンバスを作成します。 - -このレッスンでは、次の内容を学習します。 - -- キャンバスの概要と使用する場面を理解する。 -- バックログをトリアージする共有 Kanban ボードのキャンバスを作成する。 -- キャンバスをリポジトリに保存し、チーム向けにマージする。 -- 新しいセッションでキャンバスを開き、そこから作業を開始する。 - -## シナリオ - -Issue の一覧は、どのような状況でも負担に感じることがあります。Tailspin Toys の開発者は、Issue をすばやくトリアージし、Copilot app で作業を開始できるツールを探しています。 - -## キャンバスとは - -[キャンバス][canvas-docs]は、計画、トリアージボード、リリースチェックリスト、ダッシュボード、ドキュメントなどの作業成果物を扱う、共有の対話型領域です。チャットは意図の説明や曖昧さの検討に適していますが、多くの作業は具体的な*領域*上で行われます。キャンバスを使うと、その領域でエージェントと直接共同作業できます。 - -キャンバスは**双方向**です。エージェントが作業中にキャンバスを更新できる一方で、ユーザーも同じ領域を編集できます。キャンバスを作成すると、エージェントはプロンプトとワークフローに基づいて内容を構築します。その後も、機能の追加、削除、修正を依頼できます。作成したキャンバスは、アプリの右側のパネルに開きます。 - -一般的な例は次のとおりです。 - -- 1日の計画を立て、Issue と pull request に優先順位を付けるための **Markdown canvases**。 -- ユーザーとエージェントがカードを追加し、作業を列間で移動する **Agentic kanban boards**。 -- リポジトリの重要な Issue と繰り返し現れるテーマをまとめる **Issue triage boards**。 - -## キャンバスを使用する理由 - -タスクに構造、反復、検証が必要で、チャットだけでは不十分な場合はキャンバスを使用します。キャンバスでは次のことができます。 - -- ワークフローに合った実際の成果物に、エージェントの作業を結び付ける。 -- 共有領域で作業を直接調整または修正し、その変更を基にエージェントに作業を続けさせる。 -- チャットの応答だけでなく、成果物への目に見える変更として進捗を確認する。 - -## 作業を追跡するキャンバスを作成する - -星評価、ドキュメント標準、フィルター機能をすべてマージし、多くの成果をリリースしました。しかし、バックログにはまだ項目が残っています。作業をすばやくトリアージするためのキャンバスを作成します。 - -1. GitHub Copilot app に戻ります。アプリを閉じている場合は開きます。 -2. **Home screen** を選択します。 -3. リポジトリに `tailspin-toys` が選択されていることを確認します。 -4. プロンプトボックスで次のプロンプトを使用し、要件を満たすキャンバスを作成します。 - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -Copilot がキャンバスの作成を開始します。 - -> [!NOTE] -> 作成には数分かかります。複雑なタスクであるため、最初のバージョンでは満足できない場合があります。理想のツールになるまで、プロンプトで構築を続けるよう依頼できます。 - -## キャンバスを保存してリポジトリにマージする - -キャンバスは、指示ファイルやスキルと同様に、リポジトリのアセットにできます。Copilot にリポジトリへの追加とマージを依頼し、チーム全体で使用できるようにします。 - -1. 同じセッションで、次のプロンプトを使ってキャンバスをリポジトリに保存するよう Copilot に依頼します。 - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Copilot がキャンバスファイルを保存したら、右上隅にある **Create PR** の横のドロップダウンを選択します。 -3. **Agent merge** を選択して Agent Merge を有効にします。 - - ![GitHub Copilot app で展開された Create PR ドロップダウンの Agent merge オプションを矢印で示した画面](../../_images/app-enable-agent-merge.png) - -4. ボタンのテキストが **Agent merge** に変わります。 -5. **Agent merge** ボタンを選択し、Agent Merge のプロセスを開始します。 - -Copilot app が PR の作成と管理を開始します。最初にプロジェクトを調査して PR の最適な作成方法を判断し、PR を作成します。 - -しばらくすると、Copilot が再び作業を開始し、リポジトリ上ですべてのテストを実行する CI プロセスなど、PR の条件を確認します。ほかのチームメンバーによるレビュー、実行が必要なチェック (CI プロセス)、PR をマージできるかどうかのステータスを報告します。 - -6. **Agent merge** の横にあるドロップダウンを選択してから **Merge pull request** を選択し、Agent Merge に pull request のマージを許可します。 - - ![Agent merge ドロップダウンで、エージェントに許可された Address reviews、Fix CI failures、Resolve conflicts の操作と、矢印で示された Merge pull request](../../_images/app-agent-merge-merge.png) - -7. すべての CI プロセスが成功するまで待ちます。成功すると、Copilot が pull request を自動的にマージします。 - -これでチーム用の新しい共有キャンバスを作成できました。 - -## キャンバスで作業する - -キャンバスを作成できたので、新しいセッションを開始して使用します。 - -1. Copilot app で **tailspin-toys** の横にある **New session** を選択し、新しいセッションを開始します。 -2. 次のプロンプトを使い、トリアージ用キャンバスを開くよう Copilot に依頼します。 - - ```plaintext - Open the triage issues canvas - ``` - -3. 作成したキャンバスが新しいセッションで開いたことを確認します。 -4. 最も関心のある Issue の1つで **Add to current context** を選択します。 -5. Copilot が Issue の作業を開始します。 - -これで、作成したキャンバスを使って開発プロセスを効率化できました。 - -## まとめと次のステップ - -ユーザーとエージェントが共同作業できる共有領域を作成しました。具体的には、次の作業を行いました。 - -- キャンバスの概要と使用する場面を学習した。 -- エージェントと共有の Kanban トリアージボードのキャンバスを作成した。 -- Agent Merge を使ってキャンバスをリポジトリに保存し、マージした。 -- 新しいセッションでキャンバスを開き、そこから作業を開始した。 - -バックログを追跡できるようになったので、ここまで構築した内容と今後の進め方を振り返ります。[レッスン 8「振り返りと次のステップ」][next-lesson]に進んでください。 - -## リソース - -- [GitHub Copilot app での canvas extension の操作][canvas-docs] -- [Awesome Copilot の Canvases][awesome-copilot-canvases] -- [GitHub Copilot app について][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/7-qa-agent.md b/docs/ja-jp/app/7-qa-agent.md new file mode 100644 index 00000000..f0059a6a --- /dev/null +++ b/docs/ja-jp/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +title: "レッスン 7 - QA エージェントの作成と使用" +description: "テストのカバレッジ、quality-checks スキル、ブラウザーで直接得た証拠を組み合わせる、要件を起点とした QA プロファイルを作成します。" +authors: + - geektrainer +lastUpdated: 2026-09-14 +--- + +前のレッスンでは、quality-checks スキルを作成し、Playwright MCP で Copilot にブラウザーツールを提供しました。次は**QA カスタムエージェント**でこれらを組み合わせ、フィルター機能が要件を満たしているかレビューします。 + +このレッスンでは、次のことを行います。 + +- カスタムエージェントと指示、スキル、MCP ツールの関係を理解します。 +- 再利用可能な QA プロファイルを作成して確認します。 +- QA エージェントを選択し、フィルター機能の Issue に照らして結果をレビューします。 +- 機能の PR に向けて、プロファイルと必要なテストを保存します。 + +## シナリオ + +Tailspin Toys は、カテゴリとパブリッシャーによるフィルター機能のリリースを準備しています。自動チェックとブラウザーでの確認から有用な証拠が得られましたが、テストの成功だけでは、合意したすべての要件がカバーされているとはいえません。PR を作成する前に、要求された内容、実装された内容、対応が必要な点を重点的にレビューしたいと考えています。 + +Issue と承認済みの計画上の決定から始め、カバレッジを確認し、スキルとブラウザーツールで証拠を集める QA エージェントを作成します。役割は不足を特定し、レビューの準備ができているか説明することです。自分の作業を承認したり、PR をマージしたりすることではありません。 + +## カスタムエージェントとは + +カスタムエージェントは、Markdown プロファイルで定義する再利用可能な専門家の役割です。指示は Copilot のタスクへの取り組み方を方向付け、プロファイルを選択すると、その役割が会話に適用されます。このワークショップでは、`.github/agents/qa.agent.md` に役割を定義し、App で選択します。 + +これまで作成したカスタマイズには、それぞれ異なる役割があります。リポジトリの指示はチームの規約を説明し、quality-checks スキルは繰り返し実行できるチェックをまとめます。Playwright MCP はブラウザーツールを提供します。QA プロファイルは、これらを使って要件を評価し、結果を報告する方法を Copilot に指示します。既存の機能を置き換えたり、別のエージェントセッションを要求したりするものではありません。 + +## QA プロファイルを作成する + +レッスン6のフィルター機能のセッションを、同じワークツリーとブランチで続けます。**Interactive** モードで、quality-checks スキルが存在し、Playwright MCP が利用可能であることを確認します。機能の PR はレッスン8で作成します。このレッスンではプロファイルと、必要な場合に限りテストを追加します。 + +次のプロンプトを通常の Copilot エージェントに送ります。QA を選択する前に、生成されたファイルを確認します。 + +```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 の作成やマージ、追加のエージェントやスキルの作成はしないでください。 +``` + +## プロファイルを確認する + +1. **Changes** を開き、`.github/agents/qa.agent.md` を選択します。ファイルのレビューパネルからも開けます。 +2. フロントマターを読みます。`description` は必須で、`name: QA` により選択画面で識別しやすくなります。この演習では `model` と `tools` を指定せず、選択中のモデルと利用可能なツールを使います。通常の権限は引き続き適用されます。 +3. 指示をチェックリストとして読みます。要件を起点とし、スキルとブラウザーツールを使い、実際の不足にだけテストを追加し、失敗と阻害されたチェックを区別していますか。 +4. プロファイルを選択する前に、不足があれば Copilot に修正を依頼します。定義だけを作成し、QA の開始やアプリケーションの変更をしていないことを確認します。 + +> [!NOTE] +> 専門家のプロファイルは動作を方向付けますが、正しい結果を保証しません。エージェントのツール操作、テストの変更、レポートは引き続き確認が必要です。 + +## Issue に対して QA を実行する + +実行プロンプトは、プロファイルを読む既定のエージェントではなく、選択した **QA** カスタムエージェントに送るものです。同じフィルター機能のチェックアウトとブランチを維持します。 + +1. 現在のセッションで、[App のカスタマイズドキュメント][customize-app]に従い、プロンプトボックスのエージェント選択画面を開くか、`/agent` を入力します。 +2. **QA** を選択し、実行プロンプトを送る前に、App がアクティブなエージェントとして **QA** を明示していることを確認します。 +3. **QA** が一覧にない場合や、アクティブであることを確認できない場合は、このワークツリーとブランチを保ったまま一時停止し、講師に相談してください。新しい機能セッションを作成したり、根拠のない再読み込み手順を使ったり、既定のエージェントに `qa.agent.md` を読むよう依頼する方法で代用したりしてはいけません。 + +ドキュメントに記載された選択画面はセッション中に利用できますが、新しく作成したリポジトリのプロファイルが検出されるかどうかは App のバージョンによる場合があります。ファイルを書いたことを、有効化の証拠として扱ってはいけません。 + +両方のプレースホルダーを、実際のフィルター機能の Issue の URL と、レッスン4で承認した追加の取り決めに置き換えます。Issue だけで要件が十分な場合は `none` を使います。前のエージェントの記憶に依存してはいけません。 + +```plaintext +次の Issue に照らしてフィルター機能を検証してください: 。計画時に承認した追加の受け入れ条件は次のとおりです: <合意した追加の取り決めを貼り付けるか、なければ none と記入>。 + +Playwright MCP サーバーで動作を検証し、テストのカバレッジを確認して、不足するカバレッジに対してだけテストを追加し、quality-checks スキルを通じて検証を実行してください。証拠、チェック結果、阻害要因を報告してください。私の承認なしにアプリケーションコードを変更しないでください。コミットや pull request を作成しないでください。 +``` + +## 証拠をレビューする + +フィルター機能の Issue と承認した追加の取り決めを参照しながら、レポートを読みます。 + +1. 各条件が適切なテストと観察可能な動作に対応しているか確認します。たとえば、カテゴリとパブリッシャーの組み合わせでは、操作に反応するだけでなく、表示されたゲームについての証拠が必要です。 +2. 実際の Playwright MCP ツール操作を確認し、テストしたサーバーがこのチェックアウトのものか確認します。ブラウザーチェックと自動 E2E で、古いサーバーや別のチェックアウトを再利用してはいけません。 +3. lint、単体テスト、E2E テスト、型チェックの結果をレビューします。4つすべてを quality-checks スキルのスクリプトで実行する必要があります。予定コマンドの要約は実行の証拠ではありません。 +4. **Changes** を開いて追加されたテストを確認し、レポートに記載された不足と照らし合わせます。 + +追加されたテストをレビューします。アサーションを弱めず、実際の不足を埋める必要があります。カバレッジが十分なら、新しいテストがないことが適切です。阻害や失敗による **NO-GO** の判定は有効な結果であり、証拠を省く許可ではありません。 + +QA がアプリケーションの不具合を見つけた場合は、範囲を絞った修正を別途承認し、変更後のリビジョンで影響するチェックとブラウザー観察を再実行します。不足する前提条件やツールには、明示的な対処が必要です。古い証拠を変更後のコードの証明として扱ってはいけません。 + +## チェックポイントを保存する + +QA の役割は検証なので、コミットを依頼する前に通常のエージェントに戻ります。 + +1. PR のレッスンで使えるように、QA レポート、Issue の URL、承認した追加の取り決め、テストしたリビジョンを保持します。 +2. 同じセッションで、エージェント選択画面から通常の Copilot エージェントに戻り、**QA** が選択されていないことを確認します。 +3. 同じワークツリーとブランチを維持します。通常のエージェントの選択肢が見つからない場合は、別の機能セッションを開始したり QA にコミットを指示したりせず、講師に相談してください。 + +プロファイル、テストの変更、得られた証拠をレビューしたら、その QA のコンテキストとともに、通常のエージェントへチェックポイントのリクエストを送信します。 + +```plaintext +現在の差分をレビューし、QA エージェント定義と承認済みのテスト変更のチェックポイントコミットを作成してください。既存のフィルター機能のブランチを維持してください。プッシュや pull request の作成はしないでください。 +``` + +## まとめと次のステップ + +再利用可能な専門家の役割をワークフローに追加し、その作業をレビューしました。このレッスンでは、次のことを行いました。 + +- 要件を起点とする QA プロファイルを作成して確認しました。 +- プロファイルを選択してカバレッジを評価し、スキルと Playwright MCP で証拠を集めました。 +- 結果をレビューし、プロファイルと必要なテストをフィルター機能のブランチに保存しました。 + +機能レビューに必要な実装、スキル、QA プロファイル、テスト、検証レポートがそろいました。未解決の指摘は引き継いでください。失敗や阻害という結果はマージの承認ではありません。[レッスン 8 - 機能の PR を作成してマージする][next-lesson]で、マイルストーン全体をレビューし、Agent Merge を使います。 + +## リソース + +- [カスタムエージェントの選択を含む GitHub Copilot App のカスタマイズ][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/ja-jp/app/8-create-pull-request.md b/docs/ja-jp/app/8-create-pull-request.md new file mode 100644 index 00000000..76b5db79 --- /dev/null +++ b/docs/ja-jp/app/8-create-pull-request.md @@ -0,0 +1,90 @@ +--- +title: "レッスン 8 - 機能の PR の作成とマージ" +description: "フィルター機能、スキル、QA プロファイル、テストをまとめてレビューし、PR 3 を作成して Agent Merge を明示的に承認します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +フィルター機能の実装、quality-checks スキル、QA プロファイル、関連するテストを、1つのブランチにチェックポイントとして保存しました。これらをまとめてレビューし、現在の QA の証拠を使って PR 3 を準備します。星評価と指示の PR はすでに明示的にマージしました。今回は、別の機能やブランチとしてではなく、PR ワークフローの中で **Agent Merge** を使用します。 + +このレッスンでは、次の内容を学習します。 + +- Agent Merge の概要と、マージのライフサイクルを自動化する仕組みを学ぶ。 +- 機能の PR 全体と検証の証拠を確認する。 +- レビュー後にのみ Agent Merge を承認し、PR のマージを確認する。 + +## シナリオ + +ここ数回のモジュールでは、コードの作成から Copilot による UI の直接検証まで、さまざまなレベルの自動化を確認しました。開発をさらに高速化するために、Tailspin Toys は審査および検証済みの pull request を自動的にマージする方法を検討しています。 + +## Agent Merge の概要 + +**Agent Merge** を使うと、Copilot app で pull request をマージするまでの最終工程を自動化できます。有効にすると、アプリのセッションが pull request を読み取り、失敗した CI チェックの修正、レビューコメントへの対応、必要に応じたリベースなど、マージを妨げる問題に対処します。そして GitHub で許可され次第、pull request をマージします。バックグラウンドで動作し、アプリを再起動しても継続し、pull request がマージされると自動的に無効になります。 + +ここまでは、自分で **Merge pull request** を選択していました。Agent Merge に任せることもできますが、コードの編集やマージには引き続き明示的な承認が必要です。マージを許可する前に、許可される操作と作業内容をレビューしてください。 + +## マイルストーン全体をレビューする + +レッスン4~7のフィルター機能のセッションを維持します。最新のチェックポイントだけでなく、`main` に対するブランチの差分全体を確認してください。フィルター機能、`.github/skills/quality-checks/SKILL.md`、同梱のスクリプト、`.github/agents/qa.agent.md`、関連するテストが含まれているはずです。 + +コミットや PR 操作を依頼する前に、エージェント選択で **QA** から通常の Copilot エージェントに戻し、**Interactive** モードを維持します。QA プロファイルの役割は検証であり、リリースではありません。エージェントを変更しても、フィルター機能のセッション、チェックアウト、ブランチは変更しないでください。 + +このワークショップでは、機能の作業と再利用可能な品質管理の仕組みを意図的に1つの PR にまとめます。実際のチームでは分割する場合もありますが、ここではブランチの積み重ねや追加の PR を使わず、チェックポイントコミットでレビュー可能な段階を残します。 + +レッスン7の QA レポートをレビューします。4つすべてのチェックと関連するブラウザー観察が完了し、提出する最終リビジョンを対象としている場合にのみ証拠を再利用してください。コード変更、競合の解消、CI の修正でテスト対象が変わった場合は、関連するチェックとブラウザー観察を再実行し、証拠を更新します。失敗やブロックを示す **NO-GO** レポートは、マージの承認ではありません。 + +差分と証拠が整ったら、次を送信します。 + +```plaintext +main に対するフィルター機能のブランチの差分全体を、フィルター機能、quality-checks スキルとスクリプト、QA エージェント定義、関連するテストも含めてレビューしてください。Issue の条件、承認済みの追加の取り決め、現在の QA の証拠をまとめてください。最終リビジョンにも適用できる場合にのみ検証を再利用し、古い証拠、不足、失敗があれば続行前に報告してください。 + +レビュー済みの変更と検証が整っていれば、このマイルストーンの承認済みの変更で残っているものをコミットし、このブランチをプッシュして、リポジトリの PR テンプレートと実際のフィルター機能の Issue の URL を使い、main を対象とする機能の PR を1つ作成してください。このブランチのチェックポイント履歴を保持してください。コントリビューション用スキルの使用、別のブランチや PR の作成、マージはまだ行わないでください。 +``` + +**My work** で PR を開き、**Files changed**、説明、レビュー、チェック結果を確認します。Tailspin Toys 自体のワークフローファイルと必須チェックを確認してください。すべてのローカルチェックやブラウザー観察が CI で実行されるとは限りません。ワークショップ公開用の Astro ビルドやリンクチェッカーは別のリポジトリのもので、この機能を検証するものではありません。 + +## Agent Merge で PR を管理する + +既存の PR をレビューした後、この同じセッションで Agent Merge を設定します。2つ目の PR を作成しないでください。 + +1. フィルター機能のセッションに戻り、PR 3 にリンクされていることを確認します。 +2. 右上隅の PR 操作のドロップダウンを開きます。PR がまだない場合は **Create PR** の横にあります。PR がリンクされるとラベルが変わる場合があります。 +3. **Agent merge** を選択して Agent Merge を有効にします。 + +4. **Address reviews**、**Fix CI failures**、**Resolve conflicts**、**Merge pull request** など、利用可能な権限を確認します。指摘事項や検証が未解決の間はマージ権限を無効のままにします。 +5. 開始前に次の範囲と承認の指示を送信してから、**Agent merge** を選択します。 + + ```plaintext + この既存のフィルター機能の PR を Agent Merge で管理してください。レビューや CI の阻害要因には、この PR の範囲内でのみ対処してください。テストや要件を弱めず、無関係な変更やインストールの前には確認してください。テスト済みリビジョンに変更があれば、関連するチェックとブラウザーでの証拠を更新する必要があります。古い QA 結果を変更後のコードの証明にしないでください。 + + 最終差分と証拠をレビューした後で私が Merge pull request を明示的に有効にするまで、マージしないでください。別の PR の作成やキャンバスタスクの開始はしないでください。 + ``` + +6. 追加の変更と更新された結果をレビューします。最終差分を承認し、必須の CI とレビューが成功して、QA の証拠がそのリビジョンに適用できることを確認したら、**Agent merge** の横のドロップダウンから **Merge pull request** を選択し、マージを明示的に承認します。 + + ![Agent merge ドロップダウンで、エージェントに許可された Address reviews、Fix CI failures、Resolve conflicts の操作と、矢印で示された Merge pull request](../../_images/app-agent-merge-merge.png) + +7. GitHub で PR 3 が単にマージ可能または待機中ではなく **Merged** と表示されることを確認します。Agent Merge はリポジトリの保護や権限不足を回避しません。続行前にそれらの阻害要因を解消してください。 + +そのマージが完了してから、キャンバスのマイルストーンを開始します。レッスン9では新しいワークツリーを作成し、セッションのブランチを最新の `origin/main` まで fast-forward することで、マージ済みの機能全体を含む状態からキャンバスの作業を始めます。 + +## まとめと次のステップ + +コードの生成、テストと検証、pull request のプロセスなど、開発プロセスの複数の部分を自動化しました。具体的には、次の作業を行いました。 + +- Agent Merge の概要と、マージのライフサイクルを自動化する仕組みを学習した。 +- フィルター機能、スキル、QA プロファイル、テストの差分全体を PR 3 としてレビューした。 +- 現在の QA の証拠を再利用し、CI を確認して、Agent Merge を明示的に承認した。 + +次は、エージェントと一緒に作業を計画して視覚化する、より高度な方法である**キャンバス**を確認します。[レッスン 9「トリアージキャンバスの作成」][next-lesson]に進んでください。 + +## リソース + +- [GitHub Copilot app での Issue と pull request の管理][managing-issues-prs] +- [GitHub Copilot app について][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/8-review.md b/docs/ja-jp/app/8-review.md deleted file mode 100644 index cbcdcf44..00000000 --- a/docs/ja-jp/app/8-review.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "レッスン 8 - 振り返りと次のステップ" -description: "GitHub Copilot app のハーネスを振り返り、繰り返し発生する作業を自動化して、次に学ぶ内容を確認します。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -ここ数回のレッスンでは、GitHub Copilot app を使い、アイデアから機能のマージまでを実践しました。取り組んだ内容は次のとおりです。 - -- リポジトリを接続し、アプリのワークスペースと用意されたバックログを確認した。 -- 直接指定したタスクと Issue からセッションを開始し、Plan モードと Autopilot モードでエージェントの動作を制御した。 -- カスタム指示と再利用可能なスキルでエージェントをガイドした。 -- Playwright MCP server を使い、実際のブラウザーで作業をテストした。 -- 共有キャンバスでエージェントと共同作業した。 -- github.com で自分でマージする方法から、**Agent Merge** に pull request のマージを任せる方法まで、段階的なマージ自動化を使って変更をリリースした。 - -繰り返し発生する作業を自動化し、ベストプラクティスと今後の進め方を確認します。 - -## 繰り返し発生する作業を自動化する - -アプリでは、**automations** を使って、スケジュールまたはオンデマンドでエージェントを実行できます。新しい Issue のトリアージや最近のアクティビティの振り返りなど、定型的なタスクに適しています。シンプルで破壊的でない automation を作成します。 - -1. サイドバーで **Automations** を選択してから **New automation** を選択します。 -2. `Recap my recent work` などの名前を付けます。 -3. トリガーを選択します。**Manual** はオンデマンドで実行し、**On a schedule** は自動的に実行し、**When an issue is created** は新しい Issue に反応します。このレッスンでは **Manual** を選択します。 -4. automation が何も変更しないように、次の例のような読み取り専用のプロンプトを入力します。 - - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` - -5. プロジェクト (Tailspin Toys リポジトリ) を選択し、automation を作成します。 -6. オンデマンドで実行し、結果を確認します。 - -> [!TIP] -> Automations はローカルまたはクラウドで実行できます。スケジュールに従って無人で実行する場合は、**Run in the cloud** を有効にし、automation に使用を許可する **Tools** を選択します。出力を信頼できるようになるまでは、スケジュールされた automations の範囲を限定し、破壊的でないものにしてください。 - -## ベストプラクティス - -AI ツールを使用するときは、その周辺の基盤が出力の品質を左右します。このワークショップでは、指示ファイル、スキル、カスタムエージェントがそれぞれ役割を果たしました。これらに投資し、セッション間で再利用してください。 - -タスクに合わせて**モードとモデル**を選択します。構築前にアプローチを検討するには **Plan**、対象を絞った変更で作業に関与し続けるには **Interactive**、範囲が明確で分離されたタスクに限って **Autopilot** を使用します。定型的な編集には高速なモデルを選び、複雑な作業には推論能力が高く、より多くの推論を行うモデルを選びます。 - -基盤と同じくらい、コンテキストも重要です。何を、なぜ、どのように構築するかを明確に説明すると、出力は大きく変わります。アイデアを本格的なセッションに移す前に範囲を決める場所として、Quick chats が役立ちます。 - -## さらに確認する機能 - -コアワークフローを学習しました。ほかにも確認する価値がある機能があります。 - -- 完全なセッションを必要としない、その場限りの簡単な質問に使用する **Quick chats**。 -- 構築前に問題について対話し、重要なフィードバックを得るための **Rubber duck**。 -- ロール、その tools、指示をまとめ、繰り返し使用する専門的な作業に対応する [**Custom agents**][custom-agents]。 -- セッションで起きたことの記録を生成する [`/chronicle`][chronicle]。 -- Ollama、Foundry Local、LM Studio を介したローカルモデルなど、独自のプロバイダーのモデルを使用する [Bring your own key (BYOK)][byok]。 -- GitHub がホストする分離環境でセッションを実行する [Cloud sandboxes][sandboxes]。 -- アプリを直接リポジトリ、セッション、プロンプトの画面で開く [Deep links][deep-links]。 - -## 次のステップ - -ツールを使いこなす最良の方法は、使い続けることです。実稼働コード、趣味のコード、長年構想していながら構築できていなかった小さなアプリなどに活用してください。学んだことをチームと共有し、チームからも学びましょう。そして、引き続きドキュメントを確認してください。 - -GitHub Copilot エコシステムをさらに学ぶには、[VS Code ハーネス](../../vscode/)、[Copilot CLI ハーネス](../../cli/)、[Cloud agent ハーネス](../../cloud/)を確認してください。 - -## リソース - -- [GitHub Copilot app について][about-copilot-app] -- [GitHub Copilot app の概要][getting-started] -- [GitHub Copilot app のカスタマイズ][customize] -- [Automations の使用][using-automations] -- [Canvas extensions の操作][canvas-docs] -- [クラウドサンドボックスとローカルサンドボックスについて][sandboxes] - -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app -[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started -[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app -[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle -[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models -[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/ja-jp/app/9-canvases.md b/docs/ja-jp/app/9-canvases.md new file mode 100644 index 00000000..5e31ecea --- /dev/null +++ b/docs/ja-jp/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "レッスン 9 - トリアージキャンバスの作成" +description: "リポジトリに保存するトリアージキャンバスを作成・レビューして PR 4 をマージし、別の機能に着手せずキャンバスを再度開いて Issue のコンテキストを追加します。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +ここまでは、チャットを通じてエージェントを指示してきました。しかし、多くの作業は会話の中ではなく、ボード、ドキュメント、チェックリスト上で行われます。**キャンバス**は、まさにそのような作業のために、アプリ内でユーザーとエージェントが共有できる領域です。このレッスンでは、ここまで取り組んできたバックログの計画と追跡に使用する、シンプルなキャンバスを作成します。 + +このレッスンでは、次の内容を学習します。 + +- キャンバスの概要と使用する場面を理解する。 +- バックログをトリアージする共有 Kanban ボードのキャンバスを作成する。 +- キャンバスをリポジトリに保存し、チーム向けにマージする。 +- 別の機能を実装せずにキャンバスを再度開き、Issue のコンテキストを追加する。 + +## シナリオ + +Issue の一覧を見ると、負担に感じることがあります。Tailspin Toys の開発者は、Issue をトリアージし、その詳細をセッションのコンテキストに追加するツールを求めています。コンテキストの追加は Issue の実装を許可するものではありません。この演習は5つ目の PR ではなく、再利用可能なボードの完成で終わります。 + +## キャンバスとは + +[キャンバス][canvas-docs]は、計画、トリアージボード、リリースチェックリスト、ダッシュボード、ドキュメントなどの作業成果物を扱う、共有の対話型領域です。チャットは意図の説明や曖昧さの検討に適していますが、多くの作業は具体的な*領域*上で行われます。キャンバスを使うと、その領域でエージェントと直接共同作業できます。 + +キャンバスは**双方向**です。エージェントが作業中にキャンバスを更新できる一方で、ユーザーも同じ領域を編集できます。キャンバスを作成すると、エージェントはプロンプトとワークフローに基づいて内容を構築します。その後も、機能の追加、削除、修正を依頼できます。作成したキャンバスは、アプリの右側のパネルに開きます。 + +一般的な例は次のとおりです。 + +- 1日の計画を立て、Issue と pull request に優先順位を付けるための **Markdown canvases**。 +- ユーザーとエージェントがカードを追加し、作業を列間で移動する **Agentic kanban boards**。 +- リポジトリの重要な Issue と繰り返し現れるテーマをまとめる **Issue triage boards**。 + +## キャンバスを使用する理由 + +タスクに構造、反復、検証が必要で、チャットだけでは不十分な場合はキャンバスを使用します。キャンバスでは次のことができます。 + +- ワークフローに合った実際の成果物に、エージェントの作業を結び付ける。 +- 共有領域で作業を直接調整または修正し、その変更を基にエージェントに作業を続けさせる。 +- チャットの応答だけでなく、成果物への目に見える変更として進捗を確認する。 + +## 作業を追跡するキャンバスを作成する + +PR 3 がマージされたことを確認します。キャンバスを始める前に、星評価、ドキュメント標準、フィルター機能、品質チェック用スキル、QA プロファイルがすべて `main` にある必要があります。この最後の PR マイルストーンには、新しいセッションと1つのブランチを使用します。 + +1. GitHub Copilot app に戻ります。アプリを閉じている場合は開きます。 +2. **Home screen** を選択します。 +3. リポジトリに `tailspin-toys` が選択されていることを確認します。 +4. **new working tree** と **Interactive** モードを選択します。ファイルを作成する前に、次の開始状態の確認を依頼します。 + + ```plaintext + 何も実装せずに、この新しいキャンバスのセッションを準備してください。未コミットの変更がない新しいワークツリーであることを確認し、origin をフェッチして、現在のセッションのブランチを origin/main まで fast-forward してください。チェックアウト、ブランチ、一致した HEAD と origin/main のリビジョンを報告してください。フィルター機能の PR がマージされ、フィルター機能、quality-checks スキル、QA プロファイルが存在することを確認してください。 + + 未コミットの変更、分岐、前のマージの不足がある場合は停止してください。リセット、作業の破棄、ブランチの切り替え、別のブランチの作成はしないでください。開始状態を報告したら停止してください。 + ``` + +5. 開始状態の報告を確認してから、リポジトリに保存するキャンバスを依頼します。 + + ```plaintext + App がサポートするキャンバス拡張機能のワークフローを使用し、このリポジトリ用の基本的な Kanban トリアージキャンバスを作成してください。チームで再利用できるよう、定義を .github/extensions/ に保存してください。既存の拡張機能を調べて保持し、同梱のデータベースエクスプローラーを上書きしないでください。 + + 現在オープンな Issue を読んでください。対応が必要である可能性が最も高い3件を目立たせ、残りを下に表示してください。上位の各 Issue にはタイトル、内容の概要、URL、優先順位の理由を含めてください。順位は提案であり、Issue を変更する指示ではないものとして扱ってください。 + + 各カードに、このセッションにだけ Issue の詳細を追加する Add to current context アクションを用意してください。実装の開始、セッションやブランチの作成、Issue の状態変更、PR の作成は行わないようにしてください。キャンバスの範囲を限定し、キーボードで利用可能にしてください。 + + 生成したファイルを提示し、確認できるようキャンバスを開いてください。アプリケーションコードの変更、コミット、プッシュ、PR の作成はしないでください。インストールや依存関係の追加の前に確認してください。 + ``` + +Copilot がキャンバスのファイルを作成し、共有領域を開きます。アクションを信頼して使用する前に、生成された拡張機能をレビューしてください。単なる画像ではなく、リポジトリ内の実行可能なコンテンツです。 + +> [!NOTE] +> 最初のバージョンに改善が必要な場合は、トリアージの範囲内で対象を絞った改善を依頼します。この演習をバックログの Issue の実装に変えないでください。 + +## キャンバスを確認して操作する + +1. **Changes** を開き、キャンバス定義がユーザーやセッション専用ではなく、リポジトリの `.github/extensions/` に保存されていることを確認します。既存の拡張機能とアプリケーションファイルが変更されていないことも確認します。 +2. ボードを実際のオープンな Issue と比較し、順位の理由を評価します。 +3. カードと操作部品が読みやすく、キーボードで利用できることを確認します。 +4. Issue の **Add to current context** を選択し、詳細だけが会話に入ることを確認します。実装や Issue の状態変更が始まってはいけません。 +5. 修正があればレビューし、変更したファイルに適用できる既存の検証を実行するよう Copilot に依頼します。開いたから正しいと判断せず、結果と阻害要因を記録します。 + +## キャンバスを保存してリポジトリにマージする + +キャンバスはすでにリポジトリのアセットです。レビュー済みのキャンバスの作業だけをコミットし、PR 4 として提出します。 + +1. 同じセッションで、次を送信します。 + + ```plaintext + リポジトリに保存したトリアージキャンバスの差分と検証の証拠をレビューしてください。承認済みのキャンバスファイルをこのセッションのブランチにコミットし、プッシュして、リポジトリの PR テンプレートを使用して main を対象とする PR を1つ作成してください。キャンバスの動作と、Issue の追加がコンテキストだけを追加することをどう検証したかを説明してください。まだマージせず、バックログの Issue は実装しないでください。 + ``` + +2. **My work** で PR の差分全体とチェックをレビューします。キャンバスが含まれ、無関係なアプリケーションの作業が含まれていないことを確認します。 +3. 同じキャンバスのセッションで PR 操作のドロップダウンを開き、**Agent merge** を選択します。許可する操作をレビューし、最終結果を承認するまで **Merge pull request** を無効にしておきます。 +4. Agent Merge を開始する前に範囲を設定します。 + + ```plaintext + この既存のキャンバスの PR を Agent Merge で管理してください。範囲内のレビューと CI の阻害要因にだけ対処し、無関係な変更やインストールの前には確認してください。キャンバスを変更した場合は、影響する検証を繰り返して証拠を更新してください。レビュー後に私が Merge pull request を明示的に有効にするまでマージしないでください。バックログの Issue の実装や別の PR の作成はしないでください。 + ``` + +5. **Agent merge** を選択し、追加の変更をレビューします。学習用リポジトリの実際の CI チェックを確認し、失敗を解消してください。CI はキャンバスの操作確認の代わりにはなりません。 + +6. 最終差分と現在の証拠が承認され、必須のチェックとレビューが成功したら、Agent Merge のドロップダウンから **Merge pull request** を選択してマージを明示的に許可します。 + + ![Agent merge ドロップダウンで、エージェントに許可された Address reviews、Fix CI failures、Resolve conflicts の操作と、矢印で示された Merge pull request](../../_images/app-agent-merge-merge.png) + +7. 続行前に、GitHub で PR 4 が **Merged** と表示されることを確認します。 + +これでチーム用の新しい共有キャンバスを作成できました。 + +## 別の機能に着手せずキャンバスを再度開く + +PR がマージされた後、同じキャンバスのセッションで、リポジトリに保存したキャンバスを再度開きます。これは確認の手順であり、別のブランチや PR のマイルストーンではありません。 + +1. キャンバスのセッションに戻って **Interactive** モードを維持し、キャンバスのパネルが開いていれば閉じます。 +2. 次を送信します。 + + ```plaintext + この同じセッションでリポジトリのトリアージキャンバスを再度開いてください。詳細を確認するためだけに Issue をコンテキストに追加します。ファイルの編集、Issue の実装や状態変更、別のセッションやブランチの作成、コミット、プッシュ、PR の作成はしないでください。 + ``` + +3. 定義を再生成せず、保存済みのキャンバスが再び開くことを確認します。 +4. 最も関心のある Issue の1つで **Add to current context** を選択します。 +5. 実装が始まらず、選択した Issue の詳細がコンテキストに表示されることを確認します。ここで終了してください。ワークショップの PR マイルストーンは5つではなく4つです。 + +これで、作成したキャンバスを使って開発プロセスを効率化できました。 + +## まとめと次のステップ + +ユーザーとエージェントが共同作業できる共有領域を作成しました。具体的には、次の作業を行いました。 + +- キャンバスの概要と使用する場面を学習した。 +- エージェントと共有の Kanban トリアージボードのキャンバスを作成した。 +- Agent Merge を使ってキャンバスをリポジトリに保存し、マージした。 +- マージ済みのキャンバスを再度開き、別の機能に着手せず Issue のコンテキストを追加した。 + +バックログを追跡できるようになったので、ここまで構築した内容と今後の進め方を振り返ります。[レッスン 10「振り返りと次のステップ」][next-lesson]に進んでください。 + +## リソース + +- [GitHub Copilot app での canvas extension の操作][canvas-docs] +- [Awesome Copilot の Canvases][awesome-copilot-canvases] +- [GitHub Copilot app について][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ja-jp/app/README.md b/docs/ja-jp/app/README.md index fb9e8b76..fc96c289 100644 --- a/docs/ja-jp/app/README.md +++ b/docs/ja-jp/app/README.md @@ -3,12 +3,14 @@ slug: ja-jp/app title: "GitHub Copilot app" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [**GitHub Copilot app**](https://docs.github.com/copilot/concepts/agents/github-copilot-app) は Copilot CLI を基盤とするデスクトップアプリケーションで、エージェント主導の開発を単一の作業用ワークスペースで実現します。並列エージェントセッション、切り替え可能なセッションモード、共有キャンバス、GitHub Issue と pull request のネイティブ管理機能を備えています。さらに、リベース、レビューのフィードバック、CI の修正、マージまで pull request を導く **Agent Merge** も利用できます。 -一連のレッスンでは、アプリをインストールしてプロジェクトを設定した後、アプリのワークスペースと、テンプレートによって用意されたバックログを確認します。まず、星評価を追加する小さな変更に取り組みます。次に、Issue に基づいてカスタム指示の標準を追加し、分離されたエージェントセッションでフィルター機能を構築して、再利用可能なスキルで検証します。Playwright MCP server を追加して実際のブラウザーで機能を確認した後、段階的にマージの自動化を進め、最後は **Agent Merge** で pull request をマージします。最後に、共有キャンバスで共同作業し、繰り返し発生する作業を自動化します。アイデアから機能のマージまで、開発の一連の流れを体験できます。 +セットアップを扱うレッスン0~1で、プロジェクトと App のワークスペースを準備します。9つのコアモジュールであるレッスン2~10では、まず星評価を追加する小さな変更と、実際のコードで効果を確認するドキュメント規約に取り組みます。次にフィルター機能を計画・構築し、シェルスクリプトを同梱した quality-checks スキルを作成して実行します。Playwright MCP で機能を観察し、要件とカバレッジを評価する QA カスタムエージェントを作成します。機能全体の PR をレビューして Agent Merge を承認した後、共有トリアージキャンバスを作成してマージします。 + +ワークショップには4つの PR マイルストーンがあります。星評価、指示とその実証、フィルター機能とスキル・QA プロファイル・テスト、そしてキャンバスです。各マイルストーンは更新済みの `main` から開始し、モジュールごとではなく PR ごとに1つのブランチを使用します。レッスン4~8では、同じフィルター機能のセッション、ワークツリー、ブランチを維持します。キャンバスを再度開く際は Issue のコンテキストを追加するだけで、別の機能や5つ目の PR には着手しません。自動化は次のステップとしてリンクを紹介し、追加の演習にはしません。 ## レッスン @@ -16,13 +18,15 @@ lastUpdated: 2026-06-30 |--------|-------|-------------| | [0. 前提条件][ex0] | セットアップ | Node.js をインストールし、Tailspin Toys プロジェクトの自分用コピーを作成します | | [1. Copilot app のインストール][ex1] | セットアップ | アプリをインストールしてプロジェクトを接続し、ワークスペースを確認します | -| [2. 最初のエージェントセッションの実行][ex2] | 最初の変更 | セッションを開始し、最初の pull request として小さな変更をリリースします | -| [3. カスタム指示による Copilot のガイド][ex3] | コンテキスト | Issue に基づいてドキュメント標準を追加し、マージします | -| [4. Autopilot による機能の構築][ex4] | コア機能 | Plan と Autopilot を使ってフィルター機能を構築し、スキルで検証します | -| [5. Playwright MCP によるテスト][ex5] | 外部ツール | Playwright MCP server を追加し、ブラウザーで機能を確認します | -| [6. Agent Merge によるマージ][ex6] | マージ | Agent Merge でフィルター機能の pull request を修正してマージします | -| [7. キャンバスを使った計画][ex7] | コラボレーション | 共有キャンバスを作成し、作業の計画と追跡に使用します | -| [8. 振り返りと次のステップ][ex8] | まとめ | 繰り返し発生するタスクを自動化し、次に学ぶ内容を確認します | +| [2. 星評価の追加で小さな成果を得る][ex2] | 最初の変更 | 既存の評価と null の場合の表示を追加し、PR 1 をマージします | +| [3. カスタム指示による Copilot のガイド][ex3] | コンテキスト | ドキュメント標準と実際の実証コードを追加し、PR 2 をマージします | +| [4. Plan と Autopilot によるフィルター機能の構築][ex4] | 実装 | 計画を承認し、フィルター機能を実装・検証してチェックポイントを保存します | +| [5. quality-checks スキルの作成と使用][ex5] | 繰り返し実行できるチェック | 同梱するシェルスクリプトを作成、確認、実行します | +| [6. Playwright MCP による機能の検証][ex6] | ブラウザーでの観察 | Customize から MCP を設定し、フィルターの動作を確認します | +| [7. QA エージェントの作成と使用][ex7] | 要件とカバレッジ | 専門家のプロファイルを選択し、最終検証の証拠を収集します | +| [8. 機能の PR の作成とマージ][ex8] | レビューとマージ | フィルター機能、スキル、QA プロファイル、テストをレビューし、PR 3 の Agent Merge を承認します | +| [9. トリアージキャンバスの作成][ex9] | コラボレーション | リポジトリに保存するキャンバスを PR 4 で共有し、Issue のコンテキストを追加します | +| [10. 振り返りと次のステップ][ex10] | まとめ | ワークフロー、成果物、追加のリソースを振り返ります | ## 前提条件 @@ -50,9 +54,11 @@ lastUpdated: 2026-06-30 [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students \ No newline at end of file diff --git a/docs/ko-kr/README.md b/docs/ko-kr/README.md index 2960a995..b0e2abac 100644 --- a/docs/ko-kr/README.md +++ b/docs/ko-kr/README.md @@ -27,7 +27,7 @@ GitHub Copilot은 어떤 작업 환경에서든 함께할 수 있습니다. 원 ### 🤖 [Copilot 앱](app/) -**GitHub Copilot 앱**은 Copilot CLI를 기반으로 구축된 데스크톱 애플리케이션입니다. 여러 에이전트 세션을 병렬로 실행하고, 세션 모드를 전환하고, 캔버스에서 협업하고, GitHub 이슈와 끌어오기 요청을 기본 기능으로 관리합니다. 여기에는 끌어오기 요청의 리베이스, 검토 피드백, CI 수정, 병합 과정을 관리하는 **Agent Merge**도 포함됩니다. +**GitHub Copilot 앱**은 Copilot CLI를 기반으로 구축된 데스크톱 애플리케이션입니다. 앱의 격리된 세션과 **Agent Merge**를 사용하여 동일한 설정 과정과 아홉 개의 핵심 모듈에서 별점, 지침, 필터링, 스킬, MCP, QA, 기능 PR 워크플로를 진행합니다. 네 번째 끌어오기 요청 마일스톤으로 리포지토리에 저장하는 캔버스를 만들고 병합한 다음 마무리합니다. ### ☁️ [Copilot 클라우드 에이전트](../cloud/) diff --git a/docs/ko-kr/app/0-prerequisites.md b/docs/ko-kr/app/0-prerequisites.md index 5296f49c..eed6f2bd 100644 --- a/docs/ko-kr/app/0-prerequisites.md +++ b/docs/ko-kr/app/0-prerequisites.md @@ -15,18 +15,18 @@ GitHub Copilot app은 Copilot과 GitHub를 모두 사용하는 중앙 허브 역 ## Node.js 설치 -여러 레슨에서 에이전트에게 기능을 구축하고 Tailspin Toys 테스트 도구 모음을 로컬에서 실행하도록 요청합니다. 이 작업에는 프로젝트에 필요한 유일한 런타임인 [**Node.js**][nodejs]가 필요합니다. **22 이상** 버전을 설치합니다. 현재 **LTS** 릴리스가 안전한 선택입니다. +여러 레슨에서 에이전트에게 기능을 구축하고 Tailspin Toys 테스트 도구 모음을 로컬에서 실행하도록 요청합니다. 이 작업에는 [**Node.js**][nodejs]가 필요합니다. **Node.js 22.13 이상**을 사용하고 체크아웃의 `package.json`과 README에서 지원 버전을 확인합니다. 모든 플랫폼에서 가장 간단한 방법은 공식 설치 프로그램을 사용하는 것입니다. 1. 운영 체제에서 Windows Terminal, macOS 터미널 또는 평소 사용하는 도구로 터미널 창을 엽니다. -2. 다음 명령을 실행하여 Node.js 22 이상이 설치되어 있는지 확인합니다. +2. 다음 명령을 실행하여 Node.js 22.13 이상이 설치되어 있는지 확인합니다. ```shell node --version ``` -3. `v22` 이상의 숫자가 표시되면 다음 섹션으로 건너뛸 수 있습니다. +3. 표시된 버전이 `v22.13.0` 이상이고 프로젝트에서 지원한다면 다음 섹션으로 건너뛸 수 있습니다. > [!TIP] > Node가 설치되어 있지 않거나 업데이트해야 하는 경우에만 다음 단계를 수행하면 됩니다. @@ -41,10 +41,10 @@ GitHub Copilot app은 Copilot과 GitHub를 모두 사용하는 중앙 허브 역 node --version ``` -9. `v22.x.x` 이상이 표시되어야 합니다. +9. 표시된 버전이 `v22.13.0` 이상이며 프로젝트에서 지원하는지 확인합니다. -> [!TIP] -> 컨테이너를 선호합니까? [**Docker**][docker]가 있다면 Node.js를 로컬에 설치하는 대신 리포지토리의 [dev container][dev-containers]를 사용할 수 있습니다. 이 컨테이너에는 Node가 포함되어 있으므로 두 가지가 모두 필요하지는 않습니다. +> [!IMPORTANT] +> 이 App 학습 과정은 로컬 워크트리를 사용합니다. 컨테이너에만 설치한 런타임은 로컬 세션에서 사용할 수 없습니다. 각 워크트리에는 프로젝트 의존성과 E2E 검사용 Playwright Chromium도 필요합니다. 워크트리를 준비할 때 학습용 리포지토리의 README를 따르고, 설치 요청을 검토한 후 승인합니다. ## 실습 리포지토리 설정 @@ -64,6 +64,8 @@ Tailspin Toys 프로젝트의 복사본에서 작업합니다. 지금 [템플릿 > [!NOTE] > 템플릿에서 리포지토리를 만들면 GitHub 이슈 백로그가 자동으로 생성됩니다. 워크숍 전체에서 이 이슈를 사용하므로 직접 등록할 항목은 없습니다. +개정된 템플릿의 새 복사본을 사용합니다. 리포지토리 지침, 애플리케이션 코드, 테스트, 기존 캔버스 확장은 포함되지만 사용자 지정 에이전트나 스킬은 제공되지 않습니다. 워크숍에서 직접 quality-checks 스킬과 QA 프로필을 만듭니다. 이전 복사본을 사용한다면 기존 사용자 지정을 덮어쓰지 말고 먼저 살펴봅니다. + ## 요약 및 다음 단계 설정이 완료되었습니다. 프로젝트를 컴퓨터에서 빌드하고 테스트할 수 있도록 Node.js를 설치하고, 템플릿에서 Tailspin Toys 리포지토리의 복사본을 만들었습니다. @@ -79,7 +81,5 @@ Tailspin Toys 프로젝트의 복사본에서 작업합니다. 지금 [템플릿 [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/1-install-copilot-app.md b/docs/ko-kr/app/1-install-copilot-app.md index 798c84ab..053d592d 100644 --- a/docs/ko-kr/app/1-install-copilot-app.md +++ b/docs/ko-kr/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ GitHub Copilot app을 사용하려면 먼저 앱을 설치해야 합니다. Wind 프로젝트를 연결했으므로 잠시 워크스페이스의 구성을 살펴봅니다. 앱의 사이드바는 몇 가지 영역으로 구성됩니다. -- **Sessions** — 에이전트가 작업하는 곳입니다. 각 세션은 격리된 워크스페이스에서 실행되므로 변경 내용이 충돌하지 않게 여러 세션을 동시에 실행할 수 있습니다. 다음 레슨에서 첫 번째 세션을 시작합니다. +- **Sessions** — 에이전트가 작업하는 곳입니다. 이 워크숍에서는 **new working tree**를 선택하여 PR 마일스톤마다 격리된 체크아웃과 브랜치를 사용합니다. 다른 워크스페이스 선택지도 있지만 여기서는 사용하지 않습니다. - **Quick chats** — 별도의 브랜치나 워크스페이스가 필요하지 않은 질문과 브레인스토밍을 위한 가벼운 대화입니다. 이 레슨의 마지막에서 사용해 봅니다. - **My work** — 앱의 **GitHub 기본 통합**을 통해 이슈와 끌어오기 요청을 표시합니다. 앱을 벗어나지 않고 이슈와 끌어오기 요청을 찾아 필터링하고, CI 상태를 확인하고, 이슈에서 세션을 시작하고, 끌어오기 요청을 검토할 수 있습니다. -- **Automations** — 일정에 따라 또는 요청 시 실행되는 저장된 에이전트 작업입니다. 이 실습 과정의 끝부분에서 하나를 만듭니다. +- **Customize** — MCP 서버, 스킬, 캔버스를 검색하고 관리합니다. Playwright MCP를 구성할 때 사용합니다. +- **Automations** — 일정에 따라 또는 요청 시 실행되는 저장된 에이전트 작업입니다. 마무리에서 다음 단계로 링크를 제공하며 추가 워크숍 실습으로 다루지는 않습니다. ### 미리 생성된 백로그 찾기 앱은 GitHub와 기본적으로 통합되므로 리포지토리에서 대기 중인 작업을 앱 안에서 바로 볼 수 있습니다. 템플릿에서 리포지토리를 만들 때 이슈 백로그가 생성되었습니다. 백로그가 있는지 확인합니다. 1. 사이드바에서 **My work**를 선택합니다. -2. 템플릿은 백로그에 여덟 개의 이슈를 생성했습니다. 이 하네스에서는 다음 세 이슈에 집중합니다. 표시되는지 확인합니다. +2. 이슈 번호를 가정하지 말고 다음 제목으로 이슈를 찾습니다. - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. 이슈를 선택하여 세부 정보를 읽습니다. 각 이슈는 에이전트 세션을 시작하는 지점이기도 합니다. 이 실습 과정의 뒷부분에서 이 이슈를 바탕으로 작업을 시작합니다. +3. 이슈를 선택하여 세부 정보를 읽습니다. 각 이슈는 에이전트 세션을 시작하는 지점이기도 합니다. 이 실습 과정의 뒷부분에서 이 이슈를 바탕으로 작업을 시작합니다. 다른 백로그 이슈는 캔버스의 컨텍스트로 사용하며 추가 구현 작업으로 다루지 않습니다. > [!NOTE] > My work의 항목 목록은 Copilot app에 추가한 리포지토리의 항목만 표시하도록 자동으로 필터링됩니다. 다른 리포지토리의 작업 항목을 보려면 해당 리포지토리를 앱에 추가합니다. @@ -70,7 +70,7 @@ GitHub Copilot app을 사용하려면 먼저 앱을 설치해야 합니다. Wind 2. 앱의 세션이 어떻게 작동하는지 질문합니다. ```plaintext - How does the GitHub Copilot app use worktrees? + GitHub Copilot app은 워크트리를 어떻게 사용합니까? ``` 3. 대화 보기에서 응답을 읽습니다. 각 세션이 격리된 git 작업 트리에서 실행되므로 변경 내용이 충돌하지 않게 여러 에이전트를 병렬로 실행할 수 있다는 점을 확인할 수 있습니다. 언제든지 대화를 계속하거나 새 채팅을 시작할 수 있습니다. @@ -84,7 +84,13 @@ GitHub Copilot app을 설치하고 프로젝트를 연결하고 워크스페이 - 워크스페이스를 살펴보고 **My work**에서 미리 생성된 백로그를 찾습니다. - 빠른 채팅을 사용하여 일회성 질문을 합니다. -다음으로 첫 번째 에이전트 세션을 시작하고 프로젝트를 처음으로 변경하여 게임 카드에 별점을 표시합니다. [레슨 2 - 첫 번째 에이전트 세션 실행][next-lesson]을 계속 진행합니다. +## PR 마일스톤 분리 + +별점, 지침과 작은 시연, 필터링과 스킬·QA 프로필·테스트, 마지막으로 이슈 분류 캔버스의 네 PR을 병합합니다. PR 마일스톤별로 하나의 브랜치를 사용합니다. 레슨 4~8은 동일한 필터링 세션, 워크트리, 브랜치에서 진행하고 추가 PR 대신 체크포인트 커밋을 만듭니다. + +새 App 워크트리가 오래된 로컬 상태에서 시작할 수 있습니다. 각 마일스톤에서 파일을 편집하기 전에 리포지토리를 가져오고 새 세션 브랜치를 최신 `origin/main`으로 fast-forward합니다. 다음 레슨에서 구체적인 절차를 다룹니다. 브랜치를 쌓거나 이전 작업을 cherry-pick하거나 활성 필터링 세션을 다른 브랜치로 전환하지 않습니다. + +다음으로 첫 번째 에이전트 세션을 시작하고 프로젝트를 처음으로 변경하여 게임 카드에 별점을 표시합니다. [레슨 2 - 별점 추가로 작은 성과 얻기][next-lesson]를 계속 진행합니다. ## 리소스 @@ -92,7 +98,7 @@ GitHub Copilot app을 설치하고 프로젝트를 연결하고 워크스페이 - [GitHub Copilot app 시작하기][getting-started] - [GitHub Copilot app에서 에이전트 세션 사용][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/ko-kr/app/10-review.md b/docs/ko-kr/app/10-review.md new file mode 100644 index 00000000..fe3c7053 --- /dev/null +++ b/docs/ko-kr/app/10-review.md @@ -0,0 +1,87 @@ +--- +title: "Lesson 10 - 마무리 및 다음 단계" +description: "App의 아홉 핵심 모듈, 네 PR 마일스톤, 재사용 가능한 품질 워크플로를 돌아보고 추가 리소스를 살펴봅니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +지난 여러 레슨에서 GitHub Copilot app으로 아이디어를 기능으로 만들고 병합하기까지 다음 작업을 수행했습니다. + +- 리포지토리를 연결하고 앱의 워크스페이스와 미리 생성된 백로그를 살펴봤습니다. +- 직접 작업과 이슈에서 세션을 시작하고 Plan 및 Autopilot 모드로 에이전트의 작업 방식을 제어했습니다. +- 사용자 지정 지침으로 에이전트를 안내한 다음, 셸 스크립트가 포함된 재사용 가능한 스킬을 만들도록 요청하고, 스크립트를 검토한 후 린트, 단위 테스트, 엔드투엔드 테스트, 타입 검사를 실행했습니다. +- Playwright MCP 서버를 사용하여 실제 브라우저에서 작업을 테스트했습니다. +- 요구 사항, 커버리지, 스킬 스크립트 결과, 브라우저 근거를 평가할 QA 사용자 지정 에이전트를 만들고 선택했습니다. +- 공유 캔버스에서 에이전트와 협업했습니다. +- 초기 PR을 직접 명시적으로 병합한 다음 기능과 캔버스 PR 워크플로에서 **Agent Merge**를 승인했습니다. + +설정 레슨 0~1에 이어 아홉 개의 핵심 모듈인 레슨 2~10을 진행했습니다. 산출물과 다음 단계를 돌아봅니다. 이 마무리에서는 다른 실습 작업을 시작하지 않습니다. + +## 제공한 결과 + +워크숍에는 네 번의 PR 마일스톤이 있으며, 각각 업데이트된 `main`에서 시작한 자체 브랜치를 사용합니다. + +1. **별점:** 게임 카드에 기존 `starRating`과 명시적인 미평가 상태를 표시합니다. +2. **지침과 시연:** 문서화 규칙을 추가하고 작은 실제 코드 변경에 미친 영향을 검증합니다. +3. **필터링과 품질 워크플로:** 이슈를 구현하고 셸 스크립트를 포함하는 `quality-checks` 스킬과 QA 프로필을 만들며 관련 테스트를 포함합니다. +4. **리포지토리에 저장한 이슈 분류 캔버스:** 다른 기능을 자동으로 구현하지 않고 이슈 컨텍스트를 추가하는 보드를 공유합니다. + +레슨 4~8은 동일한 필터링 세션, 워크트리, 브랜치를 사용했습니다. 체크포인트 커밋으로 PR 3 안에서 진행 상황을 보존했으며 스킬, MCP 구성, QA에 별도의 기능 브랜치가 필요하지 않았습니다. 이후 각 마일스톤은 앞선 PR이 병합되고 새 세션 브랜치가 `origin/main`에서 업데이트된 후에만 시작했습니다. + +## 서로 다른 검증 방식 + +초기 기능은 기존 npm 검사를 사용했습니다. 필터링에는 직접 수행하는 브라우저 검토를 추가했습니다. 스킬은 함께 제공되는 스크립트로 네 가지 검사를 반복 가능하게 만들었고, MCP는 에이전트의 직접 브라우저 관찰을 추가했으며, QA는 요구 사항과 커버리지를 최종 검증과 결합했습니다. PR에서는 제출한 리비전에 적용될 때만 QA 근거를 재사용했습니다. + +추가한 테스트는 실제 커버리지 부족을 해결해야 합니다. 새 테스트가 필요 없는 QA 실행도 올바를 수 있습니다. 누락된 도구, 건너뛴 검사, 실패는 드러내야 할 차단 요인이지 통과가 아닙니다. 병합 승인 전에 코드와 근거를 검토하고 변경 후 관련 근거를 갱신합니다. + +## 모범 사례 + +AI 도구를 사용할 때는 도구를 둘러싼 인프라가 결과의 품질을 좌우합니다. 이 워크숍에서는 지침, 스킬, QA 프로필을 만들었습니다. 이를 검토하고 세션 간에 재사용합니다. 사용자 지정 에이전트는 전문가 역할과 지침을 정의하며 사용 가능한 도구는 구성과 하네스 권한에 따라 결정됩니다. 스킬은 필요할 때 불러오는 재사용 가능한 작업 지침, 실행 가능한 스크립트, 보조 리소스를 묶어 제공합니다. 사용자 지정 에이전트도 스킬과 함께 제공되는 스크립트를 비롯한 스크립트를 실행할 수 있습니다. 설득력 있는 설명에 의존하지 말고 실제 스크립트 실행과 사용자 지정 에이전트 선택을 확인합니다. + +작업에 맞는 **모드와 모델**을 선택합니다. 구축 전에 접근 방식을 검토하려면 **Plan**을 사용하고, 범위가 명확한 변경에서 계속 참여하려면 **Interactive**를 사용하며, 범위가 명확하고 격리된 작업에만 **Autopilot**을 사용합니다. 일상적인 편집에는 빠른 모델을 선택하고 복잡한 작업에는 추론 능력이 더 높은 모델을 선택합니다. + +컨텍스트는 인프라만큼 중요합니다. 만들려는 *항목*, 그 *이유*, 원하는 *방식*을 명확하게 설명하면 출력이 크게 달라집니다. 빠른 채팅은 아이디어를 전체 세션에 적용하기 전에 범위를 정하기에 적합합니다. + +## 더 살펴볼 내용 + +핵심 워크플로를 모두 살펴봤습니다. 다음 기능도 확인해 볼 만합니다. + +- 전체 세션이 필요 없는 빠른 일회성 질문을 위한 **Quick chats** +- 최근 작업 요약 같은 반복 또는 요청 시 작업을 위한 [**Automations**][using-automations]. 도입 전에 일정, 권한, 범위를 검토합니다. 자동화 만들기는 다음 단계이며 이 워크숍에 포함되지 않습니다. +- 구축 전에 문제를 함께 검토하고 유용한 피드백을 받기 위한 **Rubber duck** +- 반복 가능한 전문 작업을 위해 역할, 도구, 지침을 패키지하는 [**Custom agents**][custom-agents] +- 세션에서 일어난 일을 서술형으로 생성하는 [`/chronicle`][chronicle] +- Ollama, Foundry Local, LM Studio를 통한 로컬 모델을 포함하여 자체 공급자의 모델을 사용하는 [Bring your own key (BYOK)][byok] +- GitHub에서 호스팅하는 격리된 환경에서 세션을 실행하는 [Cloud sandboxes][sandboxes] +- 리포지토리, 세션, 프롬프트에서 바로 앱을 여는 [Deep links][deep-links] + +## 다음 단계 + +어떤 도구든 더 능숙하게 사용하려면 계속 사용해야 합니다. 프로덕션 코드, 취미 프로젝트, 오랫동안 생각만 하고 만들지 못했던 작은 앱에 사용해 봅니다. 배운 내용을 팀과 공유하고 팀의 경험에서도 배웁니다. 언제나 그렇듯 문서를 살펴봅니다. + +GitHub Copilot 생태계를 더 살펴보려면 [VS Code 실습 과정][vscode-harness], [Copilot CLI 실습 과정][cli-harness], [Cloud agent 실습 과정][cloud-harness]을 확인합니다. + +## 리소스 + +- [GitHub Copilot app 정보][about-copilot-app] +- [GitHub Copilot app 시작하기][getting-started] +- [GitHub Copilot app 사용자 지정][customize] +- [자동화 사용][using-automations] +- [캔버스 확장 사용][canvas-docs] +- [클라우드 및 로컬 샌드박스 정보][sandboxes] + +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app +[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started +[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app +[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes +[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle +[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents +[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models +[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/ko-kr/app/2-add-star-rating.md b/docs/ko-kr/app/2-add-star-rating.md index 1bb6fc6f..35ea3808 100644 --- a/docs/ko-kr/app/2-add-star-rating.md +++ b/docs/ko-kr/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "Lesson 2 - 첫 번째 에이전트 세션 실행" +title: "Lesson 2 - 별점 추가로 작은 성과 얻기" description: "GitHub Copilot app에서 첫 번째 에이전트 세션을 시작하고 게임 카드를 조금 변경한 다음 첫 번째 끌어오기 요청으로 병합합니다." authors: - geektrainer @@ -22,7 +22,7 @@ Tailspin Toys의 각 게임에는 별점이 있을 수 있으며, 별점은 이 ## 세션 구조 -**세션**은 격리된 자체 워크스페이스에서 실행되는 에이전트와의 대화입니다. 모든 세션에는 **전용 git 작업 트리와 브랜치**가 제공됩니다. 따라서 변경 내용이 충돌하지 않게 한 세션에서는 기능을 추가하고 다른 세션에서는 버그를 수정하는 등 여러 세션을 동시에 실행할 수 있습니다. 세션은 사이드바에서 리포지토리별로 그룹화되며, 원하는 세션을 선택하여 전환할 수 있습니다. +**세션**은 에이전트와의 대화입니다. 이 워크숍에서는 **new working tree**를 선택하여 세션 전용 체크아웃과 브랜치를 사용합니다. 이렇게 하면 레슨마다 별도 브랜치를 만들지 않고 각 PR 마일스톤을 격리할 수 있습니다. 세션은 사이드바에서 리포지토리별로 그룹화되며, 원하는 세션을 선택하여 전환할 수 있습니다. 세션 안에는 에이전트와의 **대화**, 에이전트가 파일을 탐색하고 편집할 때의 **도구 활동**, diff와 함께 표시되는 **변경된 파일** 목록이 있습니다. @@ -36,16 +36,20 @@ Tailspin Toys의 각 게임에는 별점이 있을 수 있으며, 별점은 이 ![리포지토리 선택기가 tailspin-toys로 설정되고 프롬프트 아래에 모델 선택기가 표시된 GitHub Copilot app 프롬프트 상자](../../_images/app-2-start-session.png) -4. 다음 프롬프트를 사용하여 변경을 요청합니다. +4. 프롬프트 상자 아래에서 **new working tree**와 **Interactive** 모드를 선택합니다. 다음 프롬프트로 변경을 요청합니다. ```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. + 편집하기 전에 이 체크아웃과 브랜치를 식별하고, 커밋하지 않은 변경이 없는 새 워크트리인지 확인한 다음 origin을 가져오고 이 세션 브랜치를 origin/main으로 fast-forward해 주십시오. HEAD가 origin/main과 일치하는지 확인해 주십시오. 미커밋 변경이나 분기가 있거나 업데이트할 수 없으면 중단하고 설명해 주십시오. 재설정하거나 작업을 버리지 마십시오. + + 게임 카드에 각 게임의 별점을 표시해 주십시오. Game 타입에는 이미 starRating 필드가 있으며 5점 만점의 숫자이거나 아직 평가되지 않은 경우 null입니다. src/components/GameCard.astro의 각 카드에 표시하고, starRating이 null이면 대신 "No rating yet"을 표시해 주십시오. 변경을 작게 유지하고 카드 레이아웃을 재구성하거나 데이터 모델을 변경하지 마십시오. + + 리포지토리 지침을 따르고 적절한 테스트를 추가하거나 업데이트한 다음 관련된 기존 npm 검사를 실행해 주십시오. 필수 조건을 살펴보고 설치 전에 질문해 주십시오. 변경된 파일과 검사 결과를 보고한 다음 제가 검토할 수 있도록 중단해 주십시오. 커밋, 푸시, 끌어오기 요청 생성, 다른 기능 구현은 하지 마십시오. ``` > [!NOTE] > 프롬프트에 Copilot이 업데이트할 파일 이름을 포함했습니다. Copilot이 작업에 포함할 파일을 반드시 지정할 필요는 없지만, 방향을 제시하면 Copilot이 코드를 더 빠르게 생성하고 토큰 사용량을 줄이는 데 도움이 됩니다. -5. Enter를 선택하여 Copilot에 프롬프트를 보냅니다. +5. Enter를 눌러 Copilot에 프롬프트를 보냅니다. Copilot app은 먼저 프로젝트의 격리된 복사본인 새 작업 트리를 만들고 작업을 시작합니다. 그런 다음 프로젝트를 탐색하고 새 기능을 추가하기 위해 업데이트해야 할 파일을 찾은 후 필요한 코드를 만듭니다. 이제 Copilot app으로 새 기능을 추가했습니다. @@ -76,7 +80,9 @@ AI가 생성한 모든 변경 내용은 작더라도 병합하기 전에 검토 ## 변경 내용 확인 -코드를 읽고 작동한다고 가정해서는 안 됩니다. 모든 내용을 시각적으로 테스트해야 합니다. 터미널에서 앱을 시작한 다음 모든 기능이 작동하는지 확인합니다. Copilot app에는 터미널이 기본 제공됩니다. +브라우저를 열기 전에 에이전트의 자동 검사 결과를 검토합니다. 아직 존재하지 않는 스킬 대신 프로젝트의 기존 npm 스크립트를 사용하여 숫자 `starRating`과 `null` 대체 표시를 테스트하는지 확인합니다. 누락된 필수 조건이나 건너뛴 검사는 통과가 아닙니다. + +그런 다음 세션의 내장 터미널로 앱을 수동 확인합니다. 서버를 시작하기 전에 워크트리를 식별하고 다른 체크아웃의 서버를 재사용하지 않습니다. 1. Copilot app 오른쪽의 검토 패널에서 **Terminal**을 선택합니다. **Terminal** 버튼이 없으면 **+**(**Open in panel** 레이블)를 선택한 다음 **Terminal**을 선택합니다. @@ -89,26 +95,30 @@ AI가 생성한 모든 변경 내용은 작더라도 병합하기 전에 검토 ``` 3. 서버가 시작되면 브라우저 창을 엽니다. 잠시만 기다리면 됩니다. -4. [http://localhost:4321](http://localhost:4321)로 이동합니다. -5. 이제 랜딩 페이지의 모든 게임에 별점이 표시되어야 합니다. +4. 서버가 출력한 로컬 URL을 엽니다. 일반적으로 `http://localhost:4321`입니다. 포트가 사용 중이면 관련 없는 프로세스를 중지하지 말고 소유자를 확인합니다. +5. 평가된 게임 카드에 5점 만점의 값이 표시되는지 확인합니다. 미평가 데이터가 있으면 **No rating yet**이 표시되는지 확인합니다. 없다면 관찰했다고 주장하지 말고 자동 테스트로 null 사례를 검증합니다. 6. 터미널 창으로 돌아갑니다. -7. Ctrl+C를 선택하여 개발 서버를 중지합니다. +7. Control+C(Mac) 또는 Ctrl+C(Windows/Linux)를 눌러 직접 시작한 개발 서버를 중지합니다. ## 첫 번째 끌어오기 요청 열기 및 병합 -변경 내용이 올바르게 작동하므로 이제 제공할 차례입니다. 에이전트에게 끌어오기 요청을 열도록 요청한 다음 github.com에서 직접 검토하고 병합합니다. 지금은 이 과정을 수동으로 관리합니다. 이후 레슨에서는 Copilot이 일부 작업을 자동으로 처리하는 방법을 살펴봅니다. +변경 내용이 올바르므로 이제 PR 1을 만들 차례입니다. 먼저 구현과 별도로 커밋과 PR 생성을 승인합니다. + +```plaintext +별점 변경과 테스트의 전체 diff를 검토하고, 검증 결과를 요약하고, 검토된 변경을 이 세션 브랜치에 커밋해 주십시오. 브랜치를 푸시하고 리포지토리의 PR 템플릿을 사용하여 main을 대상으로 끌어오기 요청을 만들어 주십시오. 병합하지 마십시오. +``` -1. 오른쪽 위에서 **Create PR**을 선택합니다. +1. 세션에서 생성된 PR 링크를 엽니다. 앱에 **Create PR** 확인이 표시되면 이를 선택하여 요청을 승인하고 두 번째 PR을 만들지 않습니다. 2. 메시지가 표시되면 **Sign in with your browser**를 선택하고 안내에 따라 인증합니다. 3. Copilot이 PR을 만들기 시작합니다. -PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워크플로를 모니터링합니다. 잠시 후 오른쪽 위의 버튼이 **Ready to merge**로 바뀝니다. 이는 PR을 병합할 준비가 되었다는 표시입니다. +PR이 만들어지면 **My work**에서 전체 PR diff와 검사를 살펴봅니다. 학습용 리포지토리의 워크플로 결과를 읽고, 필수 검사와 검토가 완료되기를 기다리며, 실패를 해결한 후 병합합니다. **Ready to merge**는 변경 내용 검토나 로컬 검증 근거를 대체하지 않습니다. 4. 채팅 바로 위의 **PR** 버블을 선택하여 검토 창에서 PR을 열고 끌어오기 요청을 확인합니다. 필요에 따라 여기에서 PR을 검토할 수 있습니다. 5. 준비가 되면 **Ready to merge**를 선택합니다. 6. 새 대화 상자에서 **Merge pull request**를 선택하여 끌어오기 요청을 병합합니다. -이제 웹사이트에 새 기능을 제공했습니다. +계속하기 전에 PR 1이 `main`에 병합되었는지 확인합니다. 학습용 리포지토리를 병합하는 것만으로 웹사이트가 배포되지는 않습니다. 다음 레슨은 새 워크트리에서 시작하고 `origin/main`으로 업데이트하여 이 PR을 포함합니다. ## 요약 및 다음 단계 @@ -118,7 +128,7 @@ PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워 - 에이전트에게 게임 카드를 작고 구체적으로 변경하도록 지시했습니다. - 워크스페이스의 diff 보기에서 변경 내용을 검토했습니다. - 앱을 로컬에서 실행하여 브라우저에서 별점을 확인했습니다. -- 끌어오기 요청을 열고 github.com에서 직접 병합했습니다. +- PR 1을 만들고 검사를 검토한 다음 명시적으로 병합했습니다. 다음으로 백로그의 이슈 중 하나에서 시작하여 앱으로 리포지토리에 사용자 지정 지침 표준을 추가합니다. [레슨 3 - 사용자 지정 지침으로 Copilot 안내][next-lesson]를 계속 진행합니다. @@ -129,6 +139,7 @@ PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워 - [GitHub Copilot app으로 이슈 및 끌어오기 요청 관리][managing-issues-prs] [prior-lesson]: ../1-install-copilot-app/#github-copilot-app-설치-및-구성 +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/ko-kr/app/3-custom-instructions.md b/docs/ko-kr/app/3-custom-instructions.md index a8dad33c..978bc6ba 100644 --- a/docs/ko-kr/app/3-custom-instructions.md +++ b/docs/ko-kr/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "Lesson 3 - 사용자 지정 지침으로 Copilot 안내" -description: "GitHub Copilot app을 사용하여 백로그의 이슈에서 시작해 리포지토리에 사용자 지정 지침 표준을 추가하고 변경 내용을 끌어오기 요청으로 병합합니다." +description: "문서화 표준을 추가하고 작은 기존 도우미나 구성 요소에서 시연한 다음 둘을 두 번째 끌어오기 요청으로 병합합니다." authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- 생성형 AI를 사용할 때는 컨텍스트가 중요합니다. 작업을 특정 방식으로 수행해야 하거나 Copilot이 알아야 할 배경 정보가 있다면 해당 컨텍스트를 제공해야 합니다. 가장 강력한 도구 중 하나는 원하는 코드의 *내용*뿐 아니라 코드의 *구조*도 설명하는 [지침 파일][instruction-files]입니다. 이 레슨에서는 리포지토리에 문서화 표준을 추가합니다. 이후 대부분의 작업과 마찬가지로 백로그의 이슈에서 시작하여 에이전트가 변경하도록 합니다. @@ -12,15 +12,17 @@ lastUpdated: 2026-07-09 - 리포지토리 지침과 경로 범위 지침 파일이 에이전트에 전달되는 방식을 살펴봅니다. - 백로그의 지침 이슈에서 세션을 시작합니다. -- 에이전트에게 `.github/copilot-instructions.md`에 문서화 표준을 추가하도록 요청합니다. -- 변경 내용을 검토하고 끌어오기 요청으로 병합합니다. +- 에이전트에게 적절한 리포지토리 지침 파일에 범위를 좁힌 문서화 표준을 추가하도록 요청합니다. +- 작은 실제 코드 변경으로 표준을 시연하고 검증한 다음 PR 2를 병합합니다. ## 시나리오 모범적인 개발 조직인 Tailspin Toys에는 개발 방식에 관한 지침과 요구 사항이 있습니다. 여기에는 다음 항목이 포함됩니다. -- 코드에 TSDoc doc comments 형식의 문서를 추가해야 합니다. -- 형식을 문서화하고 린팅으로 적용해야 합니다. +- 주석은 코드를 다시 설명하기보다 의도와 명확하지 않은 결정을 설명해야 합니다. +- `db/`와 `src/lib/`에서 내보내는 함수는 TSDoc/JSDoc으로 목적, 매개 변수, 반환값을 문서화하고, 주입 가능한 `db` 인수가 있다면 함께 설명해야 합니다. +- 재사용 가능한 Astro 구성 요소는 `Props` 계약을 문서화하고, 관련 코드가 바뀌면 주석도 최신 상태로 유지해야 합니다. +- 기존 서식과 린트 지침을 보존해야 합니다. 지침 파일을 사용하면 Copilot이 이러한 방식에 맞게 작업을 수행하는 데 필요한 정보를 제공할 수 있습니다. @@ -28,13 +30,13 @@ lastUpdated: 2026-07-09 사용자 지정 지침은 Copilot에 컨텍스트와 기본 설정을 제공하여 코딩 스타일과 요구 사항을 더 잘 이해하게 합니다. 이 기능을 사용하면 Copilot이 더 관련성 높은 제안과 코드 조각을 생성하도록 안내할 수 있습니다. 선호하는 코딩 규칙과 라이브러리는 물론 코드에 포함할 주석 유형까지 지정할 수 있습니다. 리포지토리 전체에 적용되는 지침이나 작업 수준의 컨텍스트를 제공하는 특정 파일 유형용 지침을 만들 수 있습니다. -지침 파일에는 두 가지 유형이 있습니다. +이 프로젝트는 두 종류의 지침 파일을 사용합니다. - `.github/copilot-instructions.md`는 리포지토리의 **모든** 요청에서 Copilot에 전달되는 단일 지침 파일입니다. 이 파일에는 Copilot에 보내는 대부분의 채팅 또는 CLI 요청과 관련된 프로젝트 수준 정보를 포함해야 합니다. 사용 중인 기술 스택, 구축 중인 항목의 개요, 모범 사례, 기타 전역 지침을 포함할 수 있습니다. - 특정 작업이나 파일 유형에 맞게 `.github/instructions/*.instructions.md` 파일을 만들 수 있습니다. TypeScript 또는 Astro 같은 특정 언어나 UI 구성 요소 또는 새 단위 테스트 집합 만들기와 같은 작업에 관한 지침을 제공할 수 있습니다. > [!NOTE] -> Copilot은 AGENTS.md, CLAUDE.md, GEMINI.md를 통해 지침을 가져오는 다른 표준도 지원하므로 항상 올바른 컨텍스트를 제공할 수 있습니다. +> 다른 지침 형식과 지원 여부는 하네스에 따라 다릅니다. 특정 형식에 의존하기 전에 [사용자 지정 지침 지원 참조][custom-instructions-support]를 확인합니다. ### 지침 파일 관리 모범 사례 @@ -74,49 +76,55 @@ AI를 사용하는 방식이 하나로 정해져 있지 않듯 지침 파일을 11. 마지막으로 `.github/instructions/drizzle.instructions.md`를 열고 아래쪽으로 스크롤합니다. 다른 지침 파일(예: `unit-tests.instructions.md`)과 프로젝트의 기존 파일로 연결되는 링크를 확인합니다. 이를 통해 큰 지침 집합을 더 작고 재사용 가능한 파일로 나누고 Copilot이 코드를 생성할 때 따를 예제를 지정할 수 있습니다. 이 경로는 리포지토리 루트가 아니라 지침 파일을 기준으로 합니다. > [!NOTE] -> `copilot-instructions.md`의 **Code formatting requirements** 섹션에는 프로젝트의 코딩 표준이 있지만 아직 코드 내 문서는 요구하지 않습니다. 다음 단계에서 TSDoc doc comments와 파일 주석 헤더에 관한 규칙을 추가합니다. +> 규칙을 추가하기 전에 기존 지침과 실제 코딩 표준 이슈를 비교합니다. 이 레슨은 일률적인 파일 헤더나 코드를 다시 설명하는 주석이 아니라 의도 중심 주석, 내보내는 데이터 계층 함수 문서화, Astro `Props` 계약에 집중합니다. ## 지침 이슈에서 시작 -이전 레슨에서는 직접 프롬프트로 세션을 시작했습니다. 하지만 대부분의 작업은 이슈에서 시작합니다. 지침 파일 업데이트를 위해 등록된 이슈를 바탕으로 새 세션을 만들고 업데이트를 요청합니다. +이 세션을 만들기 전에 PR 1이 병합되었는지 확인합니다. PR 2용 새 워크트리에서 시작하고 별점 브랜치에서 계속하지 않습니다. 대부분의 작업은 이슈에서 시작하므로 코딩 표준 이슈를 요구 사항으로 사용합니다. > [!NOTE] > 지침 파일은 Copilot이 생성하는 코드에 큰 영향을 주므로 Copilot을 명확하게 안내하는지 주의 깊게 확인해야 합니다. 이 레슨처럼 Copilot으로 초안을 만든 다음 요구 사항을 충족하는지 직접 검토하는 방법이 좋습니다. 1. 사이드바에서 **My work**를 선택합니다. 2. **Update our repository coding standards** 이슈를 선택하여 엽니다. -3. 오른쪽 위의 **New session**을 선택하여 이슈를 바탕으로 새 세션을 시작합니다. +3. 오른쪽 위의 **New session**을 선택하고 **new working tree**와 **Interactive** 모드를 선택합니다. ![오른쪽 위의 New session 버튼을 화살표로 가리키는 GitHub Copilot app 이슈 보기](../../_images/app-new-session-from-issue.png) -4. 다음 프롬프트를 사용하여 이슈에 문서화된 요구 사항에 맞게 지침 파일을 업데이트하도록 Copilot에 요청합니다. +4. 다음 프롬프트를 사용합니다. 편집 전에 새 세션 브랜치를 업데이트하면 앱의 로컬 체크아웃이 오래되었더라도 최근 병합된 `main`에서 실제로 시작할 수 있습니다. - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + 편집하기 전에 이 체크아웃과 브랜치를 식별하고 미커밋 변경이 없는 새 워크트리인지 확인한 다음 origin을 가져오고 이 세션 브랜치를 origin/main으로 fast-forward해 주십시오. HEAD가 origin/main과 일치하며 병합된 별점 PR을 포함하는지 확인해 주십시오. 미커밋 변경이나 분기가 있거나 해당 병합이 누락되었으면 중단해 주십시오. 재설정하거나 작업을 버리거나 다른 브랜치를 만들지 마십시오. + + "Update our repository coding standards" 이슈와 기존 리포지토리 지침을 읽어 주십시오. 범위를 좁힌 문서화 규칙을 추가해 주십시오. 작동 방식보다 의도를 설명하고, db/와 src/lib/에서 내보내는 함수를 TSDoc/JSDoc으로 문서화하여 목적, 매개 변수, 반환값, 존재하는 경우 주입 가능한 db 인수를 다뤄 주십시오. 재사용 가능한 Astro 구성 요소의 Props 계약을 문서화하고 관련 코드 변경 시 주석도 최신 상태로 유지하도록 해 주십시오. + + 중복이나 모순 없이 각 규칙을 적절한 기존 지침 파일에 배치하고 README에서 업데이트된 표준을 링크하거나 요약해 주십시오. 기존 서식과 린트 지침을 보존해 주십시오. 일률적인 파일 헤더를 요구하거나 서식 도구를 이전하거나 애플리케이션 전체의 문서를 다시 작성하거나 필터링을 구현하지 마십시오. 지침 diff를 보여 준 다음 검토를 위해 중단해 주십시오. 스킬이나 에이전트를 만들거나 커밋, 푸시, PR 생성을 하지 마십시오. + ``` Copilot이 업데이트를 적용합니다. ## 변경 내용 검토 -Copilot이 적용한 업데이트를 읽고, 업데이트된 지침을 바탕으로 앞으로 생성할 코드의 예제도 요청합니다. +업데이트된 지침을 읽고 실제 파일에서 효과를 시연합니다. 코드 조각을 제안하는 것만으로는 리포지토리 지침이 코드 변경에 영향을 미쳤음을 보여 줄 수 없습니다. 1. 오른쪽 위의 **Changes**를 선택하여 코드 변경 내용을 엽니다. ![Changes 탭을 화살표로 가리키는 GitHub Copilot app 세션 패널 탭](../../_images/app-select-changes.png) -2. 업데이트된 지침 파일을 검토합니다. 코드에 문서와 주석을 추가하는 지침이 있는지 확인합니다. +2. 업데이트된 지침 파일과 README 참조를 검토합니다. 일률적인 파일 헤더 요구 사항을 만들지 않고 이슈의 주석 철학, 내보내는 함수 문서화, 구성 요소 계약에 규칙이 맞는지 확인합니다. > [!NOTE] > AI는 결정론적이 아니라 확률적으로 작동하므로 정확한 텍스트는 달라질 수 있습니다. -3. 다음 프롬프트를 사용하여 앞으로 생성할 코드의 예제를 만들도록 Copilot에 요청합니다. +3. 지침을 검토한 후 동일한 세션에서 범위를 제한한 시연을 요청합니다. + + ```plaintext + db/ 또는 src/lib/에서 내보내는 작은 기존 TypeScript 도우미 하나나 재사용 가능한 Astro 구성 요소 하나에서 업데이트된 문서화 규칙을 시연해 주십시오. 리포지토리를 살펴보고 적절한 기존 파일을 선택해 주십시오. publishers 도우미가 있다고 가정하지 마십시오. 동작을 보존하는 작은 가독성 개선을 적용하고 관련 함수 문서화 또는 Props 계약 지침을 적용해 주십시오. 코드를 다시 설명하기만 하는 주석을 추가하지 말고 명확하지 않은 의도를 설명해 주십시오. - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + 변경 범위를 해당 시연과 직접 관련된 테스트로 제한해 주십시오. 필터링을 구현하거나 새 기능을 만들지 마십시오. 관련된 기존 npm 검사를 실행하고, 변경 내용과 지침이 코드에 미친 영향을 보고한 다음 검토를 위해 중단해 주십시오. 설치 전에 질문해 주십시오. 커밋, 푸시, PR 생성은 하지 마십시오. + ``` -4. Copilot이 제안한 코드를 검토합니다. 업데이트된 지침에서 요구한 대로 TSDoc doc comments와 파일 헤더 주석이 포함되어 있는지 확인합니다. +4. 채팅 응답뿐 아니라 실제 파일 diff를 검토합니다. 문서가 실제 동작을 설명하는지, 가독성 변경이 동작을 보존하는지 확인합니다. 관련 테스트, 린트, 타입 검사 결과를 검토하고 실패를 해결한 후 계속합니다. 이제 프로젝트의 지침 파일을 업데이트하고 그 영향을 확인했습니다. @@ -124,17 +132,23 @@ Copilot이 적용한 업데이트를 읽고, 업데이트된 지침을 바탕으 지침 파일은 리포지토리 자산이므로 팀의 다른 구성원과 공유됩니다. 다른 자산과 마찬가지로 작업 내용이 포함된 PR을 만듭니다. -1. 오른쪽 위에서 **Create PR**을 선택합니다. +먼저 검토한 지침과 시연을 함께 승인합니다. + +```plaintext +관련 테스트를 포함하여 코딩 표준 지침, README 참조, 범위를 제한한 코드 시연의 전체 diff를 검토해 주십시오. 검증 결과를 요약하고 검토한 변경을 이 세션 브랜치에 커밋해 주십시오. 브랜치를 푸시하고 리포지토리의 PR 템플릿을 사용하며 코딩 표준 이슈를 연결하여 main을 대상으로 끌어오기 요청 하나를 만들어 주십시오. 이슈의 모든 수락 기준을 충족하지 않았다면 부분 기여로 설명하고, 미완료 작업에는 이슈를 닫는 키워드를 사용하지 마십시오. 병합하지 마십시오. +``` + +1. 세션의 PR 링크를 엽니다. 앱에 **Create PR** 확인이 표시되면 중복 PR을 만들지 않고 이를 선택합니다. 2. 메시지가 표시되면 **Sign in with your browser**를 선택하고 안내에 따라 인증합니다. 3. Copilot이 PR을 만들기 시작합니다. -PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워크플로를 모니터링합니다. 잠시 후 오른쪽 위의 버튼이 **Ready to merge**로 바뀝니다. 이는 PR을 병합할 준비가 되었다는 표시입니다. +**My work**에서 지침과 코드 변경을 모두 포함한 전체 PR diff를 살펴봅니다. 학습용 리포지토리의 CI 결과와 필수 검토를 확인합니다. 실패를 해결한 후 **Ready to merge**를 선택합니다. CI는 시연이나 직접 검토를 대체하지 않습니다. 4. **Ready to merge**를 선택합니다. 5. 새 대화 상자에서 **Merge pull request**를 선택하여 끌어오기 요청을 병합합니다. > [!NOTE] -> 표준을 기본 브랜치에 병합하면 모든 사용자와 새 세션에서 프로젝트의 일부로 사용됩니다. 다음 레슨에서 최신 기본 브랜치로 필터링 세션을 시작하면 에이전트가 이 표준을 자동으로 따릅니다. 요청하지 않아도 생성된 TypeScript에 TSDoc doc comments가 포함되는 것을 통해 지침이 생성 코드에 미치는 작지만 실제적인 영향을 확인할 수 있습니다. +> 필터링을 시작하기 전에 PR 2가 `main`에 병합되었는지 확인합니다. 새 워크트리만으로 최신 코드를 보장할 수는 없습니다. 레슨 4에서 원격 내용을 가져오고 새 세션 브랜치를 `origin/main`으로 fast-forward한 다음 앞선 두 병합이 모두 포함되었는지 확인한 후 계획합니다. ## 요약 및 다음 단계 @@ -142,10 +156,10 @@ PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워 - 리포지토리의 `copilot-instructions.md`와 경로 범위 `*.instructions.md` 파일을 살펴봤습니다. - 백로그의 지침 이슈에서 세션을 시작했습니다. -- 에이전트에게 `.github/copilot-instructions.md`에 문서화 표준을 추가하도록 요청했습니다. -- 변경 내용을 검토하고 끌어오기 요청으로 병합했습니다. +- 에이전트에게 적절한 지침 파일에 범위를 좁힌 문서화 규칙을 추가하고 README에서 참조하도록 요청했습니다. +- 실제 코드 변경에 표준이 미친 영향을 살펴보고 결과를 검증한 다음 둘을 PR 2로 병합했습니다. -다음으로 새 세션에서 필터링 기능을 구축하고 방금 병합한 표준이 자동으로 적용되는지 확인합니다. [레슨 4 - Autopilot으로 기능 구축][next-lesson]을 계속 진행합니다. +다음으로 새 세션에서 필터링 기능을 구축하고 방금 병합한 표준을 따르는지 확인합니다. [레슨 4 - Plan과 Autopilot으로 필터링 구축][next-lesson]을 계속 진행합니다. ## 리소스 @@ -154,6 +168,7 @@ PR이 만들어지면 Copilot은 리포지토리에서 실행해야 하는 워 - [사용자 지정 지침 만들기 모범 사례][instructions-best-practices] - [Awesome Copilot — 지침 파일 및 기타 리소스 모음][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/ko-kr/app/4-build-filtering.md b/docs/ko-kr/app/4-build-filtering.md index 1bf692d4..584d887c 100644 --- a/docs/ko-kr/app/4-build-filtering.md +++ b/docs/ko-kr/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "Lesson 4 - Autopilot으로 기능 구축" -description: "GitHub Copilot app의 Plan 및 Autopilot 모드로 정적 클라이언트 쪽 필터링 기능을 구축하고, 문서화 표준이 적용되는지 확인하고, 에이전트 스킬로 검증합니다." +title: "Lesson 4 - Plan과 Autopilot으로 필터링 구축" +description: "이슈를 바탕으로 필터링을 계획하고 Autopilot을 명시적으로 승인한 다음 기존 npm 검사와 수동 브라우저 확인으로 검증하고 체크포인트를 저장합니다." authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -지금까지 프로젝트를 작게 몇 차례 업데이트했습니다. 하지만 더 큰 변경에는 더 탄탄한 프로세스가 필요합니다. GitHub Copilot app은 기존 흐름과 함께 작동하도록 구축되어 올바른 항목을 올바른 방식으로 만들 수 있게 합니다. 이 레슨은 일반적인 개발 프로세스를 따르는 세 레슨 중 첫 번째입니다. 이슈를 사용하여 새 기능을 생성하고 에이전트 스킬로 검증 테스트와 린터를 실행합니다. +별점과 코드 시연이 포함된 문서화 표준을 병합했습니다. 이제 필터링 기능을 구축합니다. 하나의 큰 PR 마일스톤을 시작하는 단계입니다. 레슨 4~8에서 동일한 세션, 워크트리, 브랜치를 유지합니다. 이 레슨에서는 다음 작업을 수행합니다. -- 필터링 이슈에서 새 세션을 시작합니다. -- **Plan** 모드로 기능을 계획한 다음 **Autopilot**으로 구축합니다. -- 생성된 코드가 이전에 병합한 문서화 표준을 따르는지 확인합니다. -- 프로젝트의 `quality-checks` 스킬로 작업을 검증합니다. +- 업데이트된 `main`에서 시작하고 실제 필터링 이슈를 읽습니다. +- **Plan** 모드에서 요구 사항을 확정한 다음 **Autopilot**을 명시적으로 승인합니다. +- 필터링과 테스트를 검토하고 기존 npm 검사 네 가지를 실행합니다. +- 브라우저에서 기능을 수동으로 확인하고 체크포인트를 저장합니다. + +스킬, MCP 검증, QA 프로필, 기능 PR은 이후 모듈에서 다룹니다. 이 구현 단계에서 만들지 않습니다. ## 시나리오 -홈페이지에는 모든 게임이 표시되지만 방문자는 목록을 좁힐 수 없습니다. 필터링 이슈에서는 **category**와 **publisher**로 게임을 필터링할 수 있게 해 달라고 요청합니다. Copilot을 사용하여 이 기능을 구현합니다. +Tailspin Toys의 카탈로그가 커지면서 방문자가 카테고리와 퍼블리셔로 게임을 좁혀 볼 수 있어야 합니다. 백로그 이슈에 기능이 설명되어 있지만 카테고리 조합 방식 같은 세부 사항은 코딩 전에 합의해야 합니다. Plan 모드로 결정을 정리한 다음 Autopilot을 통한 제한된 범위의 구현을 승인합니다. -## 배경 +## 세션 모드 -AI 코딩 에이전트를 개발 흐름에 도입해도 기본 원칙은 달라지지 않습니다. 오히려 더 중요해집니다. 대부분의 개발자는 다음과 비슷한 흐름을 따릅니다. +프롬프트 아래의 모드 선택기는 에이전트의 자율성을 제어합니다. -1. 수행할 작업의 세부 정보가 담긴 이슈를 엽니다. -2. 구축할 항목을 계획합니다. -3. 코드를 구축하고 검토합니다. -4. 테스트를 실행하여 코드를 검증합니다. -5. 새 기능을 수동으로 검증합니다. -6. 끌어오기 요청(PR)을 만듭니다. -7. 코드를 검토하고 지속적 통합 프로세스가 성공하면 코드를 병합합니다. +- **Interactive**는 에이전트가 작업하고 입력을 요청하는 동안 사용자가 계속 참여하도록 합니다. +- **Plan**은 구현 전에 검토할 계획을 준비합니다. +- **Autopilot**은 승인된 범위와 권한 안에서 자율적으로 구현하고 반복합니다. -> [!NOTE] -> 정확한 세부 사항은 팀과 조직에 따라 달라지지만 대부분 위 주제의 변형입니다. +먼저 계획하고 명시적으로 승인한 다음, 재사용 가능한 사용자 지정을 만들기 전에 Interactive로 돌아갑니다. -이 표준 접근 방식을 따르면 AI가 생성한 코드가 요구 사항을 충족하고 사람이 작성한 코드와 동일한 검증 과정을 거치게 할 수 있습니다. +## 업데이트된 main에서 시작 -## 세션 모드 +GitHub에서 PR 1과 PR 2가 병합되었는지 확인합니다. 이전 브랜치에서 계속하지 말고 필터링용 새 워크트리를 만듭니다. -**세션 모드**는 에이전트의 자율성 수준을 제어합니다. 프롬프트 필드 아래의 드롭다운에서 설정하고 언제든지 변경할 수 있습니다. +1. **My work**를 선택하고 **Allow users to filter games by category and publisher**를 제목으로 찾습니다. 이슈를 열고 실제 URL을 복사합니다. 이슈 번호는 리포지토리마다 다릅니다. +2. **New session**을 선택하고 **new working tree**를 선택합니다. 시작 상태를 업데이트할 때는 **Interactive** 모드를 유지합니다. -- **Interactive**: 사용자와 에이전트가 함께 작업합니다. 에이전트는 변경을 제안하고 진행하기 전에 사용자의 입력을 기다립니다. -- **Plan**: 에이전트가 먼저 계획을 만듭니다. 에이전트가 실행하기 전에 계획을 검토하고 승인합니다. -- **Autopilot**: 에이전트가 입력을 기다리지 않고 코드 작성, 테스트 실행, 반복 작업을 완전히 자율적으로 수행합니다. + ![New session 버튼을 화살표로 가리키는 GitHub Copilot app 이슈 보기](../../_images/app-new-session-from-issue.png) -## 필터링 기능 계획 +3. 계획하거나 편집하기 전에 다음 준비 요청을 보냅니다. -잠재적인 문제는 코드를 작성하기 전에 발견하는 것이 가장 좋으며, 사전 계획이 이를 돕습니다. Copilot에 계획을 요청하면 단계와 접근 방식을 문서화합니다. 계획을 검토하고 개선 제안을 한 후 해당 계획을 바탕으로 Copilot이 코드를 생성하게 할 수 있습니다. - -이슈를 열고 새 세션을 시작한 다음 Plan 모드로 전환하여 계획을 만듭니다. + ```plaintext + 아무것도 구현하지 않고 이 새 필터링 세션을 준비해 주십시오. 체크아웃과 브랜치를 식별하고, 워크트리에 미커밋 변경이 없는지 확인하고, origin을 가져온 다음 이 세션 브랜치를 origin/main으로 fast-forward해 주십시오. HEAD가 origin/main과 일치하고 병합된 별점 및 코딩 표준 PR을 포함하는지 확인해 주십시오. -1. 탐색 탭에서 **My work**를 선택합니다. -2. **Allow users to filter games by category and publisher** 이슈를 선택합니다. -3. 오른쪽 위의 **New session**을 선택합니다. + 체크아웃에 미커밋 변경이나 분기가 있거나 두 병합 중 하나라도 누락되었다면 중단하고 설명해 주십시오. 재설정하거나 작업을 버리거나 브랜치를 전환하거나 다른 브랜치를 만들거나 애플리케이션 파일을 편집하지 마십시오. 시작 리비전을 보고해 주십시오. + ``` - ![오른쪽 위의 New session 버튼을 화살표로 가리키는 GitHub Copilot app 이슈 보기](../../_images/app-new-session-from-issue.png) +4. 보고된 시작 상태를 확인합니다. 가져오기만으로는 워크트리를 업데이트할 수 없습니다. 작업 시작 전에 현재 세션 브랜치를 fast-forward하고 `HEAD`가 가져온 `origin/main`과 일치해야 합니다. -4. 모드에 **Plan**이 표시될 때까지 Shift+Tab을 선택합니다. +## 필터링 기능 계획 - ![Plan으로 설정된 모드 선택기를 화살표로 가리키는 GitHub Copilot app 프롬프트 상자](../../_images/app-4-plan-mode.png) +모드 선택기를 **Plan**으로 전환합니다. 아래 이슈 자리 표시자를 복사한 URL로 바꿉니다. -5. 다음 프롬프트를 보냅니다. 이슈에서 세션을 시작했으므로 필터링 이슈는 이미 세션의 컨텍스트에 있습니다. +```plaintext +이 이슈를 바탕으로 필터링 기능을 계획해 주십시오: . 전체 수락 기준과 리포지토리 지침을 읽고 현재 정적 Astro 애플리케이션 및 기존 데이터 접근 도우미와 테스트를 살펴봐 주십시오. 아직 구현하지 마십시오. - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +이슈에서 요구하는 여러 카테고리 선택, 퍼블리셔 필터링, 카테고리와 퍼블리셔의 조합 필터링, 적절한 데이터 접근 도우미, 접근성 있는 컨트롤, 단위 및 엔드투엔드 테스트 커버리지를 다뤄 주십시오. 여러 카테고리를 조합하는 방식, 필터 초기화, 빈 결과 등 지정되지 않은 동작은 임의로 요구 사항을 만들지 말고 질문해 주십시오. 요구 사항과 기존 아키텍처가 정당화하지 않는 한 서버 API를 도입하지 마십시오. -6. 에이전트가 계획을 세우면서 후속 질문을 할 수 있습니다. 기능을 구축할 방식에 따라 답변합니다. +리포지토리 문서화 규칙을 따르고 필요한 단위 및 엔드투엔드 테스트를 추가하거나 업데이트하는 범위가 제한된 구현 및 검증 계획을 제안해 주십시오. package.json에서 명령을 확인한 후 기존 프로젝트 도구로 npm run lint, npm run test:unit, npm run test:e2e, npm run typecheck:all을 실행하도록 계획해 주십시오. QA에서 재사용할 수 있도록 이슈 URL과 제가 승인한 추가 합의 사항을 계획에 기록해 주십시오. -> [!NOTE] -> Copilot은 확률적으로 작동하므로 정확한 후속 질문은 달라질 수 있으며 질문을 하지 않을 수도 있습니다. 이는 정상입니다. +승인 전에 다음 실행 안전장치를 계획에 포함해 주십시오. 테스트할 체크아웃과 서버를 식별하고, 검사 전에 필수 조건을 확인하며, 소프트웨어·의존성·브라우저 설치 전에 질문해 주십시오. 다른 워크트리의 서버를 재사용하지 말고 직접 시작한 서버만 중지하며, 다른 포트 충돌은 관련 없는 프로세스를 중지하지 말고 보고해 주십시오. 누락된 필수 조건과 건너뛴 검사는 통과가 아니라 차단 요인으로 보고해야 합니다. -7. 완료되면 Copilot이 계획 요약을 제공합니다. 계획을 검토합니다. 쿼리 구축, 필터 컨트롤 추가, 테스트를 제안해야 합니다. 원하는 경우 피드백을 제공하여 구체화할 수 있으며 에이전트는 제안을 새 버전에 반영합니다. +계획에 다음 구현 경계를 포함해 주십시오. 제가 Autopilot을 명시적으로 승인한 후, 동일한 워크트리와 브랜치에서 합의한 필터링 기능과 테스트만 구현하고 네 가지 검사를 실행하며, 실패나 차단 요인을 포함한 구현 내용과 모든 검사 결과를 보고한 다음 검토와 수동 브라우저 확인을 위해 중단해 주십시오. 구현 중에는 스킬이나 사용자 지정 에이전트를 만들거나 MCP를 구성하거나 브랜치를 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. 수동 브라우저 확인과 체크포인트 커밋은 나중에 별도 지시에 따라 진행합니다. -## Autopilot으로 구축 +지금은 Plan 모드를 유지하고 제가 검토할 수 있도록 계획을 제시한 뒤 중단해 주십시오. 구현하거나 스킬이나 사용자 지정 에이전트를 만들거나 MCP를 구성하거나 브랜치를 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. +``` -계획을 만들었으므로 Copilot이 구현을 구축하게 합니다. +확인 질문에 답하고 이슈와 비교하여 계획을 검토합니다. UI만 구현하는 계획을 수락하지 말고 데이터 접근 변경, 접근성 있는 컨트롤, 테스트를 확인합니다. 레슨 6과 7에서 사용할 실제 이슈 URL과 승인한 추가 합의 사항을 계획에서 저장합니다. 추가 기준이 필요하지 않았다면 `none`을 사용합니다. -1. **Plan summary** 대화 상자의 옵션 목록에서 **Approve and implement with autopilot**과 가장 가까운 옵션을 선택합니다. +승인하기 전에 계획 자체에 네 가지 검사, 문서화 규칙, 필수 조건 및 서버 안전장치, 동일한 워크트리와 브랜치 유지 요구 사항, 구현과 검증 후 중단 조건이 포함되었는지 확인합니다. 구현 중에는 이후 스킬, 에이전트, MCP 설정, 커밋, 푸시, PR을 금지해야 합니다. 경계가 누락되면 **Plan** 모드에서 수정 계획을 요청하고 수정본을 검토한 후 승인합니다. -Copilot이 구현 작업을 시작합니다. +## Autopilot 명시적 승인 -> [!NOTE] -> Copilot이 필요한 코드를 자동으로 만들기 시작하지 않으면 "Go ahead and start building out the plan!" 같은 프롬프트로 요청할 수 있습니다. -> -> 필요한 업데이트를 만드는 데 몇 분 정도 걸립니다. 에이전트는 파일을 편집하고 만들며, 테스트를 작성하고 실행하고, 반복해서 개선합니다. 지금까지 살펴본 내용을 돌아보거나 잠시 쉬어도 좋습니다. +검토한 계획에 요구 사항과 모든 실행 경계가 포함된 후에만 계획 승인 컨트롤에서 **Approve and implement with autopilot** 또는 사용 중인 버전에 표시되는 동등한 명시적 Autopilot 옵션을 선택합니다. 모드 표시가 **Autopilot**인지 확인합니다. -## 변경 내용 검토 +승인 즉시 실행이 시작될 수 있습니다. 따라서 구현 범위, 안전 규칙, 중단 경계를 모두 승인 전에 검토한 계획에 포함해야 합니다. 실행 시작 후 후속 메시지로 추가하는 방식에 의존하지 않습니다. -AI가 생성한 모든 코드는 병합 전에 검토해야 합니다. 코드를 검토하고 사이트를 실행하여 올바르게 작동하는지 확인합니다. +Autopilot은 코드와 테스트를 작성하고 실패를 반복해서 해결할 수 있지만, 이 권한이 이후 워크숍 모듈까지 완료하라는 허가는 아닙니다. 누락된 필수 조건은 승인을 받아 해결할 차단 요인이지 통과한 검사가 아닙니다. -1. 오른쪽 위의 **Changes**를 선택하여 코드 변경 내용을 엽니다. +## 구현 검토 및 검증 - ![Changes 탭을 화살표로 가리키는 GitHub Copilot app 세션 패널 탭](../../_images/app-select-changes.png) +1. **Changes**를 열고 필터링 구현과 테스트를 살펴봅니다. +2. 여러 카테고리와 퍼블리셔 조합을 포함하여 결과를 이슈 및 승인한 추가 합의 사항과 비교합니다. 새로 만들거나 변경한 도우미가 레슨 3의 문서화 표준을 따르는지 확인합니다. +3. 네 가지 npm 검사 모두의 실제 명령 출력을 확인합니다. quality-checks 스킬을 아직 만들지 않았으므로 지금은 직접 실행합니다. +4. 구현을 수락하기 전에 실패를 해결하고 관련 검사를 다시 실행합니다. Playwright E2E 구성은 빌드하고 미리 보기를 제공하며 로컬 서버를 재사용할 수 있습니다. 테스트한 서버가 이전 레슨이 아니라 이 워크트리의 서버인지 확인합니다. -2. 변경 내용을 검토합니다. 새 TypeScript, Astro, 테스트 파일이 표시되어야 합니다. 새 도우미 함수에 TSDoc doc comments와 파일 헤더 주석이 있는지 확인합니다. 레슨 3에서 병합한 문서화 표준이 요청 없이 자동으로 적용된 것입니다. -3. Copilot app 오른쪽의 검토 패널에서 **Terminal**을 선택합니다. **Terminal** 버튼이 없으면 **+**(**Open in panel** 레이블)를 선택한 다음 **Terminal**을 선택합니다. +## 기능 수동 확인 - ![GitHub Copilot app 검토 패널의 Terminal 버튼](../../_images/app-terminal-screenshot.png) +수동 검토 전에 세션을 **Interactive** 모드로 되돌리고 레슨 5에서도 유지합니다. -4. 터미널 창에 다음 명령을 입력하여 웹앱의 개발 서버를 시작합니다. +1. 이 세션의 검토 패널에서 **Terminal**을 엽니다. 필요하면 **+**를 선택한 다음 **Terminal**을 선택합니다. +2. 터미널이 필터링 워크트리에 있는지 확인하고 실행합니다. ```shell npm run dev ``` -5. 서버가 시작되면 브라우저 창을 엽니다. 잠시만 기다리면 됩니다. -6. [http://localhost:4321](http://localhost:4321)로 이동합니다. -7. 이제 랜딩 페이지에 필터가 표시되어야 합니다. -8. 올바르게 보이지 않는 항목이 있으면 Copilot에 업데이트를 요청할 수 있습니다. -9. 만족하면 터미널 창으로 돌아갑니다. -10. Ctrl+C를 선택하여 개발 서버를 중지합니다. - -## quality-checks 스킬로 작업 검증 +3. 서버가 출력한 URL을 브라우저에서 엽니다. 일반적으로 `http://localhost:4321`입니다. 포트가 사용 중이면 관련 없는 프로세스를 중지하거나 기존 서버에 변경 내용이 있다고 가정하지 말고 소유자를 확인합니다. +4. 승인한 동작에 맞춰 카테고리 선택, 퍼블리셔 선택, 두 조건의 조합을 사용해 봅니다. 키보드 접근성과 합의한 초기화 및 빈 결과 동작도 확인합니다. +5. 실패하면 범위를 좁힌 수정을 요청하고 diff를 검토한 다음 관련 자동 검사와 브라우저 검사를 다시 수행합니다. +6. 터미널로 돌아와 Control+C(Mac) 또는 Ctrl+C(Windows/Linux)를 눌러 직접 시작한 서버를 중지합니다. 다음 모듈의 E2E 실행 전에 중지되었는지 확인합니다. -diff를 눈으로 확인하고 끝낼 수도 있지만 팀에는 정해진 품질 기준과 이를 반복해서 확인하는 방법이 있습니다. +이는 직접 수행한 브라우저 관찰입니다. MCP를 통한 에이전트의 브라우저 관찰은 레슨 6에서 다룹니다. -**에이전트 스킬(Agent skills)**은 테스트 실행, 빌드 생성, 끌어오기 요청 만들기처럼 반복 가능한 작업을 수행하는 방법을 Copilot에 안내합니다. 스킬은 에이전트가 필요할 때 불러올 수 있는 지침, 스크립트, 리소스가 담긴 폴더입니다. [Agent Skills는 공개 표준][agent-skills-repo]이며 다양한 에이전트에서 사용되므로 동일한 스킬을 에이전트 모드의 Copilot Chat, Copilot cloud agent, Copilot CLI, GitHub Copilot app에서 사용할 수 있습니다. +## 체크포인트 저장 -스킬은 프로젝트의 `.github/skills` 폴더 또는 전역 `~/.copilot/skills`에 있습니다. 각 스킬은 YAML frontmatter의 `name`과 `description` 뒤에 Markdown 지침이 이어지는 `SKILL.md` 파일을 포함하는 폴더입니다. +변경 내용과 검증 결과를 검토한 후 로컬 커밋을 승인합니다. -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +현재 diff를 검토하고 필터링 구현과 테스트의 체크포인트 커밋을 만들어 주십시오. 동일한 필터링 브랜치와 워크트리를 유지해 주십시오. 스킬이나 에이전트를 만들거나 MCP를 구성하거나 푸시하거나 끌어오기 요청을 만들지 마십시오. ``` -스킬에는 스크립트, 자산, 참조 자료가 담긴 하위 폴더도 포함할 수 있습니다. 전체 구조는 [에이전트 스킬 사양][agent-skills-spec]에서 확인할 수 있습니다. - -> [!TIP] -> 스킬은 동적으로 불러옵니다. 에이전트는 `description` 필드를 바탕으로 적용할 스킬을 결정하므로, 명확하고 시나리오에 맞는 설명이 있어야 스킬을 제대로 사용할 수 있습니다. - -## quality-checks 스킬 살펴보기 - -스킬의 작동 방식을 살펴봅니다. - -1. 검토 패널이 표시되지 않으면 오른쪽 위의 **Toggle review panel**을 선택하여 엽니다. - - ![Create PR 오른쪽의 Toggle review panel 버튼을 화살표로 가리키는 GitHub Copilot app 위쪽 도구 모음](../../_images/app-2-review-panel.png) - -2. 검토 패널에 새 항목을 추가하려면 **+**를 선택합니다. -3. **File**을 선택합니다. -4. `SKILL.md`를 검색합니다. -5. 파일 목록에서 `SKILL.md .github/skills/quality-checks`를 선택하여 엽니다. -6. `name`과 `description`을 확인합니다. 설명은 커밋, 푸시, 병합 전에 코드 변경을 테스트하거나 린팅하거나 검증할 때 이 스킬을 사용하라고 에이전트에 알려 줍니다. -7. 스킬을 읽습니다. 어떤 스크립트가 어떤 도구 모음(단위 테스트, Playwright 엔드투엔드 테스트, ESLint)을 어떤 순서로 실행하는지, 일반적인 실패를 디버그하는 방법은 무엇인지 확인합니다. 따라서 에이전트가 추측하지 않고 팀의 방식대로 검사를 실행합니다. - -## 검사 실행 - -동일한 필터링 세션에서 에이전트에게 작업을 검증하도록 요청합니다. 스킬 이름을 설명하지 않아도 에이전트가 요청과 일치시킵니다. - -1. Copilot app으로 돌아갑니다. -2. 슬래시 명령 `/quality-checks`를 사용하여 스킬을 직접 호출하고 Enter를 선택합니다. -3. 에이전트는 스킬에 따라 단위 테스트, 린터, 엔드투엔드 테스트를 실행하고 결과를 보고합니다. 실패하는 항목이 있으면 문제를 수정하고 모두 통과할 때까지 검사를 다시 실행하도록 요청합니다. -4. **이 세션을 열어 둡니다.** 다음 레슨에서 Playwright MCP 서버를 추가하고 실제 브라우저에서 필터링 기능이 작동하는지 확인합니다. - ## 요약 및 다음 단계 -실제 기능을 처음부터 끝까지 구축하고 팀의 품질 기준에 맞게 검증했습니다. 구체적으로 다음 작업을 수행했습니다. - -- 최신 프로젝트의 필터링 이슈에서 새 세션을 시작했습니다. -- Plan 모드로 기능을 계획하고 Autopilot으로 구축했습니다. -- 생성된 도우미가 레슨 3에서 병합한 문서화 표준을 따르는지 확인했습니다. -- `quality-checks` 스킬로 작업을 검증했습니다. - -다음으로 Playwright MCP 서버를 연결하고 에이전트에게 실제 브라우저에서 필터링 기능을 살펴보도록 요청합니다. [레슨 5 - Playwright MCP 서버로 테스트][next-lesson]를 계속 진행합니다. +필터링 요구 사항을 합의하고 구현과 테스트를 검토했으며 기능을 수동으로 확인했습니다. 이 체크포인트는 PR 3의 일부이며 별도 PR이 아닙니다. 동일한 세션에서 **Interactive** 모드를 유지하고 [레슨 5 - quality-checks 스킬 만들기 및 사용][next-lesson]을 진행합니다. ## 리소스 - [GitHub Copilot app에서 에이전트 세션 사용][agent-sessions] -- [Agent Skills 정보][about-agent-skills] -- [GitHub Copilot app 사용자 지정][customize-app] - [GitHub Copilot용 클라우드 및 로컬 샌드박스 정보][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification \ No newline at end of file diff --git a/docs/ko-kr/app/5-agent-skills.md b/docs/ko-kr/app/5-agent-skills.md new file mode 100644 index 00000000..2cea5b6c --- /dev/null +++ b/docs/ko-kr/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +title: "레슨 5 - quality-checks 스킬 만들기 및 사용" +description: "재사용 가능한 셸 스크립트 기반 품질 검사를 Copilot에 요청하고, 스킬을 검토한 후 필터링 브랜치에서 실행합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +필터링 기능을 구현하고 기존 npm 명령으로 검사했습니다. 이제 이러한 검사를 재사용 가능한 **에이전트 스킬**로 묶습니다. 레슨 4~8에서 동일한 필터링 세션과 브랜치를 유지합니다. 이 레슨에서는 끌어오기 요청을 만들지 않습니다. + +이 레슨에서는 다음을 수행합니다. + +- 사용자 지정을 만들기 전에 **Interactive** 모드로 돌아옵니다. +- Copilot에 `quality-checks`를 만들고 검토를 위해 중단하도록 요청합니다. +- 함께 제공되는 스크립트로 네 가지 검사를 모두 실행하고, 단일 테스트 파일을 지정하는 인수가 해당 파일만 선택함을 입증합니다. +- 필터링 기능과 함께 스킬의 체크포인트를 저장합니다. + +## 시나리오 + +Tailspin Toys는 필터링이 변경될 때마다 동일한 품질 검사가 필요합니다. 팀은 대화마다 명령과 필수 조건을 설명하는 대신 재사용 가능한 스킬을 원합니다. 스킬을 만들고 스크립트를 검토한 후 다른 요청에서도 검사를 올바르게 실행할 수 있는지 확인합니다. + +## 지침, 스크립트, 리소스 + +스킬은 에이전트가 필요할 때 불러오는 재사용 가능한 작업 지침, 실행 가능한 스크립트, 보조 리소스를 묶습니다. 사용자 지정 에이전트는 전문 역할, 지침, 사용 가능한 도구를 정의합니다. 두 방식은 상호 보완적입니다. 사용자 지정 에이전트도 스킬에 포함된 스크립트를 비롯한 스크립트를 실행할 수 있습니다. + +리포지토리 스킬은 `.github/skills//SKILL.md`에 있으며 `name`과 `description` 프런트매터 및 Markdown 지침을 포함합니다. 스크립트와 다른 리소스는 그 옆에 둡니다. 완성된 답을 복사하지 않고 Copilot에 `.github/skills/quality-checks/SKILL.md`와 함께 제공되는 스크립트를 생성하도록 요청합니다. [Agent Skills 명세][skill-spec]에서 형식을 설명합니다. + +Copilot은 발견한 스킬의 설명으로 언제 불러올지 판단합니다. 이미 열린 세션에서 새 스킬을 즉시 발견한다고 가정하지 않습니다. 실행 절에서는 명시적으로 읽는 대체 절차를 제공합니다. 이식 가능한 형식이라고 해서 셸이나 프로젝트 필수 조건이 없어지지는 않습니다. + +## 스킬 만들기 + +프롬프트를 보내기 전에 모드 선택기로 필터링 세션을 **Interactive** 모드로 되돌립니다. 현재 체크아웃과 브랜치를 유지합니다. 이 스킬이 이미 있는 이전 템플릿으로 시작했다면 사용자 지정을 덮어쓰지 말고 검토하여 확장합니다. + +```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의 -- 구분자는 정확히 한 번만 삽입하고, 호출자는 추가 -- 없이 도구의 인수를 직접 전달하도록 해 주십시오. 포트나 프로세스를 관리하지 마십시오. + +SKILL.md에 name과 description 프런트매터, 래퍼 4개를 실행하는 지침, 필수 조건, 문제 해결 방법, 기존 단위 테스트 파일 하나를 사용하는 예시를 포함한 이식 가능한 호출 예시를 작성해 주십시오. 모든 Bash 예시는 bash를 명시적으로 호출해야 하며, PowerShell 실행 정책은 절대 우회하지 마십시오. Playwright 서버 재사용을 설명하고, 실제로 직접 시작한 서버만 중지하며 그렇지 않으면 질문하도록 해 주십시오. + +스킬과 필요한 스크립트만 만들어 주십시오. 검사나 탐색용 실행을 하거나, 무언가를 설치하거나, 애플리케이션 코드를 변경하거나, 커밋하거나, PR을 열지 마십시오. 검토할 수 있도록 중단해 주십시오. +``` + +## 스킬 검토 + +1. **Changes**를 열어 생성된 파일을 검토합니다. 검토 패널에서 **+**, **File**을 선택한 후 `SKILL.md`나 스크립트 파일명을 검색할 수도 있습니다. +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으로 전환하는 방식으로 해결하지 않습니다. + +## 스킬 실행 + +이전 레슨의 개발 서버가 중지되었는지 확인합니다. Playwright는 E2E를 위해 빌드하고 미리 보기를 제공하지만, 로컬 설정은 포트 `4321`의 서버를 재사용할 수 있습니다. 다른 체크아웃의 서버는 이 기능의 유효한 근거가 아닙니다. + +App에 `/quality-checks`가 표시되면 선택하여 발견된 스킬을 명시적으로 호출하고 아래 요청을 포함합니다. 발견되지 않았다면 이 세션에서 동일한 요청을 직접 보냅니다. 이 연습에서는 스킬을 읽는 방법을 대체 절차로 사용할 수 있습니다. + +```plaintext +.github/skills/quality-checks/SKILL.md를 읽고 지침에 따라 이 체크아웃의 필터링 기능을 검증해 주십시오. 먼저 각 래퍼의 코드를 검토하여 npm의 상위 디렉터리 패키지 탐색에 의존하지 않고, 이 체크아웃에서 의도한 package.json을 포함하는 디렉터리를 찾으며, 잘못된 루트에서는 명시적으로 실패하도록 처리하는지 확인해 주십시오. 실패를 재현하기 위해 리포지토리 파일을 이동하거나 이름을 바꾸거나 삭제하거나 수정하지 마십시오. 함께 제공되는 lint, 단위 테스트, 엔드투엔드 테스트, 타입 검사 스크립트를 실제로 실행해 주십시오. 문서화된 단일 단위 테스트 파일 실행 예시도 실행하되, npm의 -- 구분자는 래퍼가 담당하므로 대상 도구의 인수를 직접 전달해 주십시오. 테스트 러너의 결과에서 지정한 파일만 실행되었는지 확인하고, 해당 파일명과 실행된 테스트 파일 수를 보고해 주십시오. 인수를 출력하거나 종료 코드 0을 반환하는 것만으로는 올바른 선택을 증명하지 못합니다. + +실패, 건너뛴 검사, 누락된 필수 조건을 포함하여 각 스크립트 호출과 결과를 보고해 주십시오. 사용할 수 없는 스킬 스크립트를 알리지 않고 직접 npm 명령으로 대체하지 마십시오. 테스트할 체크아웃과 서버를 식별하고 직접 시작한 서버만 중지하며, 설치하거나 다른 프로세스를 중지하기 전에 질문해 주십시오. 애플리케이션 코드나 브랜치를 변경하거나 커밋, 푸시, 끌어오기 요청 생성을 하지 마십시오. +``` + +도구 호출과 출력을 확인합니다. 네 스크립트가 모두 실제로 실행되어야 합니다. 검사 설명이나 건너뛴 검사는 통과가 아닙니다. 단일 파일 예시에서는 요청한 파일명을 러너의 실제 파일별 결과 및 보고한 수와 비교합니다. 해당 파일만 실행되어야 합니다. 다른 파일도 실행되었다면 인수 출력이나 종료 코드 0만으로는 충분하지 않습니다. 실패는 유용한 근거입니다. 스킬을 수정하거나 승인받아 설정 차단 요인을 해결한 다음 영향을 받는 검사를 다시 실행합니다. 관련 없는 프로세스를 중지하거나 포트 충돌을 강제로 없애지 않습니다. + +## 체크포인트 저장 + +스킬과 결과를 검토한 후 로컬 체크포인트를 승인합니다. + +```plaintext +현재 diff를 검토하고 quality-checks 스킬 파일만 포함한 체크포인트 커밋을 만들어 주십시오. 기존 필터링 브랜치를 유지해 주십시오. 푸시하거나 끌어오기 요청을 만들지 마십시오. +``` + +## 요약 및 다음 단계 + +재사용 가능한 quality-checks 스킬을 만들고 검토했으며 단일 파일 테스트 예제를 포함해 실행했습니다. 스킬 파일은 레슨 8의 기능 PR에 필터링, QA 프로필, 관련 테스트와 함께 포함됩니다. 동일한 세션에서 [레슨 6 - Playwright MCP로 기능 검증][next-lesson]을 계속합니다. + +## 더 많은 스킬 예제 + +이 커뮤니티 예제는 참고 자료이며 추가 작업이 아닙니다. 채택하기 전에 필수 조건과 동작을 검토합니다. + +- [기여 워크플로: `make-repo-contribution`][contribution-example]. +- [요구 사항 문서: `prd`][prd-example]. +- [다이어그램과 함께 제공되는 내보내기 스크립트: `drawio`][drawio-example]. +- [브라우저 테스트: `webapp-testing`][browser-example]. + +업스트림 기여 예제의 이름은 `make-repo-contribution`이며, 이전 Tailspin 템플릿은 `make-contribution`이라는 다른 이름을 사용했습니다. 이 워크숍은 두 기여 스킬 중 어느 것에도 의존하지 않습니다. + +[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/app/5-mcp-playwright.md b/docs/ko-kr/app/5-mcp-playwright.md deleted file mode 100644 index 40a21566..00000000 --- a/docs/ko-kr/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Lesson 5 - Playwright MCP 서버로 테스트" -description: "GitHub Copilot app에 Playwright MCP 서버를 추가하고 에이전트에게 실제 브라우저에서 필터링 기능을 수동으로 테스트하도록 요청합니다." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -이전 레슨에서는 프로젝트의 자동화된 테스트 도구 모음으로 필터링 기능을 만들고 검증했습니다. 테스트는 코드 검증을 자동화하지만 에이전트가 동작을 직접 확인하게 하는 것도 강력합니다. 에이전트는 자신이 만드는 실제 UI에서 발견한 문제에 대응할 수 있습니다. MCP가 AI 에이전트에 외부 기능을 제공하는 방식을 살펴보고, Copilot이 구축 중인 사이트와 직접 상호 작용할 수 있도록 Playwright MCP 서버를 추가합니다. - -이 레슨에서는 다음 작업을 수행합니다. - -- Model Context Protocol (MCP)의 개념과 GitHub Copilot app에서 사용하는 방식을 이해합니다. -- 앱 설정에서 Playwright MCP 서버를 추가합니다. -- 에이전트에게 브라우저를 조작하여 필터링 기능을 살펴보도록 요청합니다. - -## 시나리오 - -단위 테스트와 엔드투엔드 테스트도 중요하지만 UI 업데이트를 검증하려면 실제로 UI와 상호 작용해야 합니다. Copilot이 사용자처럼 작업 중인 웹사이트를 사용하도록 하여 변경 작업을 더 자동화하고, 업데이트가 예상대로 작동한다는 확신을 높이려고 합니다. - -## Model Context Protocol (MCP)이란? - -[Model Context Protocol (MCP)][mcp-blog-post]은 AI 에이전트가 외부 도구 및 서비스와 통신하는 방법을 제공합니다. MCP를 사용하면 AI 에이전트가 외부 도구 및 서비스와 실시간으로 통신할 수 있습니다. 따라서 리소스를 사용하여 최신 정보에 접근하고 도구를 사용하여 사용자를 대신해 작업을 수행할 수 있습니다. - -이러한 도구와 리소스에는 AI 에이전트와 외부 도구 및 서비스를 연결하는 MCP 서버를 통해 접근합니다. MCP 서버는 AI 에이전트와 외부 도구(예: 기존 API 또는 NPM 패키지 같은 로컬 도구) 간의 통신을 관리합니다. 각 MCP 서버는 AI 에이전트가 접근할 수 있는 서로 다른 도구 및 리소스 집합을 나타냅니다. - -널리 사용되는 기존 MCP 서버의 예는 다음과 같습니다. - -- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): GitHub 리포지토리 관리를 위한 API 집합에 접근할 수 있게 합니다. AI 에이전트가 새 리포지토리 만들기, 기존 리포지토리 업데이트, 이슈 및 끌어오기 요청 관리 같은 작업을 수행할 수 있습니다. -- [**Playwright MCP Server**][playwright-mcp-server]: Playwright를 사용하는 브라우저 자동화 기능을 제공합니다. AI 에이전트가 웹페이지 이동, 양식 작성, 버튼 선택 같은 작업을 수행할 수 있습니다. - -다양한 도구와 리소스에 접근할 수 있는 다른 MCP 서버도 많습니다. GitHub는 MCP 서버를 쉽게 찾고 생태계에 기여할 수 있도록 [MCP registry](https://github.com/mcp)를 호스팅합니다. - -> [!CAUTION] -> MCP 서버를 프로젝트의 다른 종속성과 동일하게 취급합니다. MCP 서버를 사용하기 전에 소스 코드를 주의 깊게 검토하고, 게시자를 확인하고, 보안 영향을 고려합니다. 신뢰하는 MCP 서버만 사용하고 중요한 리소스나 작업에 대한 접근 권한을 부여할 때 주의합니다. - -## Playwright MCP 서버 추가 - -앱 설정에서 MCP 서버를 추가하고 관리합니다. 앱에는 인기 서버 카탈로그가 포함되어 있으므로 몇 번의 선택만으로 [Playwright MCP 서버][playwright-mcp-server]를 추가할 수 있습니다. - -1. Ctrl+,를 선택하여 Copilot app 설정 페이지를 엽니다. -2. **MCP servers**를 선택합니다. -3. 검색 대화 상자에 `Playwright`를 입력합니다. -4. **Popular MCP servers** 목록에서 **Playwright**를 선택합니다. -5. **Add server**를 선택하여 사용 가능한 MCP 서버 목록에 추가합니다. -6. Esc를 선택하여 설정 대화 상자를 닫습니다. - -이제 Playwright MCP 서버를 추가했습니다. - -## Copilot에 Playwright로 기능 탐색 요청 - -Copilot에 Playwright MCP 서버를 사용하여 기능을 수동으로 테스트하도록 요청합니다. - -1. 다음 프롬프트를 사용하여 새 기능을 검증하도록 Copilot에 요청합니다. - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -Copilot은 Playwright MCP 서버를 통해 브라우저를 시작하고 각 단계를 수행한 다음 발견한 내용을 보고합니다. 작업을 수행하기 위해 시스템에서 브라우저가 실제로 열리는 것을 볼 수 있습니다. - -2. 이슈의 승인 조건과 비교하여 요약을 읽습니다. 올바르지 않은 부분이 있으면 후속 질문을 하거나 끌어오기 요청을 열기 전에 코드를 수정하도록 요청합니다. -3. 다음 레슨에서 이 세션을 마무리하므로 세션을 열어 둡니다. - -이제 Copilot은 사용자처럼 기능을 살펴보며 브라우저에서도 기능을 검증했습니다. - -## 요약 및 다음 단계 - -GitHub Copilot app에서 Playwright MCP 서버를 사용하여 실제 브라우저로 기능을 살펴봤습니다. 요약하면 다음 작업을 수행했습니다. - -- Model Context Protocol (MCP)의 개념과 앱에서 MCP 도구를 제공하는 방식을 배웠습니다. -- 앱 설정에서 Playwright MCP 서버를 추가했습니다. -- 에이전트에게 브라우저를 조작하여 필터링 기능을 살펴보도록 요청했습니다. - -기능을 구축하고 검증하고 작동하는 모습까지 확인했습니다. 이제 **Agent Merge**를 사용하여 끌어오기 요청을 열고 병합하도록 합니다. [레슨 6 - Agent Merge로 병합][next-lesson]을 계속 진행합니다. - -## 리소스 - -- [MCP란 무엇이며 왜 모두가 이야기할까요?][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [GitHub Copilot app에서 MCP 서버 구성][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/6-agent-merge.md b/docs/ko-kr/app/6-agent-merge.md deleted file mode 100644 index f29b33ed..00000000 --- a/docs/ko-kr/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Lesson 6 - Agent Merge로 병합" -description: "필터링 끌어오기 요청을 열고 My work에서 검토한 다음, Agent Merge가 차단 요소를 수정하고 병합하도록 하여 병합 자동화의 최상위 단계를 경험합니다." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -필터링 기능을 구축하고 검증하고 브라우저에서 작동하는 모습까지 확인했습니다. 마지막 단계는 병합입니다. 이 실습 과정에서 이미 두 번 병합했으며, 두 번 모두 끌어오기 요청을 열고 github.com에서 직접 병합했습니다. 이번에는 앱 안에서 끌어오기 요청의 전체 수명 주기를 관리하는 **Agent Merge**를 사용하여 앱이 번거로운 작업을 처리하게 합니다. - -이 레슨에서는 다음 작업을 수행합니다. - -- Agent Merge의 개념과 병합 수명 주기를 자동화하는 방식을 알아봅니다. -- 필터링 세션에서 Agent Merge를 활성화합니다. -- Agent Merge가 끌어오기 요청을 만들고 CI를 실행한 다음 모든 검사가 통과하면 병합하는 과정을 확인합니다. - -## 시나리오 - -지난 몇 개 모듈에서 코드 생성부터 Copilot이 UI를 직접 검증하도록 하는 것까지 다양한 자동화 수준을 살펴봤습니다. Tailspin Toys는 개발 속도를 더욱 높이기 위해 검토와 검증을 마친 끌어오기 요청을 자동으로 병합할 방법이 있는지 알아보려고 합니다. - -## Agent Merge 소개 - -**Agent Merge**는 Copilot app을 통해 끌어오기 요청을 병합하는 마지막 단계를 자동화합니다. 활성화하면 앱의 세션이 끌어오기 요청을 읽고, 실패한 CI 검사 수정, 검토 의견 대응, 필요할 때 리베이스 수행 등 병합을 차단하는 문제를 해결한 다음 GitHub에서 허용하는 즉시 병합합니다. 백그라운드에서 실행되고 앱을 다시 시작해도 계속 작동하며 끌어오기 요청이 병합되면 자동으로 꺼집니다. - -지금까지는 github.com에서 직접 **Merge pull request**를 선택했습니다. Agent Merge는 해당 책임을 에이전트로 옮기므로, 에이전트가 PR 완료 과정을 관리하는 동안 다음 작업으로 넘어갈 수 있습니다. 작업을 검토하고 승인하는 책임은 여전히 사용자에게 있으며, 에이전트는 기계적인 마무리 작업만 처리합니다. - -## Agent Merge로 PR 관리 - -코드를 직접 검토하고 테스트를 실행했으며 Copilot이 UI를 검증하도록 했습니다. 이제 새 코드를 코드베이스에 병합합니다. Agent Merge가 지속적 통합(CI)과 병합 과정을 관리하게 합니다. - -1. 이전 모듈에서 필터링 기능을 추가하며 열어 둔 세션으로 돌아갑니다. -2. 오른쪽 위에서 **Create PR** 옆의 드롭다운을 선택합니다. -3. **Agent merge**를 선택하여 Agent Merge를 활성화합니다. - - ![Agent merge 옵션을 화살표로 가리키는 펼쳐진 GitHub Copilot app Create PR 드롭다운](../../_images/app-enable-agent-merge.png) - -4. 이제 버튼 텍스트가 **Agent merge**로 바뀝니다. -5. **Agent merge** 버튼을 선택하여 Agent Merge 프로세스를 시작합니다. - -Copilot app이 PR을 만들고 관리하는 프로세스를 시작합니다. 먼저 프로젝트를 탐색하여 PR을 만드는 최적의 방법을 결정한 다음 새 PR을 만듭니다. - -잠시 후 Copilot이 다시 작업을 시작하여 PR 조건, 즉 리포지토리의 모든 테스트를 실행하는 CI 프로세스를 확인합니다. 다른 팀 구성원이 남긴 검토, 실행해야 하는 검사(CI 프로세스), PR의 병합 가능 여부를 보고합니다. - -6. **Agent merge** 옆의 드롭다운을 선택한 다음 **Merge pull request**를 선택하여 Agent Merge가 끌어오기 요청을 병합하도록 허용합니다. - - ![에이전트에 허용된 작업인 Address reviews, Fix CI failures, Resolve conflicts와 화살표로 강조된 Merge pull request를 보여 주는 Agent merge 드롭다운](../../_images/app-agent-merge-merge.png) - -7. 모든 CI 프로세스가 통과하면, 즉 테스트가 성공하면 Copilot이 끌어오기 요청을 병합합니다. - -## 요약 및 다음 단계 - -코드 생성, 코드 테스트와 검증, 끌어오기 요청 프로세스를 포함한 개발 프로세스의 여러 부분을 자동화했습니다. 다음 작업을 수행했습니다. - -- Agent Merge의 개념과 병합 수명 주기를 자동화하는 방식을 배웠습니다. -- 필터링 세션에서 Agent Merge를 활성화했습니다. -- Agent Merge가 끌어오기 요청을 만들고 CI를 실행한 다음 모든 검사가 통과했을 때 병합하는 과정을 확인했습니다. - -다음으로 에이전트와 함께 작업을 계획하고 시각화하는 더 풍부한 방법인 **캔버스**를 살펴봅니다. [레슨 7 - 캔버스로 계획 수립][next-lesson]을 계속 진행합니다. - -## 리소스 - -- [GitHub Copilot app으로 이슈 및 끌어오기 요청 관리][managing-issues-prs] -- [GitHub Copilot app 정보][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/6-mcp-playwright.md b/docs/ko-kr/app/6-mcp-playwright.md new file mode 100644 index 00000000..214b810b --- /dev/null +++ b/docs/ko-kr/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "Lesson 6 - Playwright MCP로 기능 검증" +description: "Customize에서 Playwright MCP를 구성하고 기존 기능 워크트리의 필터링을 브라우저에서 관찰합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +이전 레슨에서는 프로젝트의 검사를 quality-checks 스킬로 묶어 실행했습니다. 이제 에이전트가 필터링 UI를 직접 관찰하도록 브라우저 접근 권한을 제공합니다. 동일한 필터링 세션, 워크트리, 브랜치를 유지합니다. 이 레슨은 브라우저 검증 근거를 추가하는 단계이며 다른 기능, 전체 테스트 스위트 실행, PR을 추가하지 않습니다. + +이 레슨에서는 다음 작업을 수행합니다. + +- Model Context Protocol (MCP)의 개념과 GitHub Copilot app에서 사용하는 방식을 이해합니다. +- **Customize**에서 Playwright MCP 서버를 추가합니다. +- 에이전트에게 브라우저를 조작하여 필터링 기능을 살펴보도록 요청합니다. + +## 시나리오 + +단위 테스트와 엔드투엔드 테스트도 중요하지만 UI 업데이트를 검증하려면 실제로 UI와 상호 작용해야 합니다. Copilot이 사용자처럼 작업 중인 웹사이트를 사용하도록 하여 변경 작업을 더 자동화하고, 업데이트가 예상대로 작동한다는 확신을 높이려고 합니다. + +## Model Context Protocol (MCP)이란? + +[Model Context Protocol (MCP)][mcp-blog-post]은 AI 에이전트가 외부 도구 및 서비스와 통신하는 방법을 제공합니다. MCP를 사용하면 AI 에이전트가 외부 도구 및 서비스와 실시간으로 통신할 수 있습니다. 따라서 리소스를 사용하여 최신 정보에 접근하고 도구를 사용하여 사용자를 대신해 작업을 수행할 수 있습니다. + +이러한 도구와 리소스에는 AI 에이전트와 외부 도구 및 서비스를 연결하는 MCP 서버를 통해 접근합니다. MCP 서버는 AI 에이전트와 외부 도구(예: 기존 API 또는 NPM 패키지 같은 로컬 도구) 간의 통신을 관리합니다. 각 MCP 서버는 AI 에이전트가 접근할 수 있는 서로 다른 도구 및 리소스 집합을 나타냅니다. + +널리 사용되는 기존 MCP 서버의 예는 다음과 같습니다. + +- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): GitHub 리포지토리 관리를 위한 API 집합에 접근할 수 있게 합니다. AI 에이전트가 새 리포지토리 만들기, 기존 리포지토리 업데이트, 이슈 및 끌어오기 요청 관리 같은 작업을 수행할 수 있습니다. +- [**Playwright MCP Server**][playwright-mcp-server]: Playwright를 사용하는 브라우저 자동화 기능을 제공합니다. AI 에이전트가 웹페이지 이동, 양식 작성, 버튼 선택 같은 작업을 수행할 수 있습니다. + +다양한 도구와 리소스에 접근할 수 있는 다른 MCP 서버도 많습니다. GitHub는 MCP 서버를 쉽게 찾고 생태계에 기여할 수 있도록 [MCP registry](https://github.com/mcp)를 호스팅합니다. + +> [!CAUTION] +> MCP 서버를 프로젝트의 다른 종속성과 동일하게 취급합니다. MCP 서버를 사용하기 전에 소스 코드를 주의 깊게 검토하고, 게시자를 확인하고, 보안 영향을 고려합니다. 신뢰하는 MCP 서버만 사용하고 중요한 리소스나 작업에 대한 접근 권한을 부여할 때 주의합니다. + +## Playwright MCP 서버 추가 + +현재 [App 사용자 지정 문서][customize-app]는 MCP 검색 및 관리에 사이드바의 **Customize**를 사용합니다. 리포지토리나 Copilot CLI에 구성한 MCP 서버를 App에서 이미 사용할 수도 있으므로 중복 추가 전에 설치된 서버를 확인합니다. + +1. 사이드바에서 **Customize**를 선택합니다. +2. **MCP**를 선택한 다음 **Installed**에서 기존 Playwright 서버를 확인합니다. +3. 필요하면 사용 가능한 서버에서 **Playwright**를 찾거나 게시자가 문서화한 사용자 지정 서버 추가 절차를 사용합니다. +4. 게시자, 구성, 설치 요청을 검토한 후 승인합니다. 안내에 따라 서버를 추가합니다. 조직 정책이나 누락된 필수 조건으로 설정이 차단될 수 있습니다. +5. **Interactive** 모드를 유지한 채 기존 필터링 세션으로 돌아갑니다. 검증 요청 전에 Playwright MCP 브라우저 도구를 사용할 수 있는지 확인합니다. 설정 문제를 우회하려고 새 기능 워크트리를 만들지 않습니다. + +설정이 실패하면 도구 없이 브라우저를 사용했다는 주장을 수락하지 말고 구성이나 권한 문제를 해결합니다. 브라우저 창의 표시 여부는 서버 구성에 따라 달라집니다. 실제 도구 활동과 관찰 결과가 검증 근거입니다. + +## Copilot에 Playwright로 기능 탐색 요청 + +레슨 4에서 저장한 실제 이슈 URL과 승인한 추가 합의 사항을 사용합니다. 에이전트가 자체 서버를 시작하기 전에 이전 레슨에서 수동으로 시작한 개발 서버를 중지합니다. 에이전트는 테스트할 체크아웃과 서버를 식별해야 합니다. + +1. 다음 프롬프트를 사용하여 새 기능을 검증하도록 Copilot에 요청합니다. + + ```plaintext + 구성된 Playwright MCP 서버를 사용하여 이 이슈를 기준으로 필터링 기능을 관찰해 주십시오: . 계획에서 승인한 추가 합의 사항은 다음과 같습니다: <합의한 추가 사항을 붙여 넣거나 none 작성>. 이 필터링 워크트리와 브랜치를 유지해 주십시오. + + 체크아웃을 식별하고 해당 개발 서버를 시작한 다음 실제 브라우저 도구로 필수 여러 카테고리 선택, 퍼블리셔 필터링, 조합 필터링, 접근성 있는 컨트롤, 합의한 초기화나 빈 결과 동작을 확인해 주십시오. 실패하거나 차단된 검사를 포함하여 기준에 따른 관찰 결과를 보고해 주십시오. 관찰하지 않은 동작을 확인했다고 주장하지 마십시오. + + 이 단계는 브라우저 관찰이며 전체 자동 테스트를 다시 실행하는 단계가 아닙니다. 애플리케이션 코드, 테스트, 스킬, 에이전트 프로필을 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. 누락된 MCP 도구나 필수 조건은 차단으로 보고하고 설치 전에 질문해 주십시오. 다른 체크아웃의 서버를 재사용하거나 관련 없는 프로세스를 중지하지 마십시오. 완료하면 직접 시작한 서버만 중지해 주십시오. + ``` + +Playwright MCP 도구 호출, 테스트한 URL, 보고한 브라우저 관찰 결과를 살펴봅니다. 소스 코드나 이전 E2E 결과만으로 작성한 설명은 MCP 사용을 입증하지 못합니다. + +2. 이슈와 승인한 추가 합의 사항을 기준으로 요약을 읽습니다. 결함이 있으면 범위를 좁힌 수정을 별도로 승인하고 변경된 diff를 검토한 다음 관련 자동 검사와 브라우저 관찰을 반복합니다. 수정 전 근거는 수정된 리비전을 입증하지 못합니다. +3. 에이전트가 직접 시작한 서버를 중지했는지 확인합니다. 레슨 7에서 QA 프로필을 만들기 전까지 이 필터링 세션을 열어 두고 **Interactive** 모드를 유지합니다. + +이 단계는 직접 관찰을 확보하며 자동 테스트 커버리지를 대체하지 않습니다. 실패하거나 차단된 관찰 결과를 QA에서 확인할 수 있도록 남겨 둡니다. + +## 요약 및 다음 단계 + +GitHub Copilot app에서 Playwright MCP 서버를 사용하여 실제 브라우저로 기능을 살펴봤습니다. 요약하면 다음 작업을 수행했습니다. + +- Model Context Protocol (MCP)의 개념과 앱에서 MCP 도구를 제공하는 방식을 배웠습니다. +- **Customize**에서 Playwright MCP 서버를 구성했습니다. +- 에이전트에게 브라우저를 조작하여 필터링 기능을 살펴보도록 요청했습니다. + +다음으로 전문가 프로필을 통해 요구 사항, 브라우저 관찰, 커버리지, 스킬을 결합합니다. 동일한 세션에서 [레슨 7 - QA 에이전트 만들기 및 사용][next-lesson]을 계속 진행합니다. 아직 기능 PR을 만들지 않습니다. + +## 리소스 + +- [MCP란 무엇이며 왜 모두가 이야기할까요?][mcp-blog-post] +- [Microsoft Playwright MCP Server][playwright-mcp-server] +- [GitHub Copilot app에서 MCP 서버 구성][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/7-canvases.md b/docs/ko-kr/app/7-canvases.md deleted file mode 100644 index dca280c8..00000000 --- a/docs/ko-kr/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Lesson 7 - 캔버스로 계획 수립" -description: "GitHub Copilot app에서 공유 에이전트 기반 캔버스를 만들어 에이전트와 함께 작업을 계획하고 추적합니다." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -지금까지 채팅을 통해 에이전트를 지시했습니다. 하지만 많은 작업은 대화가 아니라 보드, 문서, 검사 목록에서 이루어집니다. **캔버스**는 바로 이러한 작업을 위해 앱 안에서 사용자와 에이전트가 함께 사용하는 화면을 제공합니다. 이 레슨에서는 지금까지 처리한 백로그를 계획하고 추적하는 간단한 캔버스를 만듭니다. - -이 레슨에서는 다음 작업을 수행합니다. - -- 캔버스의 개념과 사용 시점을 이해합니다. -- 백로그를 분류하는 공유 Kanban 보드 캔버스를 만듭니다. -- 캔버스를 리포지토리에 저장하고 팀에서 사용할 수 있도록 병합합니다. -- 새 세션에서 캔버스를 열고 캔버스에서 작업을 시작합니다. - -## 시나리오 - -이슈 목록은 아무리 좋은 상황에서도 부담스러울 수 있습니다. Tailspin Toys 개발자는 이슈를 빠르게 분류하고 Copilot app에서 작업을 시작할 수 있는 도구를 찾고 있습니다. - -## 캔버스란? - -[캔버스][canvas-docs]는 계획, 분류 보드, 릴리스 검사 목록, 대시보드, 문서 같은 작업 산출물을 위한 공유 대화형 화면입니다. 채팅은 의도를 설명하고 모호한 부분을 함께 추론하는 데 유용하지만 대부분의 작업은 *화면*에서 이루어집니다. 캔버스를 사용하면 해당 화면에서 에이전트와 직접 협업할 수 있습니다. - -캔버스는 **양방향**입니다. 에이전트가 작업하면서 캔버스를 업데이트할 수 있고 사용자도 동일한 화면을 편집할 수 있습니다. 캔버스를 만들면 에이전트가 프롬프트와 워크플로를 바탕으로 구축하며, 진행하면서 기능을 추가하거나 제거하거나 수정하도록 요청할 수 있습니다. 캔버스를 만들면 앱의 오른쪽 패널에서 열립니다. - -일반적인 예는 다음과 같습니다. - -- 하루를 계획하고 이슈와 끌어오기 요청의 우선순위를 정하는 **Markdown 캔버스** -- 사용자와 에이전트가 카드를 추가하고 열 사이에서 작업을 이동하는 **에이전트 Kanban 보드** -- 리포지토리의 주요 이슈와 반복되는 주제를 요약하는 **이슈 분류 보드** - -## 캔버스를 사용하는 이유 - -작업에 구조화, 반복, 검증이 필요하고 채팅만으로 충분하지 않다면 캔버스를 사용합니다. 캔버스로 다음 작업을 수행할 수 있습니다. - -- 워크플로에 맞는 실제 산출물을 기반으로 에이전트가 작업하게 합니다. -- 공유 화면에서 작업을 직접 안내하거나 수정한 다음 에이전트가 변경 내용에서 계속 작업하게 합니다. -- 채팅 응답만 보는 대신 산출물의 눈에 보이는 변경으로 진행 상황을 확인합니다. - -## 작업 추적 캔버스 만들기 - -별점, 문서화 표준, 필터링 기능을 모두 병합하여 많은 작업을 제공했습니다. 하지만 백로그에는 아직 항목이 남아 있습니다. 작업을 빠르게 분류하는 데 도움이 되는 캔버스를 만듭니다. - -1. GitHub Copilot app으로 돌아가거나 앱을 엽니다. -2. **Home screen**을 선택합니다. -3. 리포지토리로 `tailspin-toys`가 선택되어 있는지 확인합니다. -4. 프롬프트 상자에서 다음 프롬프트를 사용하여 요구 사항을 충족하는 캔버스를 만듭니다. - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -Copilot이 캔버스를 만들기 시작합니다. - -> [!NOTE] -> 이 작업에는 몇 분 정도 걸립니다. 복잡한 작업이므로 첫 번째 버전이 만족스럽지 않을 수 있습니다. 원하는 도구가 완성될 때까지 프롬프트로 계속 개선할 수 있습니다. - -## 캔버스를 저장하고 리포지토리에 병합 - -캔버스는 지침 파일 및 스킬과 마찬가지로 리포지토리의 자산이 될 수 있습니다. Copilot에 캔버스를 리포지토리에 추가하고 병합하도록 요청하여 팀 전체에서 사용하게 합니다. - -1. 같은 세션에서 다음 프롬프트를 사용하여 캔버스를 리포지토리에 저장하도록 Copilot에 요청합니다. - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Copilot이 캔버스 파일을 저장하면 오른쪽 위에서 **Create PR** 옆의 드롭다운을 선택합니다. -3. **Agent merge**를 선택하여 Agent Merge를 활성화합니다. - - ![Agent merge 옵션을 화살표로 가리키는 펼쳐진 GitHub Copilot app Create PR 드롭다운](../../_images/app-enable-agent-merge.png) - -4. 이제 버튼 텍스트가 **Agent merge**로 바뀝니다. -5. **Agent merge** 버튼을 선택하여 Agent Merge 프로세스를 시작합니다. - -Copilot app이 PR을 만들고 관리하는 프로세스를 시작합니다. 먼저 프로젝트를 탐색하여 PR을 만드는 최적의 방법을 결정한 다음 PR을 만듭니다. - -잠시 후 Copilot이 다시 작업을 시작하여 PR 조건, 즉 리포지토리의 모든 테스트를 실행하는 CI 프로세스를 확인합니다. 다른 팀 구성원이 남긴 검토, 실행해야 하는 검사(CI 프로세스), PR의 병합 가능 여부를 보고합니다. - -6. **Agent merge** 옆의 드롭다운을 선택한 다음 **Merge pull request**를 선택하여 Agent Merge가 끌어오기 요청을 병합하도록 허용합니다. - - ![에이전트에 허용된 작업인 Address reviews, Fix CI failures, Resolve conflicts와 화살표로 강조된 Merge pull request를 보여 주는 Agent merge 드롭다운](../../_images/app-agent-merge-merge.png) - -7. 모든 CI 프로세스가 통과할 때까지 기다립니다. 모두 통과하면 Copilot이 끌어오기 요청을 자동으로 병합합니다. - -이제 팀을 위한 새 공유 캔버스를 만들었습니다. - -## 캔버스에서 작업 - -캔버스를 만들었으므로 새 세션을 시작하고 사용해 봅니다. - -1. Copilot app에서 **tailspin-toys** 옆의 **New session**을 선택하여 새 세션을 시작합니다. -2. 다음 프롬프트를 사용하여 분류 캔버스를 열도록 Copilot에 요청합니다. - - ```plaintext - Open the triage issues canvas - ``` - -3. 이제 새 세션에서 만든 캔버스가 열리는 것을 확인합니다. -4. 가장 관심 있는 이슈 중 하나에서 **Add to current context**를 선택합니다. -5. Copilot이 이슈 작업을 시작합니다. - -이제 직접 만든 캔버스를 사용하여 개발 프로세스를 간소화했습니다. - -## 요약 및 다음 단계 - -사용자와 에이전트가 협업하는 공유 화면을 만들었습니다. 다음 작업을 수행했습니다. - -- 캔버스의 개념과 사용 시점을 배웠습니다. -- 에이전트와 공유 Kanban 분류 보드 캔버스를 만들었습니다. -- Agent Merge를 사용하여 캔버스를 리포지토리에 저장하고 병합했습니다. -- 새 세션에서 캔버스를 열고 캔버스를 사용하여 작업을 시작했습니다. - -백로그를 추적하도록 설정했으므로 지금까지 구축한 항목과 다음 단계를 돌아봅니다. [레슨 8 - 검토 및 다음 단계][next-lesson]를 계속 진행합니다. - -## 리소스 - -- [GitHub Copilot app에서 캔버스 확장 사용][canvas-docs] -- [Awesome Copilot의 캔버스][awesome-copilot-canvases] -- [GitHub Copilot app 정보][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/7-qa-agent.md b/docs/ko-kr/app/7-qa-agent.md new file mode 100644 index 00000000..e37c1a3c --- /dev/null +++ b/docs/ko-kr/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +title: "레슨 7 - QA 에이전트 만들기 및 사용" +description: "테스트 커버리지, quality-checks 스킬, 직접 관찰한 브라우저 근거를 통합하는 요구 사항 우선 QA 프로필을 만듭니다." +authors: + - geektrainer +lastUpdated: 2026-09-14 +--- + +이전 레슨에서는 quality-checks 스킬을 만들고 Playwright MCP를 통해 Copilot에 브라우저 도구를 제공했습니다. 이제 **QA 사용자 지정 에이전트**로 이 기능을 통합하여 필터링 기능을 요구 사항과 비교해 검토합니다. + +이 레슨에서는 다음을 수행합니다. + +- 사용자 지정 에이전트가 지침, 스킬, MCP 도구와 함께 작동하는 방식을 이해합니다. +- 재사용 가능한 QA 프로필을 만들고 검토합니다. +- QA 에이전트를 선택하고 필터링 이슈와 비교해 결과를 검토합니다. +- 기능 PR을 위해 프로필과 필요한 테스트를 저장합니다. + +## 시나리오 + +Tailspin Toys는 카테고리 및 퍼블리셔 필터링 출시를 준비하고 있습니다. 자동 검사와 브라우저 탐색에서 유용한 근거를 얻었지만, 테스트 통과만으로 합의한 모든 요구 사항을 다뤘는지는 알 수 없습니다. PR을 열기 전에 팀은 요청한 내용, 구현한 내용, 아직 확인이 필요한 사항을 집중적으로 검토하려고 합니다. + +이슈와 승인한 계획 결정에서 시작하여 커버리지를 확인하고 스킬과 브라우저 도구로 근거를 수집하는 QA 에이전트를 만듭니다. 이 에이전트의 역할은 공백을 찾아 검토 준비 여부를 설명하는 것이며, 자신의 작업을 승인하거나 PR을 병합하는 것이 아닙니다. + +## 사용자 지정 에이전트란? + +사용자 지정 에이전트는 Markdown 프로필로 정의하는 재사용 가능한 전문가 역할입니다. 지침은 Copilot이 작업에 접근하는 방식을 안내하며, 프로필을 선택하면 해당 역할이 대화에 적용됩니다. 이 워크숍에서는 `.github/agents/qa.agent.md`에 역할을 정의하고 App에서 선택합니다. + +지금까지 만든 사용자 지정 요소는 서로 다른 역할을 합니다. 리포지토리 지침은 팀 표준을 설명합니다. quality-checks 스킬은 반복 가능한 검사를 묶습니다. Playwright MCP는 브라우저 도구를 제공합니다. QA 프로필은 이러한 기능을 사용해 요구 사항을 평가하고 결과를 보고하는 방법을 Copilot에 지시합니다. 기존 기능을 대체하거나 별도 에이전트 세션을 요구하지 않습니다. + +## QA 프로필 만들기 + +레슨 6의 필터링 세션을 동일한 워크트리와 브랜치에서 계속합니다. 세션이 **Interactive** 모드이고 quality-checks 스킬이 있으며 Playwright MCP를 사용할 수 있는지 확인합니다. 기능 PR은 레슨 8에서 만듭니다. 이 레슨에서는 프로필을 추가하고 필요한 경우에만 테스트를 추가합니다. + +다음 프롬프트를 일반 Copilot 에이전트에 보냅니다. QA를 선택하기 전에 생성된 파일을 검토합니다. + +```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 생성 또는 병합을 하거나 추가 에이전트나 스킬을 만들지 마십시오. +``` + +## 프로필 검토 + +1. **Changes**를 열고 `.github/agents/qa.agent.md`를 선택합니다. 파일 검토 패널에서도 찾을 수 있습니다. +2. 프런트매터를 읽습니다. `description`은 필수이며 `name: QA`는 선택기에서 프로필을 알아보기 쉽게 합니다. 이 연습에서는 `model`과 `tools`를 지정하지 않아 선택된 모델과 사용 가능한 도구를 사용합니다. 일반 권한은 계속 적용됩니다. +3. 지침을 검토 체크리스트로 읽습니다. 요구 사항에서 시작하고, 스킬과 브라우저 도구를 사용하며, 실제 공백에만 테스트를 추가하고, 실패와 차단된 검사를 구분하는지 확인합니다. +4. 프로필을 선택하기 전에 부족한 부분을 Copilot에 수정하도록 요청합니다. QA를 시작하거나 애플리케이션을 변경하지 않고 정의만 만들었는지 확인합니다. + +> [!NOTE] +> 전문가 프로필은 동작을 안내하지만 올바른 결과를 보장하지 않습니다. 에이전트의 도구 작업, 테스트 변경, 보고서는 여전히 검토해야 합니다. + +## 이슈에 대한 QA 실행 + +실행 프롬프트는 프로필을 읽는 기본 에이전트가 아니라 선택된 **QA** 사용자 지정 에이전트를 위한 것입니다. 동일한 필터링 체크아웃과 브랜치를 유지합니다. + +1. 현재 세션에서 [App 사용자 지정 문서][customize-app]에 따라 프롬프트 상자의 에이전트 선택기를 열거나 `/agent`를 입력합니다. +2. **QA**를 선택하고, 실행 프롬프트를 보내기 전에 App이 **QA**를 활성 에이전트로 명확히 표시하는지 확인합니다. +3. **QA**가 목록에 없거나 활성 상태를 확인할 수 없다면 이 워크트리와 브랜치를 유지한 채 일시 중지하고 진행자에게 질문합니다. 새 기능 세션을 만들거나 근거 없는 다시 불러오기 절차를 만들거나 기본 에이전트에 `qa.agent.md`를 읽으라고 요청하는 방식으로 대체하지 않습니다. + +문서에 설명된 선택기는 세션 중 사용할 수 있지만, 새로 만든 리포지토리 프로필의 발견 여부는 App 버전에 따라 달라질 수 있습니다. 파일을 작성한 사실을 활성화의 증거로 취급하지 않습니다. + +두 플레이스홀더를 실제 필터링 이슈 URL과 레슨 4에서 승인한 추가 합의 사항으로 바꿉니다. 이슈만으로 요구 사항이 충분하다면 `none`을 사용합니다. 이전 에이전트의 기억에 의존하지 않습니다. + +```plaintext +다음 이슈에 맞게 필터링 기능을 검증해 주십시오: . 계획 중 승인한 추가 수락 기준은 다음과 같습니다: <합의한 추가 내용을 붙여 넣거나 없으면 none 입력>. + +Playwright MCP 서버로 동작을 검증하고, 테스트 커버리지를 확인하며, 누락된 커버리지에 대해서만 테스트를 추가하고, quality-checks 스킬을 통해 검증을 실행해 주십시오. 근거, 검사 결과, 차단 요인을 보고해 주십시오. 제 승인 없이 애플리케이션 코드를 변경하지 마십시오. 커밋하거나 끌어오기 요청을 만들지 마십시오. +``` + +## 근거 검토 + +필터링 이슈와 승인한 추가 합의 사항을 함께 보며 보고서를 읽습니다. + +1. 각 기준이 적절한 테스트 및 관찰 가능한 동작과 연결되는지 확인합니다. 예를 들어 카테고리와 퍼블리셔를 결합할 때는 컨트롤의 반응뿐 아니라 반환된 게임에 대한 근거가 필요합니다. +2. 실제 Playwright MCP 도구 작업을 살펴보고 테스트한 서버가 이 체크아웃에 속하는지 확인합니다. 브라우저 검사와 자동 E2E가 오래된 서버나 다른 체크아웃을 재사용해서는 안 됩니다. +3. lint, 단위 테스트, E2E 테스트, 타입 검사 결과를 검토합니다. 네 가지 모두 quality-checks 스킬의 스크립트로 실행해야 합니다. 예정된 명령 요약은 실행이 아닙니다. +4. **Changes**를 열어 추가된 테스트를 살펴보고 보고서의 공백과 비교합니다. + +추가한 테스트를 검토합니다. 검증을 약화하지 않고 실제 공백을 메워야 합니다. 커버리지가 충분하다면 새 테스트가 없는 것이 올바릅니다. 차단이나 실패에 따른 **NO-GO** 판정은 유효한 결과이며, 근거를 생략해도 된다는 허가가 아닙니다. + +QA에서 애플리케이션 결함을 발견하면 범위를 좁힌 수정을 별도로 승인하고, 변경된 리비전에서 영향을 받는 검사와 브라우저 관찰을 다시 실행합니다. 누락된 필수 조건이나 도구에는 명시적인 해결이 필요합니다. 오래된 근거를 변경된 코드의 증거로 취급하지 않습니다. + +## 체크포인트 저장 + +QA의 역할은 검증이므로 커밋을 요청하기 전에 일반 에이전트로 돌아갑니다. + +1. PR 레슨에서 사용할 QA 보고서, 이슈 URL, 승인한 추가 합의 사항, 테스트한 리비전을 보관합니다. +2. 동일한 세션에서 에이전트 선택기로 일반 Copilot 에이전트로 돌아가고 **QA**가 더 이상 선택되어 있지 않은지 확인합니다. +3. 동일한 워크트리와 브랜치를 유지합니다. 일반 에이전트 선택 항목을 찾을 수 없다면 다른 기능 세션을 시작하거나 QA에 커밋을 지시하지 말고 진행자에게 질문합니다. + +프로필, 테스트 변경, 그 결과로 얻은 근거를 검토한 후 해당 QA 컨텍스트와 함께 일반 에이전트에 체크포인트 요청을 보냅니다. + +```plaintext +현재 diff를 검토하고 QA 에이전트 정의와 승인된 테스트 변경의 체크포인트 커밋을 만들어 주십시오. 기존 필터링 브랜치를 유지해 주십시오. 푸시하거나 끌어오기 요청을 만들지 마십시오. +``` + +## 요약 및 다음 단계 + +워크플로에 재사용 가능한 전문가 역할을 추가하고 그 작업을 검토했습니다. 이 레슨에서는 다음을 수행했습니다. + +- 요구 사항에서 시작하는 QA 프로필을 만들고 검토했습니다. +- 프로필을 선택하여 커버리지를 평가하고 스킬과 Playwright MCP로 근거를 수집했습니다. +- 결과를 검토하고 프로필과 필요한 테스트를 필터링 브랜치에 저장했습니다. + +이제 기능 검토에 필요한 구현, 스킬, QA 프로필, 테스트, 검증 보고서를 갖췄습니다. 해결되지 않은 사항은 다음 단계로 넘겨 추적합니다. 실패하거나 차단된 결과는 병합 승인이 아닙니다. [레슨 8 - 기능 PR 생성 및 병합][next-lesson]에서 전체 마일스톤을 검토하고 Agent Merge를 사용합니다. + +## 리소스 + +- [사용자 지정 에이전트 선택을 포함한 GitHub Copilot App 사용자 지정][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/ko-kr/app/8-create-pull-request.md b/docs/ko-kr/app/8-create-pull-request.md new file mode 100644 index 00000000..865b0575 --- /dev/null +++ b/docs/ko-kr/app/8-create-pull-request.md @@ -0,0 +1,90 @@ +--- +title: "Lesson 8 - 기능 PR 만들기 및 병합" +description: "필터링, 스킬, QA 프로필, 테스트를 함께 검토하고 PR 3을 만든 다음 Agent Merge를 명시적으로 승인합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +필터링 구현, quality-checks 스킬, QA 프로필, 관련 테스트를 하나의 브랜치에 체크포인트로 저장했습니다. 함께 검토하고 현재 QA 근거를 사용하여 PR 3을 준비합니다. 별점과 지침 PR은 이미 명시적으로 병합했습니다. 이번에는 별도 기능이나 브랜치가 아니라 PR 워크플로 안에서 **Agent Merge**를 사용합니다. + +이 레슨에서는 다음 작업을 수행합니다. + +- Agent Merge의 개념과 병합 수명 주기를 자동화하는 방식을 알아봅니다. +- 전체 기능 PR과 검증 근거를 살펴봅니다. +- 검토한 후에만 Agent Merge를 승인하고 PR 병합을 확인합니다. + +## 시나리오 + +지난 몇 개 모듈에서 코드 생성부터 Copilot이 UI를 직접 검증하도록 하는 것까지 다양한 자동화 수준을 살펴봤습니다. Tailspin Toys는 개발 속도를 더욱 높이기 위해 검토와 검증을 마친 끌어오기 요청을 자동으로 병합할 방법이 있는지 알아보려고 합니다. + +## Agent Merge 소개 + +**Agent Merge**는 Copilot app을 통해 끌어오기 요청을 병합하는 마지막 단계를 자동화합니다. 활성화하면 앱의 세션이 끌어오기 요청을 읽고, 실패한 CI 검사 수정, 검토 의견 대응, 필요할 때 리베이스 수행 등 병합을 차단하는 문제를 해결한 다음 GitHub에서 허용하는 즉시 병합합니다. 백그라운드에서 실행되고 앱을 다시 시작해도 계속 작동하며 끌어오기 요청이 병합되면 자동으로 꺼집니다. + +지금까지는 직접 **Merge pull request**를 선택했습니다. Agent Merge가 이 책임을 맡을 수 있지만 코드 편집과 병합에는 명시적 승인이 필요합니다. 병합 권한을 부여하기 전에 허용된 작업과 변경 내용을 검토합니다. + +## 전체 마일스톤 검토 + +레슨 4~7의 필터링 세션을 유지합니다. 마지막 체크포인트뿐 아니라 `main`에 대한 전체 브랜치 diff를 확인합니다. 필터링, `.github/skills/quality-checks/SKILL.md`, 함께 제공되는 스크립트, `.github/agents/qa.agent.md`, 관련 테스트가 포함되어야 합니다. + +커밋이나 PR 작업을 요청하기 전에 에이전트 선택기로 **QA**에서 일반 Copilot 에이전트로 돌아가고 **Interactive** 모드를 유지합니다. QA 프로필의 역할은 검증이지 배포가 아닙니다. 선택한 에이전트를 변경해도 필터링 세션, 체크아웃, 브랜치는 변경하지 않습니다. + +이 워크숍은 기능 작업과 재사용 가능한 품질 관리 기반을 의도적으로 하나의 PR에 결합합니다. 실제 팀에서는 나눌 수 있지만, 여기서는 브랜치를 쌓거나 PR을 추가하지 않고 체크포인트 커밋으로 검토 가능한 단계를 보존합니다. + +레슨 7의 QA 보고서를 검토합니다. 제출할 최종 리비전을 대상으로 네 가지 검사와 관련 브라우저 관찰을 모두 완료했을 때만 근거를 재사용합니다. 코드 변경, 충돌 해결, CI 수정으로 테스트 대상이 바뀌면 관련 검사와 브라우저 관찰을 다시 수행하고 근거를 업데이트합니다. 실패하거나 차단된 **NO-GO** 보고서는 병합 승인이 아닙니다. + +diff와 근거가 준비되면 다음을 보냅니다. + +```plaintext +필터링 기능, quality-checks 스킬과 스크립트, QA 에이전트 정의, 관련 테스트를 포함하여 main에 대한 전체 필터링 브랜치 diff를 검토해 주십시오. 이슈 기준, 승인한 추가 합의 사항, 현재 QA 근거를 요약해 주십시오. 최종 리비전에도 적용될 때만 검증을 재사용하고, 오래되거나 누락되거나 실패한 근거가 있으면 진행 전에 보고해 주십시오. + +검토한 변경과 검증이 준비되었다면 남아 있는 승인된 마일스톤 변경을 커밋하고 이 브랜치를 푸시한 다음 리포지토리의 PR 템플릿과 실제 필터링 이슈 URL을 사용하여 main을 대상으로 기능 PR 하나를 만들어 주십시오. 이 브랜치의 체크포인트 기록을 유지해 주십시오. 기여 스킬을 사용하거나 다른 브랜치나 PR을 만들거나 아직 병합하지 마십시오. +``` + +**My work**에서 PR을 열고 **Files changed**, 설명, 검토, 검사 결과를 살펴봅니다. Tailspin Toys 자체 워크플로 파일과 필수 검사를 확인합니다. 모든 로컬 검사나 브라우저 관찰이 CI에서 실행된다고 가정하지 않습니다. 워크숍 게시용 Astro 빌드와 링크 검사기는 다른 리포지토리의 도구이며 이 기능을 검증하지 않습니다. + +## Agent Merge로 PR 관리 + +기존 PR을 검토한 후 동일한 세션에서 Agent Merge를 구성합니다. 두 번째 PR을 만들지 않습니다. + +1. 필터링 세션으로 돌아가 PR 3에 연결되었는지 확인합니다. +2. 오른쪽 위의 PR 작업 드롭다운을 엽니다. PR이 없을 때는 **Create PR** 옆에 있으며 PR이 연결되면 레이블이 바뀔 수 있습니다. +3. **Agent merge**를 선택하여 Agent Merge를 활성화합니다. + +4. **Address reviews**, **Fix CI failures**, **Resolve conflicts**, **Merge pull request**를 포함한 권한을 검토합니다. 지적 사항이나 검증이 해결되지 않았을 때는 병합 권한을 꺼 둡니다. +5. 시작 전에 다음 범위와 승인을 보낸 다음 **Agent merge**를 선택합니다. + + ```plaintext + Agent Merge로 이 기존 필터링 PR을 관리해 주십시오. 검토나 CI 차단 요인은 이 PR의 범위 안에서만 해결해 주십시오. 테스트나 요구 사항을 약화하지 말고 관련 없는 변경이나 설치 전에 질문해 주십시오. 테스트한 리비전이 변경되면 관련 검사와 브라우저 근거를 업데이트해야 합니다. 이전 QA 결과를 변경된 코드의 증거로 취급하지 마십시오. + + 최종 diff와 근거를 검토한 후 제가 Merge pull request를 명시적으로 활성화할 때까지 병합하지 마십시오. 다른 PR을 만들거나 캔버스 작업을 시작하지 마십시오. + ``` + +6. 후속 변경과 업데이트된 결과를 검토합니다. 최종 diff가 승인되고 필수 CI와 검토를 통과하며 QA 근거가 해당 리비전에 적용되면 **Agent merge** 옆의 드롭다운에서 **Merge pull request**를 선택하여 병합을 명시적으로 승인합니다. + + ![에이전트에 허용된 작업인 Address reviews, Fix CI failures, Resolve conflicts와 화살표로 강조된 Merge pull request를 보여 주는 Agent merge 드롭다운](../../_images/app-agent-merge-merge.png) + +7. GitHub에서 PR 3이 단순히 병합 가능하거나 대기 중이 아니라 **Merged**로 표시되는지 확인합니다. Agent Merge는 리포지토리 보호나 권한 부족을 우회하지 않습니다. 계속하기 전에 차단 요인을 해결합니다. + +병합 후에만 캔버스 마일스톤을 시작합니다. 레슨 9는 새 워크트리를 만들고 세션 브랜치를 최신 `origin/main`으로 fast-forward하여 병합된 전체 기능을 포함한 상태에서 캔버스를 시작합니다. + +## 요약 및 다음 단계 + +코드 생성, 코드 테스트와 검증, 끌어오기 요청 프로세스를 포함한 개발 프로세스의 여러 부분을 자동화했습니다. 다음 작업을 수행했습니다. + +- Agent Merge의 개념과 병합 수명 주기를 자동화하는 방식을 배웠습니다. +- 전체 필터링, 스킬, QA 프로필, 테스트 diff를 PR 3으로 검토했습니다. +- 현재 QA 근거를 재사용하고 CI를 확인한 다음 Agent Merge를 명시적으로 승인했습니다. + +다음으로 에이전트와 함께 작업을 계획하고 시각화하는 더 풍부한 방법인 **캔버스**를 살펴봅니다. [레슨 9 - 이슈 분류 캔버스 만들기][next-lesson]를 계속 진행합니다. + +## 리소스 + +- [GitHub Copilot app으로 이슈 및 끌어오기 요청 관리][managing-issues-prs] +- [GitHub Copilot app 정보][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/8-review.md b/docs/ko-kr/app/8-review.md deleted file mode 100644 index 1b23b940..00000000 --- a/docs/ko-kr/app/8-review.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Lesson 8 - 검토 및 다음 단계" -description: "GitHub Copilot app 실습 과정을 되짚어 보고, 반복 작업을 자동화하고, 다음에 살펴볼 내용을 알아봅니다." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -지난 여러 레슨에서 GitHub Copilot app으로 아이디어를 기능으로 만들고 병합하기까지 다음 작업을 수행했습니다. - -- 리포지토리를 연결하고 앱의 워크스페이스와 미리 생성된 백로그를 살펴봤습니다. -- 직접 작업과 이슈에서 세션을 시작하고 Plan 및 Autopilot 모드로 에이전트의 작업 방식을 제어했습니다. -- 사용자 지정 지침과 재사용 가능한 스킬로 에이전트를 안내했습니다. -- Playwright MCP 서버를 사용하여 실제 브라우저에서 작업을 테스트했습니다. -- 공유 캔버스에서 에이전트와 협업했습니다. -- GitHub.com에서 직접 병합하는 단계부터 **Agent Merge**가 끌어오기 요청을 병합하는 단계까지 병합 자동화 수준을 높여 변경 내용을 제공했습니다. - -이제 반복 작업을 자동화하고 모범 사례를 살펴본 다음 앞으로 진행할 방향을 알아봅니다. - -## 반복 작업 자동화 - -앱은 **자동화**를 통해 일정에 따라 또는 요청 시 에이전트를 실행할 수 있습니다. 새 이슈 분류나 최근 활동 요약 같은 일상적인 작업에 유용합니다. 간단하고 비파괴적인 자동화를 하나 만듭니다. - -1. 사이드바에서 **Automations**를 선택한 다음 **New automation**을 선택합니다. -2. `Recap my recent work` 같은 이름을 지정합니다. -3. 트리거를 선택합니다. **Manual**은 요청 시 실행하고, **On a schedule**은 자동으로 실행하며, **When an issue is created**는 새 이슈에 반응합니다. 이 레슨에서는 **Manual**을 선택합니다. -4. 자동화가 내용을 변경할 수 없도록 다음과 같은 읽기 전용 프롬프트를 입력합니다. - - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` - -5. 프로젝트(Tailspin Toys 리포지토리)를 선택하고 자동화를 만듭니다. -6. 요청 시 실행하여 결과를 확인합니다. - -> [!TIP] -> 자동화는 로컬 또는 클라우드에서 실행할 수 있습니다. 일정에 따라 사용자 없이 실행하려면 **Run in the cloud**를 활성화하고 자동화에서 사용할 수 있는 **Tools**를 선택합니다. 출력 결과를 신뢰할 수 있을 때까지 예약 자동화의 범위를 제한하고 비파괴적으로 유지합니다. - -## 모범 사례 - -AI 도구를 사용할 때는 도구를 둘러싼 인프라가 결과의 품질을 좌우합니다. 이 워크숍에서는 지침 파일, 스킬, 사용자 지정 에이전트를 모두 사용했습니다. 이러한 항목에 투자하고 세션 간에 재사용합니다. - -작업에 맞는 **모드와 모델**을 선택합니다. 구축 전에 접근 방식을 검토하려면 **Plan**을 사용하고, 범위가 명확한 변경에서 계속 참여하려면 **Interactive**를 사용하며, 범위가 명확하고 격리된 작업에만 **Autopilot**을 사용합니다. 일상적인 편집에는 빠른 모델을 선택하고 복잡한 작업에는 추론 능력이 더 높은 모델을 선택합니다. - -컨텍스트는 인프라만큼 중요합니다. 만들려는 *항목*, 그 *이유*, 원하는 *방식*을 명확하게 설명하면 출력이 크게 달라집니다. 빠른 채팅은 아이디어를 전체 세션에 적용하기 전에 범위를 정하기에 적합합니다. - -## 더 살펴볼 내용 - -핵심 워크플로를 모두 살펴봤습니다. 다음 기능도 확인해 볼 만합니다. - -- 전체 세션이 필요 없는 빠른 일회성 질문을 위한 **Quick chats** -- 구축 전에 문제를 함께 검토하고 유용한 피드백을 받기 위한 **Rubber duck** -- 반복 가능한 전문 작업을 위해 역할, 도구, 지침을 패키지하는 [**Custom agents**][custom-agents] -- 세션에서 일어난 일을 서술형으로 생성하는 [`/chronicle`][chronicle] -- Ollama, Foundry Local, LM Studio를 통한 로컬 모델을 포함하여 자체 공급자의 모델을 사용하는 [Bring your own key (BYOK)][byok] -- GitHub에서 호스팅하는 격리된 환경에서 세션을 실행하는 [Cloud sandboxes][sandboxes] -- 리포지토리, 세션, 프롬프트에서 바로 앱을 여는 [Deep links][deep-links] - -## 다음 단계 - -어떤 도구든 더 능숙하게 사용하려면 계속 사용해야 합니다. 프로덕션 코드, 취미 프로젝트, 오랫동안 생각만 하고 만들지 못했던 작은 앱에 사용해 봅니다. 배운 내용을 팀과 공유하고 팀의 경험에서도 배웁니다. 언제나 그렇듯 문서를 살펴봅니다. - -GitHub Copilot 생태계를 더 살펴보려면 [VS Code 실습 과정](../../vscode/), [Copilot CLI 실습 과정](../../cli/), [Cloud agent 실습 과정](../../cloud/)을 확인합니다. - -## 리소스 - -- [GitHub Copilot app 정보][about-copilot-app] -- [GitHub Copilot app 시작하기][getting-started] -- [GitHub Copilot app 사용자 지정][customize] -- [자동화 사용][using-automations] -- [캔버스 확장 사용][canvas-docs] -- [클라우드 및 로컬 샌드박스 정보][sandboxes] - -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app -[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started -[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app -[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle -[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models -[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/ko-kr/app/9-canvases.md b/docs/ko-kr/app/9-canvases.md new file mode 100644 index 00000000..87f86946 --- /dev/null +++ b/docs/ko-kr/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "Lesson 9 - 이슈 분류 캔버스 만들기" +description: "리포지토리에 저장하는 이슈 분류 캔버스를 만들고 검토하여 PR 4를 병합한 다음, 다른 기능을 시작하지 않고 다시 열어 이슈 컨텍스트를 추가합니다." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +지금까지 채팅을 통해 에이전트를 지시했습니다. 하지만 많은 작업은 대화가 아니라 보드, 문서, 검사 목록에서 이루어집니다. **캔버스**는 바로 이러한 작업을 위해 앱 안에서 사용자와 에이전트가 함께 사용하는 화면을 제공합니다. 이 레슨에서는 지금까지 처리한 백로그를 계획하고 추적하는 간단한 캔버스를 만듭니다. + +이 레슨에서는 다음 작업을 수행합니다. + +- 캔버스의 개념과 사용 시점을 이해합니다. +- 백로그를 분류하는 공유 Kanban 보드 캔버스를 만듭니다. +- 캔버스를 리포지토리에 저장하고 팀에서 사용할 수 있도록 병합합니다. +- 캔버스를 다시 열고 다른 기능을 구현하지 않은 채 이슈 컨텍스트를 추가합니다. + +## 시나리오 + +이슈 목록을 보면 부담스러울 수 있습니다. Tailspin Toys 개발자는 이슈를 분류하고 세부 정보를 세션 컨텍스트에 추가하는 도구를 원합니다. 컨텍스트 추가는 이슈 구현을 승인하는 것이 아닙니다. 이 실습은 다섯 번째 PR이 아니라 재사용 가능한 보드에서 끝납니다. + +## 캔버스란? + +[캔버스][canvas-docs]는 계획, 분류 보드, 릴리스 검사 목록, 대시보드, 문서 같은 작업 산출물을 위한 공유 대화형 화면입니다. 채팅은 의도를 설명하고 모호한 부분을 함께 추론하는 데 유용하지만 대부분의 작업은 *화면*에서 이루어집니다. 캔버스를 사용하면 해당 화면에서 에이전트와 직접 협업할 수 있습니다. + +캔버스는 **양방향**입니다. 에이전트가 작업하면서 캔버스를 업데이트할 수 있고 사용자도 동일한 화면을 편집할 수 있습니다. 캔버스를 만들면 에이전트가 프롬프트와 워크플로를 바탕으로 구축하며, 진행하면서 기능을 추가하거나 제거하거나 수정하도록 요청할 수 있습니다. 캔버스를 만들면 앱의 오른쪽 패널에서 열립니다. + +일반적인 예는 다음과 같습니다. + +- 하루를 계획하고 이슈와 끌어오기 요청의 우선순위를 정하는 **Markdown 캔버스** +- 사용자와 에이전트가 카드를 추가하고 열 사이에서 작업을 이동하는 **에이전트 Kanban 보드** +- 리포지토리의 주요 이슈와 반복되는 주제를 요약하는 **이슈 분류 보드** + +## 캔버스를 사용하는 이유 + +작업에 구조화, 반복, 검증이 필요하고 채팅만으로 충분하지 않다면 캔버스를 사용합니다. 캔버스로 다음 작업을 수행할 수 있습니다. + +- 워크플로에 맞는 실제 산출물을 기반으로 에이전트가 작업하게 합니다. +- 공유 화면에서 작업을 직접 안내하거나 수정한 다음 에이전트가 변경 내용에서 계속 작업하게 합니다. +- 채팅 응답만 보는 대신 산출물의 눈에 보이는 변경으로 진행 상황을 확인합니다. + +## 작업 추적 캔버스 만들기 + +PR 3이 병합되었는지 확인합니다. 캔버스를 시작하기 전에 별점, 문서화 표준, 필터링 기능, 품질 스킬, QA 프로필이 모두 `main`에 있어야 합니다. 마지막 PR 마일스톤에 새 세션과 하나의 브랜치를 사용합니다. + +1. GitHub Copilot app으로 돌아가거나 앱을 엽니다. +2. **Home screen**을 선택합니다. +3. 리포지토리로 `tailspin-toys`가 선택되어 있는지 확인합니다. +4. **new working tree**와 **Interactive** 모드를 선택합니다. 파일을 만들기 전에 다음 시작 상태 요청을 보냅니다. + + ```plaintext + 아무것도 구현하지 않고 이 새 캔버스 세션을 준비해 주십시오. 미커밋 변경이 없는 새 워크트리인지 확인하고 origin을 가져온 다음 현재 세션 브랜치를 origin/main으로 fast-forward해 주십시오. 체크아웃, 브랜치, 일치하는 HEAD 및 origin/main 리비전을 보고해 주십시오. 필터링 PR이 병합되었고 필터링 기능, quality-checks 스킬, QA 프로필이 있는지 확인해 주십시오. + + 체크아웃에 미커밋 변경이나 분기가 있거나 이전 병합이 누락되었으면 중단해 주십시오. 재설정하거나 작업을 버리거나 브랜치를 전환하거나 다른 브랜치를 만들지 마십시오. 시작 상태를 보고한 후 중단해 주십시오. + ``` + +5. 시작 상태 보고서를 확인한 다음 리포지토리에 저장하는 캔버스를 요청합니다. + + ```plaintext + App이 지원하는 캔버스 확장 워크플로로 이 리포지토리용 기본 Kanban 이슈 분류 캔버스를 만들어 주십시오. 팀에서 재사용할 수 있도록 정의를 .github/extensions/에 저장해 주십시오. 기존 확장을 살펴보고 보존해 주십시오. 제공된 데이터베이스 탐색기를 덮어쓰지 마십시오. + + 현재 열린 이슈를 읽어 주십시오. 가장 주의가 필요할 가능성이 높은 세 이슈를 강조하고 나머지는 아래에 배치해 주십시오. 강조한 각 이슈의 제목, 내용 요약, URL, 우선순위의 근거를 포함해 주십시오. 순위는 이슈를 변경하라는 지시가 아니라 제안으로 취급해 주십시오. + + 모든 카드에 이슈 세부 정보를 이 세션에만 첨부하는 Add to current context 동작을 제공해 주십시오. 구현을 시작하거나 세션이나 브랜치를 만들거나 이슈 상태를 변경하거나 PR을 만들면 안 됩니다. 캔버스의 범위를 제한하고 키보드로 접근할 수 있게 해 주십시오. + + 생성한 파일을 보여 주고 검토할 수 있도록 캔버스를 열어 주십시오. 애플리케이션 코드를 변경하거나 커밋, 푸시, PR 생성을 하지 마십시오. 설치하거나 의존성을 추가하기 전에 질문해 주십시오. + ``` + +Copilot이 캔버스 파일을 만들고 공유 화면을 엽니다. 동작을 신뢰하기 전에 생성된 확장을 검토합니다. 단순한 그림이 아니라 실행 가능한 리포지토리 콘텐츠입니다. + +> [!NOTE] +> 첫 버전에 개선이 필요하면 이슈 분류 범위 안에서 집중된 개선을 요청합니다. 이 실습을 백로그 이슈 구현으로 바꾸지 않습니다. + +## 캔버스 검토 및 사용 + +1. **Changes**를 열고 캔버스 정의가 사용자나 세션 전용이 아니라 리포지토리의 `.github/extensions/` 아래에 저장되었는지 확인합니다. 기존 확장과 애플리케이션 파일이 변경되지 않았는지 확인합니다. +2. 보드를 실제 열린 이슈와 비교하고 순위 설명을 평가합니다. +3. 카드와 컨트롤이 읽기 쉽고 키보드로 사용할 수 있는지 확인합니다. +4. 이슈의 **Add to current context**를 선택하고 세부 정보만 대화에 들어오는지 확인합니다. 구현이나 이슈 상태 변경이 시작되면 안 됩니다. +5. 수정 사항을 검토하고 변경된 파일에 적용되는 기존 검증을 실행하도록 Copilot에 요청합니다. 대화형 화면이 열렸다는 이유로 올바르다고 가정하지 말고 결과와 차단 요인을 기록합니다. + +## 캔버스를 저장하고 리포지토리에 병합 + +캔버스는 이미 리포지토리 자산입니다. 검토한 캔버스 작업만 커밋하고 PR 4로 제출합니다. + +1. 동일한 세션에서 다음을 보냅니다. + + ```plaintext + 리포지토리에 저장한 이슈 분류 캔버스의 diff와 검증 근거를 검토해 주십시오. 승인된 캔버스 파일을 이 세션 브랜치에 커밋하고 푸시한 다음 리포지토리의 PR 템플릿을 사용하여 main을 대상으로 PR 하나를 만들어 주십시오. 캔버스 동작과 이슈 추가가 컨텍스트만 추가함을 어떻게 검증했는지 설명해 주십시오. 아직 병합하거나 백로그 이슈를 구현하지 마십시오. + ``` + +2. **My work**에서 전체 PR diff와 검사를 검토합니다. 캔버스가 포함되어 있고 관련 없는 애플리케이션 작업은 없는지 확인합니다. +3. 동일한 캔버스 세션에서 PR 작업 드롭다운을 열고 **Agent merge**를 선택합니다. 허용된 작업을 검토하고 최종 결과를 승인할 때까지 **Merge pull request**를 꺼 둡니다. +4. Agent Merge를 시작하기 전에 범위를 설정합니다. + + ```plaintext + Agent Merge로 이 기존 캔버스 PR을 관리해 주십시오. 범위 안의 검토 및 CI 차단 요인만 해결하고 관련 없는 변경이나 설치 전에 질문해 주십시오. 캔버스가 변경되면 관련 검증을 반복하고 근거를 업데이트해 주십시오. 검토 후 제가 Merge pull request를 명시적으로 활성화할 때까지 병합하지 마십시오. 백로그 이슈를 구현하거나 다른 PR을 만들지 마십시오. + ``` + +5. **Agent merge**를 선택하고 후속 변경을 검토합니다. 학습용 리포지토리의 실제 CI 검사를 확인하고 실패를 해결합니다. CI는 캔버스를 직접 사용하는 검증을 대체하지 않습니다. + +6. 최종 diff와 현재 근거가 승인되고 필수 검사와 검토를 통과하면 Agent Merge 드롭다운에서 **Merge pull request**를 선택하여 병합을 명시적으로 허용합니다. + + ![에이전트에 허용된 작업인 Address reviews, Fix CI failures, Resolve conflicts와 화살표로 강조된 Merge pull request를 보여 주는 Agent merge 드롭다운](../../_images/app-agent-merge-merge.png) + +7. 계속하기 전에 GitHub에서 PR 4가 **Merged**로 표시되는지 확인합니다. + +이제 팀을 위한 새 공유 캔버스를 만들었습니다. + +## 다른 기능을 시작하지 않고 캔버스 다시 열기 + +PR이 병합된 후 동일한 캔버스 세션에서 리포지토리에 저장한 캔버스를 다시 엽니다. 이는 검토 단계이지 다른 브랜치나 PR 마일스톤이 아닙니다. + +1. 캔버스 세션으로 돌아가 **Interactive** 모드를 유지하고 캔버스 패널이 아직 열려 있으면 닫습니다. +2. 다음을 보냅니다. + + ```plaintext + 이 동일한 세션에서 리포지토리의 이슈 분류 캔버스를 다시 열어 주십시오. 세부 정보를 확인하기 위해서만 이슈를 컨텍스트에 추가하겠습니다. 파일을 편집하거나 이슈를 구현하거나 상태를 변경하거나 다른 세션이나 브랜치를 만들거나 커밋, 푸시, PR 생성을 하지 마십시오. + ``` + +3. 정의를 다시 생성하지 않고 저장된 캔버스가 다시 열리는지 확인합니다. +4. 가장 관심 있는 이슈 중 하나에서 **Add to current context**를 선택합니다. +5. 구현을 시작하지 않고 선택한 이슈의 세부 정보가 컨텍스트에 표시되는지 확인합니다. 여기서 멈춥니다. 워크숍에는 다섯 번이 아니라 네 번의 PR 마일스톤이 있습니다. + +이제 직접 만든 캔버스를 사용하여 개발 프로세스를 간소화했습니다. + +## 요약 및 다음 단계 + +사용자와 에이전트가 협업하는 공유 화면을 만들었습니다. 다음 작업을 수행했습니다. + +- 캔버스의 개념과 사용 시점을 배웠습니다. +- 에이전트와 공유 Kanban 분류 보드 캔버스를 만들었습니다. +- Agent Merge를 사용하여 캔버스를 리포지토리에 저장하고 병합했습니다. +- 병합된 캔버스를 다시 열고 다른 기능을 시작하지 않은 채 이슈 컨텍스트를 추가했습니다. + +백로그를 추적하도록 설정했으므로 지금까지 구축한 항목과 다음 단계를 돌아봅니다. [레슨 10 - 마무리 및 다음 단계][next-lesson]를 계속 진행합니다. + +## 리소스 + +- [GitHub Copilot app에서 캔버스 확장 사용][canvas-docs] +- [Awesome Copilot의 캔버스][awesome-copilot-canvases] +- [GitHub Copilot app 정보][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/ko-kr/app/README.md b/docs/ko-kr/app/README.md index 60cb1e8f..2f28b558 100644 --- a/docs/ko-kr/app/README.md +++ b/docs/ko-kr/app/README.md @@ -3,12 +3,14 @@ slug: ko-kr/app title: "GitHub Copilot app" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [**GitHub Copilot app**](https://docs.github.com/copilot/concepts/agents/github-copilot-app)은 Copilot CLI를 기반으로 구축된 데스크톱 애플리케이션으로, 에이전트 기반 개발을 하나의 집중된 워크스페이스에서 수행할 수 있게 해 줍니다. 병렬 에이전트 세션, 전환 가능한 세션 모드, 공유 캔버스, GitHub 이슈 및 끌어오기 요청 기본 관리 기능을 제공합니다. 여기에는 끌어오기 요청의 리베이스, 검토 피드백, CI 수정, 병합 과정을 관리하는 **Agent Merge**도 포함됩니다. -이 레슨에서는 앱을 설치하고 프로젝트를 설정한 다음, 앱 워크스페이스와 템플릿에서 미리 생성한 백로그를 살펴봅니다. 별점을 추가하는 작은 변경으로 시작한 뒤, 이슈를 바탕으로 사용자 지정 지침 표준을 추가하고, 격리된 에이전트 세션에서 필터링 기능을 구축하고, 재사용 가능한 스킬로 검증합니다. Playwright MCP 서버를 추가하여 실제 브라우저에서 기능을 살펴본 다음, **Agent Merge**가 끌어오기 요청을 병합하는 단계까지 병합 자동화 수준을 높입니다. 마지막으로 공유 캔버스에서 협업하고 반복 작업을 자동화하여 아이디어를 병합된 기능으로 완성하는 전체 과정을 경험합니다. +설정 레슨 0~1에서 프로젝트와 App 워크스페이스를 준비합니다. 아홉 개의 핵심 모듈인 레슨 2~10은 별점을 추가하는 작은 변경과 실제 코드로 효과를 확인하는 문서화 규칙으로 시작합니다. 그런 다음 필터링을 계획하고 구축하며, 셸 스크립트를 포함하는 quality-checks 스킬을 만들고 실행하고, Playwright MCP로 기능을 관찰하며, 요구 사항과 커버리지를 평가할 QA 사용자 지정 에이전트를 만듭니다. 전체 기능 PR을 검토하고 Agent Merge를 승인한 다음 공유 이슈 분류 캔버스를 만들고 병합합니다. + +워크숍에는 네 번의 PR 마일스톤이 있습니다. 별점, 지침과 시연, 필터링과 스킬·QA 프로필·테스트, 마지막으로 캔버스입니다. 각 마일스톤은 업데이트된 `main`에서 시작하며, 모듈별이 아니라 PR별로 하나의 브랜치를 사용합니다. 레슨 4~8은 동일한 필터링 세션, 워크트리, 브랜치를 유지합니다. 캔버스를 다시 열 때는 이슈 컨텍스트만 추가하고 다른 기능이나 다섯 번째 PR을 시작하지 않습니다. 자동화는 추가 실습이 아니라 다음 단계의 링크로 소개합니다. ## 레슨 @@ -16,13 +18,15 @@ lastUpdated: 2026-06-30 |--------|-------|-------------| | [0. 필수 조건][ex0] | 설정 | Node.js를 설치하고 Tailspin Toys 프로젝트의 복사본 만들기 | | [1. Copilot app 설치][ex1] | 설정 | 앱을 설치하고 프로젝트를 연결한 다음 워크스페이스 살펴보기 | -| [2. 첫 번째 에이전트 세션 실행][ex2] | 첫 번째 변경 | 세션을 시작하고 작은 변경을 첫 번째 끌어오기 요청으로 제공하기 | -| [3. 사용자 지정 지침으로 Copilot 안내][ex3] | 컨텍스트 | 이슈를 바탕으로 문서화 표준을 추가하고 병합하기 | -| [4. Autopilot으로 기능 구축][ex4] | 핵심 기능 | Plan과 Autopilot으로 필터링 기능을 구축한 다음 스킬로 검증하기 | -| [5. Playwright MCP로 테스트][ex5] | 외부 도구 | Playwright MCP 서버를 추가하고 브라우저에서 기능 살펴보기 | -| [6. Agent Merge로 병합][ex6] | 병합 | Agent Merge가 필터링 끌어오기 요청을 수정하고 병합하도록 하기 | -| [7. 캔버스로 계획 수립][ex7] | 협업 | 작업을 계획하고 추적하는 공유 캔버스 만들기 | -| [8. 검토 및 다음 단계][ex8] | 요약 | 반복 작업을 자동화하고 다음에 살펴볼 내용 알아보기 | +| [2. 별점 추가로 작은 성과 얻기][ex2] | 첫 번째 변경 | 기존 별점과 null 대체 표시를 추가하고 PR 1 병합하기 | +| [3. 사용자 지정 지침으로 Copilot 안내][ex3] | 컨텍스트 | 문서화 표준과 실제 시연을 추가하고 PR 2 병합하기 | +| [4. Plan과 Autopilot으로 필터링 구축][ex4] | 구현 | 계획을 승인하고 필터링을 구현·검사한 다음 체크포인트 저장하기 | +| [5. quality-checks 스킬 만들기 및 사용][ex5] | 반복 가능한 검사 | 함께 제공할 셸 스크립트를 만들고 검토하고 실행하기 | +| [6. Playwright MCP로 기능 검증][ex6] | 브라우저 관찰 | Customize에서 MCP를 구성하고 필터링 동작 살펴보기 | +| [7. QA 에이전트 만들기 및 사용][ex7] | 요구 사항과 커버리지 | 전문가 프로필을 선택하고 최종 검증 근거 수집하기 | +| [8. 기능 PR 만들기 및 병합][ex8] | 검토와 병합 | 필터링, 스킬, QA 프로필, 테스트를 검토한 다음 PR 3의 Agent Merge 승인하기 | +| [9. 이슈 분류 캔버스 만들기][ex9] | 협업 | 리포지토리에 저장하는 캔버스를 PR 4로 공유하고 이슈 컨텍스트 추가하기 | +| [10. 마무리 및 다음 단계][ex10] | 요약 | 워크플로, 산출물, 추가 리소스 돌아보기 | ## 필수 조건 @@ -50,9 +54,11 @@ lastUpdated: 2026-06-30 [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students \ No newline at end of file diff --git a/docs/pt-br/README.md b/docs/pt-br/README.md index 6e3709b9..80216e6a 100644 --- a/docs/pt-br/README.md +++ b/docs/pt-br/README.md @@ -27,7 +27,7 @@ GitHub Copilot no **Visual Studio Code** e no GitHub Codespaces. Trabalhe com o ### 🤖 [Aplicativo Copilot](app/) -O **aplicativo GitHub Copilot** — um aplicativo para desktop criado com base no Copilot CLI. Execute sessões paralelas de agentes, alterne entre modos de sessão, colabore em telas e gerencie problemas e solicitações de pull do GitHub de forma nativa — incluindo o **Agent Merge**, que conduz uma solicitação de pull por rebases, comentários de revisão, correções de CI e mesclagem. +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/) diff --git a/docs/pt-br/app/0-prerequisites.md b/docs/pt-br/app/0-prerequisites.md index 13492034..6439b13e 100644 --- a/docs/pt-br/app/0-prerequisites.md +++ b/docs/pt-br/app/0-prerequisites.md @@ -15,18 +15,18 @@ Nesta lição, você vai: ## Instalar o Node.js -Em várias lições, você pedirá a um agente que crie recursos e execute localmente o conjunto de testes do Tailspin Toys. Para isso, é necessário o [**Node.js**][nodejs], o único ambiente de execução exigido pelo projeto. Instale a versão **22 ou posterior**; a versão **LTS** atual é uma escolha segura. +Em várias lições, você pedirá a um agente que crie recursos e execute localmente o conjunto de testes do Tailspin Toys. Para isso, é necessário o [**Node.js**][nodejs]. Use **Node.js 22.13 ou posterior** e confirme a versão compatível em `package.json` e README da sua cópia de trabalho. A opção mais simples em todas as plataformas é o instalador oficial: 1. No sistema operacional, abra uma janela de terminal usando o Windows Terminal, o Terminal do macOS ou o aplicativo que você costuma usar. -2. Execute o comando a seguir para confirmar que você tem o Node.js 22 ou posterior instalado: +2. Execute o comando a seguir para confirmar que você tem o Node.js 22.13 ou posterior instalado: ```shell node --version ``` -3. Se você vir `v22` ou um número maior, pule para a próxima seção. +3. Se a versão informada for pelo menos `v22.13.0` e compatível com o projeto, pule para a próxima seção. > [!TIP] > Você só precisa concluir estas etapas se não tiver o Node instalado ou se precisar atualizá-lo. @@ -41,10 +41,10 @@ A opção mais simples em todas as plataformas é o instalador oficial: node --version ``` -9. Você deve ver `v22.x.x` ou posterior. +9. Confirme que a versão informada é pelo menos `v22.13.0` e compatível com o projeto. -> [!TIP] -> Prefere contêineres? Se você tem o [**Docker**][docker], pode usar o [contêiner de desenvolvimento][dev-containers] do repositório em vez de instalar o Node.js localmente. Ele já inclui o Node. Você não precisa dos dois. +> [!IMPORTANT] +> Este percurso do aplicativo usa worktrees locais. Um runtime instalado apenas em um contêiner não está disponível para essas sessões locais. Cada worktree também precisa das dependências do projeto e do Chromium do Playwright para verificações E2E. Siga o README do repositório do participante ao preparar um worktree e revise qualquer solicitação de instalação antes de aprová-la. ## Configurar o repositório do laboratório @@ -64,6 +64,8 @@ Você trabalhará na sua própria cópia do projeto Tailspin Toys. Crie-a agora > [!NOTE] > 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 nenhuma. +Use uma cópia nova do modelo revisado: ele inclui instruções do repositório, código da aplicação, testes e uma extensão de canvas existente, mas não inclui agentes personalizados nem skills. Você criará sua própria skill quality-checks e um perfil QA durante o workshop. Se usar uma cópia mais antiga, examine as personalizações existentes em vez de sobrescrevê-las. + ## Resumo e próximos passos Tudo pronto! Você instalou o Node.js para criar e testar o projeto no seu computador e criou sua própria cópia do repositório Tailspin Toys a partir do modelo. @@ -79,7 +81,5 @@ Em seguida, você instalará o aplicativo GitHub Copilot, conectará o repositó [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/1-install-copilot-app.md b/docs/pt-br/app/1-install-copilot-app.md index 22bf82e5..d7065f63 100644 --- a/docs/pt-br/app/1-install-copilot-app.md +++ b/docs/pt-br/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ Como você pode imaginar, a primeira etapa para usar o aplicativo GitHub Copilot Com o projeto conectado, reserve um momento para conhecer o espaço de trabalho. O aplicativo organiza tudo em algumas áreas na barra lateral: -- **Sessions**: onde os agentes trabalham. Cada sessão é executada em seu próprio espaço de trabalho isolado, permitindo executar várias sessões ao mesmo tempo sem que as alterações entrem em conflito. Você iniciará sua primeira sessão na próxima lição. +- **Sessions**: onde os agentes trabalham. Neste workshop, escolha **new working tree** para que cada marco de PR tenha uma cópia de trabalho e uma branch isoladas. Existem outras opções de espaço de trabalho, mas elas não são usadas aqui. - **Quick chats**: conversas leves para perguntas e brainstorming que não precisam de branch ou espaço de trabalho próprios. Você experimentará uma ao final desta lição. - **My work**: suas issues e pull requests, exibidos por meio da **integração nativa com o GitHub**. Nessa área, você pode procurar e filtrar issues e pull requests, verificar o status da CI, iniciar uma sessão a partir de uma issue e revisar pull requests sem sair do aplicativo. -- **Automations**: tarefas de agente salvas que são executadas em uma agenda ou sob demanda. Você criará uma perto do fim deste percurso. +- **Customize**: descubra e gerencie servidores MCP, skills e canvases. Você usará essa área para configurar o MCP do Playwright. +- **Automations**: tarefas de agente salvas que são executadas em uma agenda ou sob demanda. O encerramento traz links para elas como próximo passo, não como outro exercício do workshop. ### Localizar o backlog criado pelo modelo Como o aplicativo tem integração nativa com o GitHub, o trabalho pendente no repositório aparece dentro dele. Quando você criou o repositório a partir do modelo, um backlog de issues foi criado. Vamos confirmar que ele está disponível. 1. Selecione **My work** na barra lateral. -2. O modelo criou oito issues no seu backlog. Este módulo foca nas três a seguir — confirme que você consegue vê-las: +2. Encontre estas issues pelo título em vez de presumir seus números: - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. Selecione uma issue para ler os detalhes. Cada issue também serve como ponto de partida para uma sessão de agente. Você começará a trabalhar com elas mais adiante neste percurso. +3. Selecione uma issue para ler os detalhes. Cada issue também serve como ponto de partida para uma sessão de agente. Você começará a trabalhar com elas mais adiante neste percurso. Outras issues do backlog fornecem contexto para o canvas, não outra tarefa de implementação. > [!NOTE] > A lista de itens em My work é filtrada automaticamente para exibir somente itens dos repositórios adicionados ao aplicativo Copilot. Quer ver itens de trabalho de outros repositórios? Adicione-os ao aplicativo. @@ -70,7 +70,7 @@ Uma ótima maneira de se familiarizar com o aplicativo é usá-lo para saber mai 2. Pergunte ao aplicativo como funcionam as próprias sessões: ```plaintext - How does the GitHub Copilot app use worktrees? + Como o aplicativo GitHub Copilot usa worktrees? ``` 3. Leia a resposta na visualização da conversa. Você verá que cada sessão é executada em seu próprio git worktree isolado, o que permite executar vários agentes em paralelo sem que as alterações entrem em conflito. Você pode continuar a conversa ou iniciar um novo chat a qualquer momento. @@ -84,7 +84,13 @@ Parabéns! Você instalou o aplicativo GitHub Copilot, conectou o projeto e expl - conhecer o espaço de trabalho e localizar o backlog criado em **My work**. - usar um chat rápido para fazer uma pergunta rápida e descartável. -Em seguida, você iniciará sua primeira sessão de agente e fará a primeira alteração no projeto: exibir uma avaliação por estrelas nos cards dos jogos. Continue para a [Lição 2 - Executar sua primeira sessão de agente][next-lesson]. +## Manter os marcos de PR separados + +Você fará o merge de quatro PRs: avaliações por estrelas; instruções com uma pequena demonstração; filtragem com a skill, o perfil QA e os testes; e, por fim, o canvas de triagem. Use uma branch por marco de PR. As Lições 4–8 permanecem na mesma sessão, worktree e branch de filtragem, com commits de checkpoint em vez de PRs adicionais. + +Um novo worktree do aplicativo pode começar com um estado local desatualizado. Antes de editar arquivos em cada novo marco, busque as atualizações do repositório e avance a branch da nova sessão por fast-forward até o `origin/main` mais recente. As próximas lições mostram isso explicitamente. Não empilhe branches, não aplique cherry-pick de trabalhos anteriores nem mude uma sessão de filtragem ativa para outra branch. + +Em seguida, você iniciará sua primeira sessão de agente e fará a primeira alteração no projeto: exibir uma avaliação por estrelas nos cards dos jogos. Continue para a [Lição 2 - Adicionar avaliações por estrelas: uma melhoria rápida][next-lesson]. ## Recursos @@ -92,7 +98,7 @@ Em seguida, você iniciará sua primeira sessão de agente e fará a primeira al - [Introdução ao aplicativo GitHub Copilot][getting-started] - [Trabalhar com sessões de agente no aplicativo GitHub Copilot][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/pt-br/app/10-review.md b/docs/pt-br/app/10-review.md new file mode 100644 index 00000000..fbc78050 --- /dev/null +++ b/docs/pt-br/app/10-review.md @@ -0,0 +1,87 @@ +--- +title: "Lição 10 - Revisão e próximos passos" +description: "Recapitule os nove módulos principais do aplicativo, os quatro marcos de PR e o fluxo reutilizável de qualidade e explore outros recursos." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Nas últimas lições, você levou um recurso da ideia ao merge com o aplicativo GitHub Copilot. Nesse processo, você: + +- conectou um repositório e conheceu o espaço de trabalho do aplicativo e o backlog criado pelo modelo. +- iniciou sessões a partir de uma tarefa direta e de issues e usou os modos Plan e Autopilot para controlar como o agente trabalha. +- orientou o agente com instruções personalizadas e depois pediu que ele criasse uma skill reutilizável com scripts de shell que você revisou e executou para lint, testes de unidade, testes de ponta a ponta e verificações de tipos. +- testou o trabalho com o servidor MCP do Playwright em um navegador real. +- criou e selecionou um agente personalizado QA para avaliar requisitos, cobertura, resultados dos scripts da skill e evidências do navegador. +- colaborou com o agente em um canvas compartilhado. +- fez o merge explicitamente dos primeiros PRs por conta própria e depois autorizou o **Agent Merge** nos fluxos de PR do recurso e do canvas. + +As Lições 0–1 de configuração levaram aos nove módulos principais, as Lições 2–10. Reserve um momento para revisar os artefatos e os próximos passos; este encerramento não inicia outra tarefa prática. + +## O que você entregou + +O workshop tem quatro marcos de PR, cada um em sua própria branch a partir de `main` atualizado: + +1. **Avaliações por estrelas:** exibir o `starRating` existente e um estado explícito sem avaliação nos cards dos jogos. +2. **Instruções e demonstração:** adicionar a convenção de documentação e verificar seu efeito em uma pequena alteração real de código. +3. **Filtragem e fluxo de qualidade:** implementar a issue, criar a skill `quality-checks` com scripts de shell e o perfil QA e incluir os testes associados. +4. **Canvas de triagem salvo no repositório:** compartilhar um quadro que adiciona contexto de issues sem implementar automaticamente outro recurso. + +As Lições 4–8 usaram a mesma sessão, worktree e branch de filtragem. Os commits de checkpoint preservaram o progresso dentro do PR 3; skills, configuração MCP e QA não precisaram de branches de recurso separadas. Cada marco posterior começou apenas depois do merge do PR anterior e da atualização da branch da nova sessão a partir de `origin/main`. + +## Diferentes tipos de verificação + +Os primeiros recursos usaram as verificações npm existentes. A filtragem acrescentou sua inspeção manual no navegador. A skill tornou as quatro verificações repetíveis por meio de scripts incluídos, o MCP acrescentou observações diretas do agente no navegador e o QA combinou requisitos e cobertura com a verificação final. O PR reutilizou evidências de QA apenas enquanto elas se aplicavam à revisão enviada. + +Os testes adicionados devem cobrir lacunas reais; uma execução de QA que não precisa de testes novos pode estar correta. Ferramentas ausentes, verificações ignoradas e falhas são bloqueios visíveis, não aprovações. Revise código e evidências antes de autorizar o merge e atualize as evidências afetadas após alterações. + +## Boas práticas + +Ao usar qualquer ferramenta de IA, a infraestrutura ao redor dela influencia a qualidade dos resultados. Você criou instruções, uma skill e um perfil QA neste workshop; revise-os e reutilize-os entre sessões. Agentes personalizados definem papéis especializados e instruções, com ferramentas disponíveis conforme a configuração e as permissões do ambiente; skills reúnem instruções reutilizáveis para tarefas, scripts executáveis e recursos de apoio carregados sob demanda. Um agente personalizado também pode executar scripts, incluindo os que fazem parte de uma skill. Confirme a execução real dos scripts e a seleção do agente personalizado em vez de confiar em uma descrição convincente. + +Associe o **modo e o modelo** à tarefa. Use **Plan** para analisar uma abordagem antes de desenvolver, **Interactive** para acompanhar alterações específicas e **Autopilot** somente para tarefas isoladas e com escopo bem definido. Escolha um modelo mais rápido para edições rotineiras e um modelo mais avançado, com maior esforço de raciocínio, para trabalhos complexos. + +O contexto continua tão importante quanto a infraestrutura. Descrever claramente *o que* você quer criar, *por que* e *como* muda significativamente o resultado. Os chats rápidos são ótimos para definir o escopo de uma ideia antes de transformá-la em uma sessão completa. + +## Mais recursos para explorar + +Você percorreu o fluxo de trabalho principal. Veja outros recursos que valem a pena conhecer: + +- **Quick chats** para perguntas rápidas e descartáveis que não exigem uma sessão completa. +- [**Automações**][using-automations] para tarefas recorrentes ou sob demanda, como resumir trabalhos recentes. Revise a agenda, as permissões e o escopo antes de adotar uma; criar uma automação é um próximo passo, não parte deste workshop. +- **Rubber duck** para analisar um problema e receber feedback relevante antes de começar a desenvolver. +- [**Agentes personalizados**][custom-agents] para empacotar uma função, suas ferramentas e instruções para trabalhos especializados e repetíveis. +- [`/chronicle`][chronicle] para gerar uma narrativa do que aconteceu em uma sessão. +- [Bring your own key (BYOK)][byok] para usar modelos do seu próprio provedor, incluindo modelos locais por meio de Ollama, Foundry Local ou LM Studio. +- [Sandboxes na nuvem][sandboxes] para executar sessões em um ambiente isolado hospedado pelo GitHub. +- [Deep links][deep-links] para abrir o aplicativo diretamente em um repositório, uma sessão ou um prompt. + +## Próximos passos + +A melhor maneira de melhorar com qualquer ferramenta é continuar usando-a. Use-a em código de produção, em projetos pessoais ou naquele pequeno aplicativo que você planeja criar há anos. Compartilhe o que aprendeu com sua equipe e aprenda com as experiências dela. E, como sempre, explore a documentação. + +Para conhecer melhor o ecossistema do GitHub Copilot, confira o [percurso do VS Code][vscode-harness], o [percurso do Copilot CLI][cli-harness] ou o [percurso do agente de nuvem][cloud-harness]. + +## Recursos + +- [Sobre o aplicativo GitHub Copilot][about-copilot-app] +- [Introdução ao aplicativo GitHub Copilot][getting-started] +- [Personalizar o aplicativo GitHub Copilot][customize] +- [Usar automações][using-automations] +- [Trabalhar com extensões de canvas][canvas-docs] +- [Sobre sandboxes locais e na nuvem][sandboxes] + +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app +[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started +[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app +[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes +[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle +[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents +[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models +[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/pt-br/app/2-add-star-rating.md b/docs/pt-br/app/2-add-star-rating.md index 3a546d52..4650904a 100644 --- a/docs/pt-br/app/2-add-star-rating.md +++ b/docs/pt-br/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "Lição 2 - Executar sua primeira sessão de agente" +title: "Lição 2 - Adicionar avaliações por estrelas: uma melhoria rápida" description: "Inicie sua primeira sessão de agente no aplicativo GitHub Copilot, faça uma pequena alteração nos cards dos jogos e integre-a como seu primeiro pull request." authors: - geektrainer @@ -22,7 +22,7 @@ Cada jogo no Tailspin Toys pode ter uma avaliação por estrelas, que já aparec ## Anatomia de uma sessão -Uma **sessão** é uma conversa com um agente executada em seu próprio espaço de trabalho isolado. Cada sessão recebe um **git worktree e uma branch dedicados**, o que permite executar várias sessões ao mesmo tempo, uma adicionando um recurso e outra corrigindo um bug, sem que as alterações entrem em conflito. Suas sessões aparecem na barra lateral agrupadas por repositório. Selecione qualquer uma delas para acessá-la. +Uma **sessão** é uma conversa com um agente. Neste workshop, você escolhe **new working tree**, dando à sessão uma cópia de trabalho e uma branch dedicadas. Isso isola cada marco de PR sem uma branch separada para cada lição. Suas sessões aparecem na barra lateral agrupadas por repositório. Selecione qualquer uma delas para acessá-la. Em uma sessão, você verá três elementos: a **conversa** com o agente, a **atividade de ferramentas** do agente enquanto ele explora e edita arquivos e a lista de **arquivos alterados** com os respectivos diffs. @@ -36,16 +36,20 @@ Vamos iniciar uma nova sessão para começar a explorar o projeto e implementar ![Caixa de prompt do aplicativo GitHub Copilot com o seletor de repositório definido como tailspin-toys e o seletor de modelo exibido abaixo do prompt](../../_images/app-2-start-session.png) -4. Use o prompt a seguir para solicitar a alteração: +4. Escolha **new working tree** e o modo **Interactive** abaixo da caixa de prompt. Use o prompt a seguir para solicitar a alteração: ```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. + Antes de editar, identifique esta cópia de trabalho e a branch, confirme que é um worktree novo e limpo, busque as atualizações de origin e avance a branch desta sessão por fast-forward até origin/main. Confirme que HEAD corresponde a origin/main. Pare e explique se houver alterações pendentes, divergências ou se não for possível atualizar; não redefina nem descarte trabalho. + + 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 nem altere o modelo de dados. + + Siga as instruções do repositório, adicione ou atualize os testes adequados e execute as verificações npm existentes relevantes. Examine os pré-requisitos e pergunte antes de instalar qualquer coisa. Relate os arquivos alterados e os resultados das verificações e pare para minha revisão. Não faça commit, push, não abra um pull request nem implemente outro recurso. ``` > [!NOTE] > Observe que o prompt contém o nome do arquivo que o Copilot deve atualizar. Embora não seja obrigatório especificar os arquivos que o Copilot deve incluir no trabalho, indicar a direção certa ajuda o Copilot a gerar código mais rapidamente e reduz o uso de tokens. -5. Selecione Enter para enviar o prompt ao Copilot. +5. Pressione Enter para enviar o prompt ao Copilot. O aplicativo Copilot começa criando um novo worktree, uma cópia isolada do projeto. Em seguida, ele explora o projeto, localiza os arquivos que precisam ser atualizados e cria o código necessário para adicionar o novo recurso. Você acabou de adicionar um recurso com o aplicativo Copilot. @@ -76,7 +80,9 @@ Todas as alterações geradas por IA devem ser revisadas antes do merge, mesmo a ## Verificar as alterações -Não devemos apenas ler o código e presumir que ele funciona. Também precisamos testar tudo visualmente. Para isso, iniciaremos o aplicativo no terminal e confirmaremos o funcionamento. O aplicativo Copilot inclui um terminal. +Revise os resultados das verificações automatizadas do agente antes de abrir um navegador. Confirme que os testes cobrem um `starRating` numérico e a alternativa para `null`, usando os scripts npm existentes do projeto em vez de uma skill que ainda não existe. Um pré-requisito ausente ou uma verificação ignorada não conta como aprovação. + +Depois, examine o aplicativo manualmente pelo terminal integrado da sessão. Identifique o worktree antes de iniciar o servidor e não reutilize um servidor de outra cópia de trabalho. 1. No painel de revisão à direita do aplicativo Copilot, selecione **Terminal**. Se não houver um botão **Terminal**, selecione **+** (identificado como **Open in panel**) e depois selecione **Terminal**. @@ -89,26 +95,30 @@ Não devemos apenas ler o código e presumir que ele funciona. Também precisamo ``` 3. Quando o servidor iniciar, o que levará apenas alguns instantes, abra uma janela do navegador. -4. Acesse http://localhost:4321. -5. Agora você deve ver avaliações por estrelas em todos os jogos da página inicial. +4. Abra a URL local exibida pelo servidor, normalmente `http://localhost:4321`. Se a porta estiver ocupada, identifique seu responsável em vez de interromper um processo não relacionado. +5. Confirme que os cards de jogos avaliados mostram a nota em uma escala de cinco. Quando houver dados sem avaliação, confirme que **No rating yet** aparece; caso contrário, use o teste automatizado para verificar o caso null em vez de afirmar que o observou. 6. Volte à janela do terminal. -7. Selecione Ctrl+C para interromper o servidor de desenvolvimento. +7. Pressione Control+C (Mac) ou Ctrl+C (Windows/Linux) para interromper o servidor de desenvolvimento que você iniciou. ## Abrir e fazer merge do primeiro pull request -A alteração está correta. Agora é hora de entregá-la. Você pedirá ao agente que abra um pull request e depois fará a revisão e o merge no github.com. Por enquanto, gerenciaremos esse processo manualmente. Em uma próxima lição, veremos como o Copilot pode automatizar parte desse trabalho. +A alteração está correta. Agora é hora de entregar o PR 1. Primeiro, autorize o commit e o PR separadamente da implementação: + +```plaintext +Revise o diff completo da alteração de avaliações por estrelas e seus testes, resuma a verificação e faça commit das alterações revisadas na branch desta sessão. Envie a branch e crie um pull request destinado a main usando o modelo de PR do repositório. Não faça o merge. +``` -1. No canto superior direito, selecione **Create PR**. +1. Abra o link do PR criado na sessão. Se o aplicativo apresentar uma confirmação **Create PR**, selecione-a para aprovar a solicitação em vez de criar um segundo PR. 2. Se solicitado, selecione **Sign in with your browser** e siga as instruções para se autenticar. 3. O Copilot começará a criar o PR. -Após a criação do PR, o Copilot monitorará os fluxos de trabalho do repositório que precisam ser executados. Depois de alguns instantes, o botão no canto superior direito mudará para **Ready to merge**, indicando que o PR está pronto para o merge. +Após a criação do PR, examine o diff completo e as verificações em **My work**. Leia os resultados dos fluxos de trabalho do repositório do participante; aguarde as verificações e revisões obrigatórias e resolva falhas antes do merge. **Ready to merge** não substitui a revisão da alteração ou das evidências locais. 4. Selecione o indicador **PR** logo acima do chat para abrir o PR no painel de revisão e visualizá-lo. Faça as revisões necessárias nesse painel. 5. Quando estiver tudo pronto, selecione **Ready to merge**. 6. Na nova caixa de diálogo, selecione **Merge pull request** para fazer o merge do pull request. -Você acaba de enviar um novo recurso para o site. +Confirme que o PR 1 foi integrado a `main` antes de continuar. Fazer merge no repositório do participante não implanta um site por si só. A próxima lição inicia um worktree novo e o atualiza a partir de `origin/main` para incluir esse PR. ## Resumo e próximos passos @@ -118,7 +128,7 @@ Você iniciou sua primeira sessão de agente e entregou sua primeira alteração - orientou o agente a fazer uma alteração pequena e específica nos cards dos jogos. - revisou a alteração na visualização de diff do espaço de trabalho. - executou o aplicativo localmente para confirmar a avaliação por estrelas no navegador. -- abriu um pull request e fez o merge por conta própria no github.com. +- abriu o PR 1, revisou as verificações e fez o merge explicitamente. Em seguida, você usará o aplicativo para adicionar um padrão de instruções personalizadas ao repositório, começando por uma das issues do backlog. Continue para a [Lição 3 - Orientar o Copilot com instruções personalizadas][next-lesson]. @@ -129,6 +139,7 @@ Em seguida, você usará o aplicativo para adicionar um padrão de instruções - [Gerenciar issues e pull requests com o aplicativo GitHub Copilot][managing-issues-prs] [prior-lesson]: ../1-install-copilot-app/#instalar-e-configurar-o-aplicativo-github-copilot +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/pt-br/app/3-custom-instructions.md b/docs/pt-br/app/3-custom-instructions.md index 91363726..56407a9e 100644 --- a/docs/pt-br/app/3-custom-instructions.md +++ b/docs/pt-br/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "Lição 3 - Orientar o Copilot com instruções personalizadas" -description: "Use o aplicativo GitHub Copilot para adicionar ao repositório um padrão de instruções personalizadas, começando por uma issue do backlog e fazendo o merge da alteração como um pull request." +description: "Adicione um padrão de documentação, demonstre-o em uma pequena função auxiliar ou componente existente e integre ambos como segundo pull request." authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- O contexto é fundamental ao trabalhar com IA generativa. Se uma tarefa precisa ser realizada de determinada maneira ou se há informações de apoio que o Copilot deve conhecer, esse contexto precisa estar disponível. Uma das ferramentas mais eficientes para isso são os [arquivos de instruções][instruction-files], que descrevem não apenas *qual* código você deseja, mas *como* ele deve ser estruturado. Nesta lição, você adicionará um padrão de documentação ao repositório. Você fará isso da mesma forma que realizará a maior parte do trabalho daqui em diante: começando por uma issue do backlog e permitindo que o agente faça a alteração. @@ -12,15 +12,17 @@ Nesta lição, você vai: - explorar como as instruções do repositório e os arquivos de instruções com escopo de caminho chegam ao agente. - iniciar uma sessão a partir da issue de instruções no backlog. -- pedir ao agente que adicione um padrão de documentação a `.github/copilot-instructions.md`. -- revisar a alteração e fazer o merge dela como um pull request. +- pedir ao agente que adicione um padrão de documentação específico aos arquivos de instruções adequados do repositório. +- demonstrar o padrão com uma pequena alteração real de código, validá-la e fazer o merge do PR 2. ## Cenário Como toda boa equipe de desenvolvimento, a Tailspin Toys tem diretrizes e requisitos para as práticas de desenvolvimento. Entre eles estão: -- A documentação deve ser adicionada ao código na forma de comentários de documentação TSDoc. -- A formatação deve ser documentada e aplicada por meio de linting. +- Os comentários devem explicar a intenção e as decisões não óbvias, em vez de repetir o código. +- As funções exportadas em `db/` e `src/lib/` devem documentar seu propósito, parâmetros e valores de retorno com TSDoc/JSDoc, incluindo um argumento `db` injetável quando presente. +- Os componentes reutilizáveis de Astro devem documentar seus contratos de `Props`, e os comentários devem ser mantidos atualizados quando o código relacionado mudar. +- As orientações existentes de formatação e lint devem ser preservadas. Com os arquivos de instruções, você garantirá que o Copilot tenha as informações certas para executar as tarefas de acordo com as práticas destacadas. @@ -28,13 +30,13 @@ Com os arquivos de instruções, você garantirá que o Copilot tenha as informa As instruções personalizadas permitem fornecer contexto e preferências ao Copilot para que ele compreenda melhor seu estilo de programação e seus requisitos. Esse recurso ajuda a orientar o Copilot para obter sugestões e trechos de código mais relevantes. Você pode especificar convenções de código, bibliotecas e até os tipos de comentários que deseja incluir no código. É possível criar instruções para todo o repositório ou para tipos de arquivo específicos, fornecendo contexto no nível da tarefa. -Há dois tipos de arquivos de instruções: +O projeto usa dois tipos de arquivos de instruções: - `.github/copilot-instructions.md`, um único arquivo de instruções enviado ao Copilot em **todas** as solicitações do repositório. Esse arquivo deve conter informações no nível do projeto, ou seja, contexto relevante para a maioria das solicitações enviadas ao Copilot pelo chat ou pela CLI. Isso pode incluir a pilha de tecnologias usada, uma visão geral do que está sendo criado, boas práticas e outras orientações globais. - Os arquivos `.github/instructions/*.instructions.md` podem ser criados para tarefas ou tipos de arquivo específicos. Você pode usá-los para fornecer diretrizes para determinadas linguagens, como TypeScript ou Astro, ou para tarefas como criar um componente de interface ou um novo conjunto de testes de unidade. > [!NOTE] -> O Copilot também oferece suporte a outros padrões para incorporar orientações por meio de AGENTS.md, CLAUDE.md e GEMINI.md, garantindo que ele sempre tenha o contexto correto. +> Outros formatos de instruções e seu suporte variam conforme o ambiente. Consulte a [referência de suporte a instruções personalizadas][custom-instructions-support] antes de depender de um formato específico. ### Boas práticas para gerenciar arquivos de instruções @@ -74,49 +76,55 @@ Reserve um momento para ler os arquivos de instruções incluídos no repositór 11. 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 e indicar ao Copilot exemplos a serem seguidos ao gerar código. Os caminhos ali 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 código do projeto, mas ainda não exige documentação no código. Nas próximas etapas, você adicionará regras para comentários de documentação TSDoc e cabeçalhos de comentários nos arquivos. +> Compare as orientações existentes com a issue real de padrões de código antes de adicionar regras. Esta lição foca em comentários que explicam intenção, documentação de funções exportadas da camada de dados e contratos de `Props` de Astro, não em cabeçalhos obrigatórios para todos os arquivos ou comentários que repetem o código. ## Começar pela issue de instruções -Na lição anterior, você iniciou uma sessão com um prompt direto. No entanto, a maior parte do trabalho começa com uma issue. Vamos criar uma nova sessão com base em uma issue criada para atualizar os arquivos de instruções e depois solicitar a atualização. +Confirme que o PR 1 foi integrado antes de criar esta sessão. Inicie um worktree novo para o PR 2; não continue na branch de avaliações por estrelas. A maior parte do trabalho começa com uma issue, então use a issue de padrões de código para fornecer os requisitos. > [!NOTE] > Como os arquivos de instruções têm grande impacto no código gerado pelo Copilot, é preciso garantir que eles orientem o Copilot com clareza. Permitir que o Copilot crie uma primeira versão, como você fará nesta lição, é uma ótima abordagem. Depois, revise o resultado para confirmar que as atualizações atendem aos requisitos. 1. Selecione **My work** na barra lateral. 2. Selecione a issue intitulada **Update our repository coding standards** para abri-la. -3. Selecione **New session** no canto superior direito para iniciar uma nova sessão com base na issue. +3. Selecione **New session** no canto superior direito, escolha **new working tree** e selecione o modo **Interactive**. ![Visualização da issue no aplicativo GitHub Copilot com uma seta apontando para o botão New session no canto superior direito](../../_images/app-new-session-from-issue.png) -4. Use o prompt a seguir para solicitar que o Copilot atualize os arquivos de instruções de acordo com os requisitos documentados na issue: +4. Use o prompt a seguir. Atualizar a branch da nova sessão antes de editar faz com que a versão integrada mais recente de `main` seja o ponto de partida real, mesmo se a cópia local do aplicativo estiver desatualizada: - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + Antes de editar, identifique esta cópia de trabalho e a branch, confirme que é um worktree novo e limpo, busque as atualizações de origin e avance a branch desta sessão por fast-forward até origin/main. Confirme que HEAD corresponde a origin/main e inclui o PR integrado de avaliações por estrelas. Pare se houver alterações pendentes, divergências ou se esse merge estiver ausente; não redefina, não descarte trabalho nem crie outra branch. + + Leia a issue "Update our repository coding standards" e as instruções existentes do repositório. Adicione uma convenção de documentação específica: explique a intenção em vez da mecânica; documente funções exportadas em db/ e src/lib/ com TSDoc/JSDoc cobrindo propósito, parâmetros, retornos e argumentos db injetáveis quando presentes; 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, sem duplicações ou contradições, e inclua um link ou resumo do padrão atualizado em README. Preserve as orientações existentes de formatação e lint. Não exija cabeçalhos para todos os arquivos, não migre ferramentas de formatação, não reescreva a documentação de toda a aplicação nem implemente a filtragem. Mostre o diff das instruções e pare para revisão. Não crie uma skill ou agente, não faça commit, push nem crie um PR. + ``` O Copilot fará as atualizações. ## Revisar a alteração -Vamos ler as atualizações feitas pelo Copilot e também pedir um exemplo do código que ele passará a gerar com base nas instruções atualizadas. +Leia as orientações atualizadas e demonstre seu efeito em um arquivo real. Apenas um trecho proposto não demonstra que as instruções do repositório influenciaram uma alteração de código. 1. Selecione **Changes** no canto superior direito para abrir as alterações no código. ![Abas do painel da sessão no aplicativo GitHub Copilot com uma seta apontando para a aba Changes](../../_images/app-select-changes.png) -2. Revise o arquivo de instruções atualizado. Confirme se ele contém as diretrizes para adicionar documentação e comentários ao código. +2. Revise os arquivos de instruções atualizados e a referência em README. Confirme que as regras correspondem à filosofia de comentários, à documentação de funções exportadas e aos contratos de componentes da issue, sem inventar uma exigência geral de cabeçalhos de arquivo. > [!NOTE] > Como a IA é probabilística, e não determinística, o texto exato pode variar. -3. Use o prompt a seguir para pedir ao Copilot que crie um exemplo do código que passará a gerar: +3. Após revisar as instruções, solicite uma demonstração com escopo limitado nesta mesma sessão: + + ```plaintext + Demonstre a convenção de documentação atualizada em uma pequena função auxiliar TypeScript exportada existente em db/ ou src/lib/, ou em um componente reutilizável de Astro. Examine o repositório para escolher um arquivo existente adequado; não presuma que existe uma função auxiliar de distribuidoras. Faça uma pequena melhoria de legibilidade que preserve o comportamento e aplique as orientações relevantes de documentação de funções ou contratos de Props. Explique intenções não óbvias sem adicionar comentários que apenas repitam o código. - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + Limite a alteração a essa demonstração e aos testes diretamente relevantes. Não implemente a filtragem nem crie um recurso novo. Execute as verificações npm existentes relevantes, relate o que mudou e como a instrução afetou o código e pare para revisão. Pergunte antes de instalar qualquer coisa. Não faça commit, push nem crie um PR. + ``` -4. Revise o código proposto pelo Copilot. Observe os comentários de documentação TSDoc e o comentário de cabeçalho do arquivo, exatamente como solicitado pelas instruções atualizadas. +4. Revise o diff real do arquivo, não apenas a resposta do chat. Verifique se a documentação explica o comportamento real e se a melhoria de legibilidade o preserva. Revise os resultados relevantes de testes, lint e verificação de tipos; resolva falhas antes de continuar. Você atualizou os arquivos de instruções do projeto e viu o impacto que eles terão. @@ -124,17 +132,23 @@ Você atualizou os arquivos de instruções do projeto e viu o impacto que eles Os arquivos de instruções se tornam ativos do repositório, portanto são compartilhados com o restante da equipe. Vamos criar um PR com esse trabalho, como faríamos com qualquer outro ativo. -1. No canto superior direito, selecione **Create PR**. +Primeiro, autorize as instruções e a demonstração revisadas em conjunto: + +```plaintext +Revise o diff completo das instruções de padrões de código, da referência em README e da demonstração de código com escopo limitado, incluindo os testes relacionados. Resuma a verificação e faça commit dessas alterações revisadas na branch desta sessão. Envie a branch e crie um único pull request destinado a main, usando o modelo de PR do repositório e vinculando a issue de padrões de código. Descreva isso como contribuição parcial, a menos que todos os critérios de aceitação da issue sejam atendidos; não use palavras-chave de fechamento para trabalho incompleto. Não faça o merge. +``` + +1. Abra o link do PR na sessão. Se o aplicativo apresentar uma confirmação **Create PR**, selecione-a sem criar um PR duplicado. 2. Se solicitado, selecione **Sign in with your browser** e siga as instruções para se autenticar. 3. O Copilot começará a criar o PR. -Após a criação do PR, o Copilot monitorará os fluxos de trabalho do repositório que precisam ser executados. Depois de alguns instantes, o botão no canto superior direito mudará para **Ready to merge**, indicando que o PR está pronto para o merge. +Examine o diff completo do PR em **My work**, incluindo as alterações de instruções e código. Revise os resultados de CI do repositório do participante e as revisões obrigatórias. Resolva falhas antes de selecionar **Ready to merge**; a CI não substitui a demonstração nem sua revisão. 4. Selecione **Ready to merge**. 5. Na nova caixa de diálogo, selecione **Merge pull request** para fazer o merge do pull request. > [!NOTE] -> Depois que o padrão for integrado à branch padrão, ele fará parte do projeto para toda a equipe e para cada nova sessão. Quando você iniciar a sessão de filtragem na próxima lição a partir de uma branch padrão atualizada, o agente seguirá esse padrão automaticamente. O código TypeScript gerado incluirá comentários de documentação TSDoc sem que você precise solicitá-los, uma demonstração pequena, mas concreta, de como as instruções moldam o código gerado. +> Confirme que o PR 2 foi integrado a `main` antes de iniciar a filtragem. Apenas um worktree novo não garante código atualizado: na Lição 4, você buscará as atualizações e avançará a branch da nova sessão por fast-forward até `origin/main`, verificando se os dois merges anteriores estão presentes antes de planejar. ## Resumo e próximos passos @@ -142,10 +156,10 @@ Você explorou como o aplicativo obtém contexto dos arquivos de instruções e - explorou o arquivo `copilot-instructions.md` do repositório e os arquivos `*.instructions.md` com escopo de caminho. - iniciou uma sessão a partir da issue de instruções no backlog. -- pediu ao agente que adicionasse um padrão de documentação a `.github/copilot-instructions.md`. -- revisou a alteração e fez o merge dela como um pull request. +- pediu ao agente que adicionasse regras de documentação específicas aos arquivos de instruções adequados e as referenciasse em README. +- examinou o efeito do padrão em uma alteração real de código, validou o resultado e integrou ambos como PR 2. -Em seguida, você criará o recurso de filtragem em uma nova sessão e verá como ele adota o padrão que acabou de integrar. Continue para a [Lição 4 - Criar um recurso com o Autopilot][next-lesson]. +Em seguida, você criará o recurso de filtragem em uma nova sessão e verificará se ele segue o padrão que acabou de integrar. Continue para a [Lição 4 - Criar a filtragem com Plan e Autopilot][next-lesson]. ## Recursos @@ -154,6 +168,7 @@ Em seguida, você criará o recurso de filtragem em uma nova sessão e verá com - [Boas práticas para criar instruções personalizadas][instructions-best-practices] - [Awesome Copilot — uma coleção de arquivos de instruções e outros recursos][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/pt-br/app/4-build-filtering.md b/docs/pt-br/app/4-build-filtering.md index d36228c4..22ee18b6 100644 --- a/docs/pt-br/app/4-build-filtering.md +++ b/docs/pt-br/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "Lição 4 - Criar um recurso com o Autopilot" -description: "Use os modos Plan e Autopilot no aplicativo GitHub Copilot para criar um recurso estático de filtragem no lado do cliente, observar como ele herda seu padrão de documentação e verificá-lo com uma skill de agente." +title: "Lição 4 - Criar a filtragem com Plan e Autopilot" +description: "Planeje a filtragem a partir da issue, aprove o Autopilot explicitamente, valide com as verificações npm existentes e uma visita manual ao navegador e salve um checkpoint." authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -Até agora, fizemos algumas pequenas atualizações no projeto. No entanto, alterações mais robustas exigem um processo mais completo. O aplicativo GitHub Copilot foi criado para trabalhar com nosso fluxo existente e ajudar a garantir que criemos as soluções certas da maneira correta. Esta é a primeira de três lições nas quais você seguirá um processo típico de desenvolvimento, começando por usar uma issue para gerar um novo recurso e uma skill de agente para executar os testes de validação e os linters. +Você integrou as avaliações por estrelas e o padrão de documentação com sua demonstração de código. Agora crie o recurso de filtragem. Este é o início de um marco de PR maior: mantenha esta mesma sessão, worktree e branch durante as Lições 4–8. Nesta lição, você vai: -- iniciar uma nova sessão a partir da issue de filtragem. -- usar o modo **Plan** para planejar o recurso e depois o **Autopilot** para criá-lo. -- confirmar que o código gerado segue o padrão de documentação integrado anteriormente. -- verificar o trabalho com a skill `quality-checks` do projeto. +- partir de `main` atualizado e ler a issue real de filtragem. +- resolver os requisitos no modo **Plan** antes de aprovar explicitamente o **Autopilot**. +- revisar a filtragem e os testes e executar as quatro verificações npm existentes. +- visitar o recurso manualmente no navegador e salvar um checkpoint. + +A skill, a validação MCP, o perfil QA e o PR do recurso vêm nos próximos módulos. Não os crie durante esta etapa de implementação. ## Cenário -A página inicial lista todos os jogos, mas os visitantes não conseguem restringir a lista. A issue de filtragem solicita que eles possam filtrar jogos por **categoria** e **distribuidora**. Vamos usar o Copilot para implementar essa funcionalidade. +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. -## Contexto +## Modos de sessão -Introduzir agentes de programação com IA no fluxo de desenvolvimento não muda os fundamentos. Na verdade, eles se tornam ainda mais importantes. A maioria das pessoas desenvolvedoras segue um fluxo semelhante a este: +O seletor de modo abaixo do prompt controla a autonomia do agente: -1. Abrir uma issue com os detalhes do que precisa ser feito. -2. Criar um plano do que precisa ser desenvolvido. -3. Criar e revisar o código. -4. Executar os testes para validar o código. -5. Validar manualmente a nova funcionalidade. -6. Criar um pull request (PR). -7. Depois que o código for revisado e o processo de integração contínua for concluído com êxito, fazer o merge do código. +- **Interactive** mantém você envolvido enquanto o agente trabalha e solicita informações. +- **Plan** prepara um plano para revisão antes da implementação. +- **Autopilot** implementa e itera de forma autônoma dentro do escopo e das permissões aprovados. -> [!NOTE] -> Os detalhes exatos variam de acordo com sua equipe e organização, mas a maioria dos fluxos será uma variação do processo descrito acima. +Planeje primeiro, aprove explicitamente e volte ao Interactive antes de criar personalizações reutilizáveis. -Ao seguir essa abordagem padrão, você garante que o código gerado por IA atenda aos requisitos definidos e passe pelo mesmo processo de avaliação do código escrito manualmente. +## Partir de main atualizado -## Modos de sessão +Confirme que o PR 1 e o PR 2 foram integrados no GitHub. Crie um worktree novo para a filtragem em vez de continuar em qualquer uma das branches anteriores. -O **modo de sessão** controla o grau de autonomia do agente. Você pode defini-lo no menu suspenso abaixo do campo de prompt e alterá-lo a qualquer momento: +1. Selecione **My work** e encontre **Allow users to filter games by category and publisher** pelo título. Abra a issue e copie sua URL real; os números de issue variam entre repositórios. +2. Selecione **New session** e escolha **new working tree**. Mantenha o modo **Interactive** para atualizar o estado inicial. -- **Interactive**: você e o agente trabalham em conjunto. O agente sugere alterações e aguarda sua orientação antes de prosseguir. -- **Plan**: o agente cria primeiro um plano. Você revisa e aprova o plano antes que o agente o execute. -- **Autopilot**: o agente trabalha com total autonomia, escrevendo código, executando testes e iterando sem aguardar sua orientação. + ![Visualização da issue no aplicativo GitHub Copilot com uma seta apontando para o botão New session](../../_images/app-new-session-from-issue.png) -## Planejar o recurso de filtragem +3. Envie esta solicitação de preparação antes de planejar ou editar: -O melhor momento para detectar um possível problema é antes que qualquer código seja escrito, e a melhor maneira de fazer isso é planejar com antecedência. Ao planejar com o Copilot, você pedirá que ele gere um conjunto de etapas e documente a abordagem que seguirá. Em seguida, poderá revisar o plano e fazer sugestões para melhorá-lo antes de permitir que o Copilot gere o código com base nele. - -Vamos abrir a issue, iniciar uma nova sessão e criar um plano alternando para o modo Plan e fazendo a solicitação. + ```plaintext + Prepare esta nova sessão de filtragem sem implementar nada. Identifique a cópia de trabalho e a branch, confirme que o worktree está limpo, busque as atualizações de origin e avance a branch desta sessão por fast-forward até origin/main. Confirme que HEAD corresponde a origin/main e inclui os PRs integrados de avaliações por estrelas e padrões de código. -1. Selecione **My work** na aba de navegação. -2. Selecione a issue intitulada **Allow users to filter games by category and publisher**. -3. Selecione **New session** no canto superior direito. + Pare e explique se houver alterações pendentes, divergências ou se algum dos merges estiver ausente. Não redefina nem descarte trabalho, não mude de branch, não crie outra branch nem edite arquivos da aplicação. Informe a revisão inicial. + ``` - ![Visualização da issue no aplicativo GitHub Copilot com uma seta apontando para o botão New session no canto superior direito](../../_images/app-new-session-from-issue.png) +4. Verifique o estado inicial informado. Apenas buscar atualizações não atualiza o worktree: a branch da sessão atual deve avançar por fast-forward e seu `HEAD` deve corresponder ao `origin/main` obtido antes de começar o trabalho. -4. Selecione Shift+Tab até que o modo exibido seja **Plan**. +## Planejar o recurso de filtragem - ![Caixa de prompt do aplicativo GitHub Copilot com uma seta apontando para o seletor de modo definido como Plan](../../_images/app-4-plan-mode.png) +Mude o seletor de modo para **Plan**. Substitua o marcador da issue abaixo pela URL que você copiou. -5. Envie o prompt a seguir. A issue de filtragem já está no contexto da sessão porque você iniciou a partir dela: +```plaintext +Planeje o recurso de filtragem a partir desta issue: . Leia todos os critérios de aceitação e as instruções do repositório e examine a aplicação estática Astro atual, suas funções auxiliares de acesso a dados e os testes existentes. Não implemente ainda. - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +Cubra a seleção de várias categorias, a filtragem por distribuidora, a combinação de categorias e distribuidora, as funções auxiliares de acesso a dados adequadas, os controles acessíveis e a cobertura de unidade e de ponta a ponta exigida pela issue. Pergunte para que eu esclareça comportamentos não especificados, como a combinação de várias categorias, a limpeza dos filtros e os resultados vazios, em vez de inventar requisitos silenciosamente. Não introduza uma API de servidor, a menos que os requisitos e a arquitetura existente justifiquem. -6. O agente pode fazer perguntas complementares enquanto cria o plano. Responda com base em como você criaria o recurso. +Proponha um plano de implementação e verificação com escopo limitado que siga a convenção de documentação do repositório e adicione ou atualize os testes de unidade e de ponta a ponta necessários. Após confirmar os comandos em package.json, planeje executar npm run lint, npm run test:unit, npm run test:e2e e npm run typecheck:all com as ferramentas existentes do projeto. Registre a URL da issue e meus esclarecimentos aprovados no plano para que eu possa reutilizá-los no QA. -> [!NOTE] -> Como o Copilot é probabilístico, as perguntas complementares exatas podem variar. Na verdade, ele pode não fazer nenhuma pergunta. Isso é perfeitamente normal. +Inclua estas medidas de segurança de execução no plano antes da minha aprovação: identifique a cópia de trabalho e o servidor em teste; examine os pré-requisitos antes de executar verificações; pergunte antes de instalar software, dependências ou navegadores; não reutilize o servidor de outro worktree; pare apenas os servidores que você iniciou; e relate outros conflitos de porta em vez de interromper processos não relacionados. Pré-requisitos ausentes e verificações ignoradas devem ser relatados como bloqueios, não como verificações aprovadas. -7. Ao terminar, o Copilot apresentará um resumo do plano. Revise-o. Ele deve propor a criação de consultas, a adição de controles de filtro e, naturalmente, testes. Se desejar, forneça feedback para refiná-lo. O agente incorporará suas sugestões em uma nova versão. +Inclua este limite de implementação no plano: depois que eu aprovar explicitamente o Autopilot, implemente apenas o recurso de filtragem acordado e seus testes neste mesmo worktree e branch, execute as quatro verificações, relate a implementação e todos os resultados, incluindo falhas ou bloqueios, e pare para minha revisão e verificação manual no navegador. Não crie skills ou agentes personalizados, não configure MCP, não mude de branch, não faça commit, push nem abra um PR durante a implementação. A verificação manual no navegador e o commit de checkpoint ocorrerão depois, sob minha orientação separada. -## Criar com o Autopilot +Por enquanto, permaneça no modo Plan e pare com o plano para minha revisão. Não implemente, não crie skills ou agentes personalizados, não configure MCP, não mude de branch, não faça commit, push nem abra um PR. +``` -Com o plano pronto, vamos permitir que o Copilot crie a implementação. +Responda às perguntas de esclarecimento e compare o plano com a issue. Procure as alterações de acesso a dados, os controles acessíveis e os testes, em vez de aceitar uma implementação apenas de interface. Guarde a URL real da issue e os esclarecimentos aprovados do plano para as Lições 6 e 7; use `none` quando não forem necessários critérios adicionais. -1. Na lista de opções da caixa de diálogo **Plan summary**, selecione a opção mais próxima de **Approve and implement with autopilot**. +Antes de aprovar, confirme que o próprio plano contém as quatro verificações, a convenção de documentação, as medidas de segurança de pré-requisitos e servidores, a exigência de manter o mesmo worktree e branch e a parada após implementação e verificação. Ele deve proibir skills, agentes e configuração MCP posteriores, commits, pushes e PRs durante a implementação. Se faltar algum limite, peça um plano revisado ainda no modo **Plan** e examine a revisão antes de aprovar. -O Copilot começará a trabalhar na implementação. +## Aprovar o Autopilot explicitamente -> [!NOTE] -> Se o Copilot não começar a criar automaticamente o código necessário, você poderá solicitar isso com um prompt como "Go ahead and start building out the plan!". -> -> A criação das atualizações necessárias levará vários minutos. O agente edita e cria arquivos, escreve e executa testes e faz iterações. Este é um bom momento para refletir sobre o que você explorou até agora ou fazer uma pausa. +Somente depois que o plano revisado contiver seus requisitos e todos os limites de execução, selecione **Approve and implement with autopilot** nos controles de aprovação do plano, ou a opção explícita equivalente de Autopilot exibida na sua versão. Confirme que o indicador de modo mostra **Autopilot**. -## Revisar as alterações +A aprovação pode iniciar a execução imediatamente. Portanto, todo o escopo de implementação, as regras de segurança e os limites de parada precisam estar no plano revisado antes da aprovação; não dependa de adicioná-los em uma mensagem posterior quando a execução já começou. -Todo código gerado por IA precisa ser revisado antes do merge. Vamos revisar o código e executar o site para confirmar que tudo está correto. +O Autopilot pode escrever código e testes e iterar sobre falhas, mas essa permissão não autoriza concluir os próximos módulos do workshop. Um pré-requisito ausente é um bloqueio a resolver com aprovação, não uma verificação aprovada. -1. Selecione **Changes** no canto superior direito para abrir as alterações no código. +## Revisar e verificar a implementação - ![Abas do painel da sessão no aplicativo GitHub Copilot com uma seta apontando para a aba Changes](../../_images/app-select-changes.png) +1. Abra **Changes** e examine a implementação da filtragem e os testes. +2. Compare o resultado com a issue e os esclarecimentos aprovados, incluindo combinações de várias categorias e distribuidoras. Verifique se as funções auxiliares novas ou modificadas seguem o padrão de documentação da Lição 3. +3. Examine a saída real dos comandos das quatro verificações npm. Elas são executadas diretamente agora porque você ainda não criou a skill quality-checks. +4. Resolva falhas e execute novamente as verificações afetadas antes de aceitar a implementação. A configuração E2E do Playwright faz o build e serve uma prévia, podendo reutilizar um servidor local; confirme que o servidor testado pertence a este worktree, não a uma lição anterior. -2. Revise as alterações. Você deverá ver novos arquivos TypeScript e Astro, além de arquivos de teste. Observe que as novas funções auxiliares incluem comentários de documentação TSDoc e um comentário de cabeçalho do arquivo. O padrão de documentação integrado na Lição 3 foi aplicado automaticamente, sem que você precisasse solicitá-lo. -3. No painel de revisão à direita do aplicativo Copilot, selecione **Terminal**. Se não houver um botão **Terminal**, selecione **+** (identificado como **Open in panel**) e depois selecione **Terminal**. +## Verificar o recurso manualmente - ![Botão Terminal no painel de revisão do aplicativo GitHub Copilot](../../_images/app-terminal-screenshot.png) +Volte a sessão ao modo **Interactive** antes da revisão manual e mantenha-o para a Lição 5. -4. Digite o comando a seguir na janela do terminal para iniciar o servidor de desenvolvimento do aplicativo Web: +1. Abra **Terminal** no painel de revisão desta sessão. Se necessário, selecione **+** e depois **Terminal**. +2. Confirme que o terminal está no worktree de filtragem e execute: ```shell npm run dev ``` -5. Quando o servidor iniciar, o que levará apenas alguns instantes, abra uma janela do navegador. -6. Acesse http://localhost:4321. -7. Agora você deve ver filtros disponíveis na página inicial. -8. Se algo não estiver correto, peça ao Copilot que faça as atualizações. -9. Quando estiver tudo certo, volte à janela do terminal. -10. Selecione Ctrl+C para interromper o servidor de desenvolvimento. - -## Verificar o trabalho com a skill quality-checks +3. Abra no navegador a URL exibida por esse servidor, normalmente `http://localhost:4321`. Se a porta estiver ocupada, identifique seu responsável em vez de interromper um processo não relacionado ou presumir que o servidor existente contém suas alterações. +4. Exercite a seleção de categorias, a seleção de distribuidora e sua combinação conforme o comportamento aprovado. Verifique o acesso por teclado e os comportamentos acordados para limpeza dos filtros e resultados vazios. +5. Se algo falhar, solicite uma correção específica, revise o diff, execute novamente as verificações automatizadas afetadas e repita as verificações relevantes no navegador. +6. Volte ao terminal e pressione Control+C (Mac) ou Ctrl+C (Windows/Linux) para parar o servidor que você iniciou. Confirme que ele parou antes da execução E2E do próximo módulo. -Você poderia apenas examinar o diff e considerar o trabalho concluído, mas a equipe definiu um padrão de qualidade e uma maneira repetível de verificá-lo. +Esta é sua observação manual no navegador. A observação no navegador conduzida pelo agente via MCP vem na Lição 6. -As **skills de agente** permitem fornecer ao Copilot orientações sobre como executar tarefas repetíveis, como executar testes, gerar builds ou criar pull requests. Uma skill é uma pasta de instruções, scripts e recursos que o agente pode carregar sob demanda. [Agent Skills é um padrão aberto][agent-skills-repo] usado por vários agentes. Por isso, a mesma skill funciona no Copilot Chat em modo de agente, no agente de nuvem do Copilot, no Copilot CLI e no aplicativo GitHub Copilot. +## Salvar um checkpoint -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, formado por `name` e `description`, seguido pelas instruções em Markdown: +Após revisar as alterações e a verificação, autorize um commit local: -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +Revise o diff atual e crie um commit de checkpoint para a implementação da filtragem e seus testes. Mantenha esta mesma branch e worktree de filtragem. Não crie skills ou agentes, não configure MCP, não faça push nem abra um pull request. ``` -As skills também podem incluir subpastas com scripts, ativos e materiais de referência. A estrutura completa é descrita na [especificação de skills de agente][agent-skills-spec]. - -> [!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 ignorada. - -## Explorar a skill quality-checks - -Vamos explorar a skill para entender o que ela faz. - -1. Se o painel de revisão ainda não estiver visível, abra-o selecionando **Toggle review panel** no canto superior direito. - - ![Barra de ferramentas superior do aplicativo GitHub Copilot com uma seta apontando para o botão Toggle review panel à direita de Create PR](../../_images/app-2-review-panel.png) - -2. Selecione **+** para adicionar um novo item ao painel de revisão. -3. Selecione **File**. -4. Pesquise `SKILL.md`. -5. Selecione `SKILL.md .github/skills/quality-checks` na lista de arquivos para abri-lo. -6. Observe `name` e `description`. A descrição informa ao agente *quando* usar a skill: sempre que alterações no código precisarem ser testadas, verificadas por lint ou validadas antes de um commit, push ou merge. -7. Leia a skill. Observe que ela documenta qual script executa cada conjunto, como testes de unidade, testes de ponta a ponta do Playwright e ESLint, em que ordem e como depurar falhas comuns. Assim, o agente executa as verificações da maneira definida pela equipe, em vez de tentar adivinhar. - -## Executar as verificações - -Na mesma sessão de filtragem, peça ao agente que verifique o trabalho. Você não precisará nomear a skill, pois o agente a associará à sua solicitação. - -1. Volte ao aplicativo Copilot. -2. Chame diretamente a skill usando o comando de barra `/quality-checks` e selecione Enter. -3. Seguindo a skill, o agente executa os testes de unidade, o linter e os testes de ponta a ponta e relata os resultados. Se algo falhar, peça que ele corrija o problema e execute novamente as verificações até que tudo passe. -4. **Mantenha esta sessão aberta.** Na próxima lição, você adicionará o servidor MCP do Playwright e o usará para ver o recurso de filtragem funcionando em um navegador real. - ## Resumo e próximos passos -Você criou um recurso real de ponta a ponta e o verificou de acordo com o padrão da equipe. Especificamente, você: - -- iniciou uma nova sessão a partir da issue de filtragem em um projeto atualizado. -- usou o modo Plan para planejar o recurso e o Autopilot para criá-lo. -- confirmou que o código auxiliar gerado seguiu o padrão de documentação integrado na Lição 3. -- verificou o trabalho com a skill `quality-checks`. - -Em seguida, você conectará o servidor MCP do Playwright e pedirá ao agente que explore o recurso de filtragem em um navegador real. Continue para a [Lição 5 - Testar com o servidor MCP do Playwright][next-lesson]. +Você acordou os requisitos de filtragem, revisou a implementação e os testes e verificou o recurso manualmente. Este checkpoint faz parte do PR 3, não de um PR separado. Permaneça no modo **Interactive**, na mesma sessão, para a [Lição 5 - Criar e usar uma skill quality-checks][next-lesson]. ## Recursos - [Trabalhar com sessões de agente no aplicativo GitHub Copilot][agent-sessions] -- [Sobre Agent Skills][about-agent-skills] -- [Personalizar o aplicativo GitHub Copilot][customize-app] - [Sobre sandboxes locais e na nuvem para o GitHub Copilot][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification \ No newline at end of file diff --git a/docs/pt-br/app/5-agent-skills.md b/docs/pt-br/app/5-agent-skills.md new file mode 100644 index 00000000..5eff3dae --- /dev/null +++ b/docs/pt-br/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +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-09-11 +--- + +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. + +Nesta lição, você vai: + +- 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. + +## Cenário + +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. + +## Instruções, scripts e recursos + +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. + +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. + +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. + +## Criar a skill + +Volte a sessão de filtragem ao modo **Interactive** usando o seletor de modo 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. + +```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. + +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. + +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. + +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. +``` + +## Examinar a skill + +1. Abra **Changes** para revisar os arquivos gerados. Você também pode usar **+**, **File** no painel de revisão e pesquisar `SKILL.md` ou os nomes dos scripts. +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. + +> [!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. + +## Executar a skill + +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. + +Se o aplicativo 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. + +```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. + +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. +``` + +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. + +## Salvar um checkpoint + +Após revisar a skill e seus resultados, autorize um checkpoint local: + +```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 + +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 sessão com a [Lição 6 - Validar a funcionalidade com o MCP do Playwright][next-lesson]. + +## Mais exemplos de skills + +Estes exemplos da comunidade são referências, não tarefas adicionais. Revise seus pré-requisitos e comportamento antes de adotá-los: + +- [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]. + +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-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/app/5-mcp-playwright.md b/docs/pt-br/app/5-mcp-playwright.md deleted file mode 100644 index 1f9ea34e..00000000 --- a/docs/pt-br/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "Lição 5 - Testar com o servidor MCP do Playwright" -description: "Adicione o servidor MCP do Playwright ao aplicativo GitHub Copilot e peça ao agente que teste manualmente o recurso de filtragem em um navegador real." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Na lição anterior, você criou e verificou o recurso de filtragem com o conjunto de testes automatizados do projeto. Os testes automatizam a validação do código, mas permitir que o agente confirme o comportamento é uma abordagem eficiente. Assim, o agente pode responder a problemas identificados na própria interface que está criando. Vamos explorar como o MCP dá aos agentes de IA acesso a recursos externos e adicionar o servidor MCP do Playwright para permitir que o Copilot interaja diretamente com o site que você está desenvolvendo. - -Nesta lição, você vai: - -- entender o que é o Model Context Protocol (MCP) e como o aplicativo GitHub Copilot o utiliza. -- adicionar o servidor MCP do Playwright nas configurações do aplicativo. -- pedir ao agente que controle um navegador e explore o recurso de filtragem. - -## Cenário - -Embora os testes de unidade e de ponta a ponta sejam importantes, validar atualizações na interface exige interagir com ela. Você quer permitir que o Copilot use o site em desenvolvimento como uma pessoa usuária faria, automatizando ainda mais o processo de alteração e aumentando a confiança de que as atualizações se comportam conforme o esperado. - -## O que é o Model Context Protocol (MCP)? - -O [Model Context Protocol (MCP)][mcp-blog-post] oferece aos agentes de IA uma forma de se comunicar com ferramentas e serviços externos em tempo real. Isso permite que eles acessem informações atualizadas, usando recursos, e realizem ações em seu nome, usando ferramentas. - -Essas ferramentas e esses recursos são acessados por meio de um servidor MCP, que funciona como uma ponte entre o agente de IA e as ferramentas e os serviços externos. O servidor MCP é responsável por gerenciar essa comunicação, seja com APIs existentes ou com 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 conhecidos são: - -- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): oferece acesso a um conjunto de APIs para gerenciar repositórios do GitHub. Ele permite que o agente de IA realize ações como criar repositórios, atualizar repositórios existentes e gerenciar issues e pull requests. -- [**Playwright MCP Server**][playwright-mcp-server]: oferece recursos de automação de navegador usando o Playwright. Ele permite que o agente de IA realize ações como acessar páginas Web, preencher formulários e selecionar botões. - -Há muitos outros servidores MCP que fornecem acesso a diferentes ferramentas e recursos. O GitHub mantém um [registro de MCP](https://github.com/mcp) para facilitar a descoberta e as contribuições ao ecossistema. - -> [!CAUTION] -> Trate os servidores MCP como qualquer outra dependência do projeto. Antes de usar um servidor MCP, revise cuidadosamente o código-fonte, verifique quem o publicou e considere as implicações de segurança. Use apenas servidores MCP confiáveis e tenha cuidado ao conceder acesso a recursos ou operações confidenciais. - -## Adicionar o servidor MCP do Playwright - -Você adiciona e gerencia servidores MCP nas configurações do aplicativo. O aplicativo inclui um catálogo de servidores conhecidos, portanto o [servidor MCP do Playwright][playwright-mcp-server] está a poucas seleções de distância. - -1. Selecione Ctrl+, para abrir a página de configurações do aplicativo Copilot. -2. Selecione **MCP servers**. -3. Na caixa de diálogo de pesquisa, digite `Playwright`. -4. Selecione **Playwright** na lista de **Popular MCP servers**. -5. Selecione **Add server** para adicioná-lo à lista de servidores MCP disponíveis. -6. Selecione Esc para fechar a caixa de diálogo de configurações. - -Você adicionou o servidor MCP do Playwright. - -## Pedir ao Copilot que explore o recurso com o Playwright - -Vamos pedir ao Copilot que teste manualmente o recurso usando o servidor MCP do Playwright. - -1. Use o prompt a seguir para pedir ao Copilot que valide a nova funcionalidade: - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -O Copilot iniciará um navegador por meio do servidor MCP do Playwright, percorrerá cada etapa e relatará o que encontrou. Você verá um navegador ser aberto no sistema para executar as tarefas. - -2. Leia o resumo e compare-o aos critérios de aceitação da issue. Se algo parecer incorreto, faça perguntas complementares ou peça que o agente corrija o código antes de abrir um pull request. -3. Mantenha esta sessão aberta, pois vamos concluí-la na próxima lição. - -O Copilot também validou a funcionalidade no navegador, explorando o recurso como uma pessoa usuária faria. - -## Resumo e próximos passos - -Parabéns! Você usou o servidor MCP do Playwright para explorar o recurso em um navegador real a partir do aplicativo GitHub Copilot. Recapitulando, você: - -- aprendeu o que é o Model Context Protocol (MCP) e como o aplicativo disponibiliza ferramentas MCP. -- adicionou o servidor MCP do Playwright nas configurações do aplicativo. -- pediu ao agente que controlasse um navegador e explorasse o recurso de filtragem. - -O recurso está criado, verificado e funcionando. Agora é hora de entregá-lo usando o **Agent Merge** para abrir e fazer o merge do pull request. Continue para a [Lição 6 - Fazer merge com o Agent Merge][next-lesson]. - -## Recursos - -- [O que é MCP e por que todos estão falando sobre ele?][mcp-blog-post] -- [Servidor MCP do Microsoft Playwright][playwright-mcp-server] -- [Configurar servidores MCP no aplicativo GitHub Copilot][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/6-agent-merge.md b/docs/pt-br/app/6-agent-merge.md deleted file mode 100644 index 44e61b3d..00000000 --- a/docs/pt-br/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "Lição 6 - Fazer merge com o Agent Merge" -description: "Abra o pull request de filtragem, revise-o em My work e permita que o Agent Merge corrija o que estiver bloqueando e faça o merge para você, no nível mais alto da automação de merge." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -O recurso de filtragem está criado, verificado e funcionando em um navegador. A última etapa é fazer o merge. Você já fez isso duas vezes neste percurso. Nas duas ocasiões, abriu o pull request e fez o merge por conta própria no github.com. Desta vez, o aplicativo fará o trabalho operacional com o **Agent Merge**, que conduz todo o ciclo de vida de um pull request dentro do aplicativo. - -Nesta lição, você vai: - -- aprender o que é o Agent Merge e como ele automatiza o ciclo de vida do merge. -- habilitar o Agent Merge na sessão de filtragem. -- observar como ele cria o pull request, executa a CI e faz o merge quando todas as verificações passam. - -## Cenário - -Nos últimos módulos, você explorou vários níveis de automação, desde a criação de código até permitir que o Copilot valide diretamente uma interface. Para acelerar ainda mais o desenvolvimento, a Tailspin Toys quer descobrir se pull requests já avaliados e validados podem ter o merge feito automaticamente. - -## Apresentação do Agent Merge - -O **Agent Merge** permite automatizar a etapa final de integração de um pull request por meio do aplicativo Copilot. Quando você o habilita, a sessão do aplicativo lê o pull request, resolve o que estiver bloqueando o merge, como verificações de CI com falha, comentários de revisão e a necessidade de rebase, e faz o merge assim que o GitHub permite. Ele é executado em segundo plano, continua funcionando após reinicializações do aplicativo e é desativado automaticamente quando o pull request é integrado. - -Até aqui, você selecionou **Merge pull request** no github.com. O Agent Merge transfere essa responsabilidade ao agente, permitindo que você passe para a próxima tarefa enquanto ele conduz o PR até a conclusão. Você ainda revisa e aprova o trabalho; o agente apenas cuida das etapas operacionais finais. - -## Usar o Agent Merge para gerenciar o PR - -Você revisou o código manualmente, executou testes e permitiu que o Copilot validasse a interface. Agora é hora de integrar o novo código à base de código. Vamos permitir que o Agent Merge conduza o PR pela integração contínua (CI) e faça o merge. - -1. Volte à sessão mantida aberta no módulo anterior, na qual você estava adicionando a funcionalidade de filtragem. -2. No canto superior direito, selecione o menu suspenso ao lado de **Create PR**. -3. Selecione **Agent merge** para habilitá-lo. - - ![Menu suspenso Create PR expandido no aplicativo GitHub Copilot, com uma seta apontando para a opção Agent merge](../../_images/app-enable-agent-merge.png) - -4. O texto do botão mudará para **Agent merge**. -5. Selecione o botão **Agent merge** para iniciar o processo. - -O aplicativo Copilot começará a criar e gerenciar o PR. Primeiro, ele explora o projeto para determinar a melhor maneira de criar um PR e depois cria o novo PR. - -Após alguns instantes, você verá que o Copilot voltou a trabalhar, agora analisando as condições do PR, incluindo o processo de CI que executa todos os testes do repositório. Ele informará o status das revisões deixadas por outras pessoas da equipe, das verificações que precisam ser executadas e da possibilidade de fazer o merge do PR. - -6. Permita que o Agent Merge faça o merge do pull request selecionando o menu suspenso ao lado de **Agent merge** e depois **Merge pull request**. - - ![Menu suspenso Agent merge mostrando as ações permitidas ao agente — Address reviews, Fix CI failures, Resolve conflicts — com uma seta apontando para Merge pull request](../../_images/app-agent-merge-merge.png) - -7. Quando todos os processos de CI estiverem verdes, indicando que os testes passaram, o Copilot fará o merge do pull request. - -## Resumo e próximos passos - -Você automatizou várias partes do processo de desenvolvimento, incluindo a geração, o teste e a validação de código e, agora, o processo de pull request. Você: - -- aprendeu o que é o Agent Merge e como ele automatiza o ciclo de vida do merge. -- habilitou o Agent Merge na sessão de filtragem. -- observou como ele criou o pull request, executou a CI e fez o merge quando todas as verificações passaram. - -Em seguida, você explorará **canvases**, uma maneira mais completa de planejar e visualizar o trabalho com o agente. Continue para a [Lição 7 - Planejar com canvases][next-lesson]. - -## Recursos - -- [Gerenciar issues e pull requests com o aplicativo GitHub Copilot][managing-issues-prs] -- [Sobre o aplicativo GitHub Copilot][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/6-mcp-playwright.md b/docs/pt-br/app/6-mcp-playwright.md new file mode 100644 index 00000000..86ef1bac --- /dev/null +++ b/docs/pt-br/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "Lição 6 - Validar a funcionalidade com o MCP do Playwright" +description: "Configure o MCP do Playwright pelo Customize e observe a filtragem no navegador, no worktree existente do recurso." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Na lição anterior, você reuniu e executou as verificações do projeto por meio da skill quality-checks. Agora dê ao agente acesso a um navegador para observar diretamente a interface de filtragem. Permaneça na mesma sessão, worktree e branch de filtragem. Esta lição acrescenta evidências do navegador, não outro recurso, uma nova execução de toda a suíte de testes ou um PR. + +Nesta lição, você vai: + +- entender o que é o Model Context Protocol (MCP) e como o aplicativo GitHub Copilot o utiliza. +- adicionar o servidor MCP do Playwright pelo **Customize**. +- pedir ao agente que controle um navegador e explore o recurso de filtragem. + +## Cenário + +Embora os testes de unidade e de ponta a ponta sejam importantes, validar atualizações na interface exige interagir com ela. Você quer permitir que o Copilot use o site em desenvolvimento como uma pessoa usuária faria, automatizando ainda mais o processo de alteração e aumentando a confiança de que as atualizações se comportam conforme o esperado. + +## O que é o Model Context Protocol (MCP)? + +O [Model Context Protocol (MCP)][mcp-blog-post] oferece aos agentes de IA uma forma de se comunicar com ferramentas e serviços externos em tempo real. Isso permite que eles acessem informações atualizadas, usando recursos, e realizem ações em seu nome, usando ferramentas. + +Essas ferramentas e esses recursos são acessados por meio de um servidor MCP, que funciona como uma ponte entre o agente de IA e as ferramentas e os serviços externos. O servidor MCP é responsável por gerenciar essa comunicação, seja com APIs existentes ou com 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 conhecidos são: + +- [**GitHub MCP Server**](https://github.com/github/github-mcp-server): oferece acesso a um conjunto de APIs para gerenciar repositórios do GitHub. Ele permite que o agente de IA realize ações como criar repositórios, atualizar repositórios existentes e gerenciar issues e pull requests. +- [**Playwright MCP Server**][playwright-mcp-server]: oferece recursos de automação de navegador usando o Playwright. Ele permite que o agente de IA realize ações como acessar páginas Web, preencher formulários e selecionar botões. + +Há muitos outros servidores MCP que fornecem acesso a diferentes ferramentas e recursos. O GitHub mantém um [registro de MCP](https://github.com/mcp) para facilitar a descoberta e as contribuições ao ecossistema. + +> [!CAUTION] +> Trate os servidores MCP como qualquer outra dependência do projeto. Antes de usar um servidor MCP, revise cuidadosamente o código-fonte, verifique quem o publicou e considere as implicações de segurança. Use apenas servidores MCP confiáveis e tenha cuidado ao conceder acesso a recursos ou operações confidenciais. + +## Adicionar o servidor MCP do Playwright + +A [documentação atual de personalização do aplicativo][customize-app] usa **Customize** na barra lateral para descobrir e gerenciar MCP. Servidores MCP configurados para seus repositórios ou para o Copilot CLI já podem estar disponíveis no aplicativo; examine os servidores instalados antes de adicionar um duplicado. + +1. Selecione **Customize** na barra lateral. +2. Selecione **MCP** e verifique em **Installed** se já existe um servidor Playwright. +3. Se necessário, encontre **Playwright** entre os servidores disponíveis ou use o fluxo de servidor personalizado documentado pelo publicador. +4. Revise o publicador, a configuração e as solicitações de instalação antes de aprová-las. Siga as instruções para adicionar o servidor; políticas da organização ou pré-requisitos ausentes podem bloquear a configuração. +5. Volte à sessão de filtragem existente e mantenha o modo **Interactive**. Confirme que as ferramentas de navegador do MCP do Playwright estão disponíveis antes de solicitar a validação. Não crie um novo worktree do recurso como solução alternativa de configuração. + +Se a configuração falhar, resolva o problema de configuração ou permissão em vez de aceitar uma afirmação de que o agente navegou sem ferramentas. A visibilidade do navegador depende da configuração do servidor; a atividade real das ferramentas e as observações são as evidências. + +## Pedir ao Copilot que explore o recurso com o Playwright + +Use a URL real da issue e os esclarecimentos aprovados salvos na Lição 4. Pare qualquer servidor de desenvolvimento manual das lições anteriores antes de o agente iniciar o próprio servidor. Ele deve identificar a cópia de trabalho e o servidor em teste. + +1. Use o prompt a seguir para pedir ao Copilot que valide a nova funcionalidade: + + ```plaintext + Use o servidor MCP do Playwright configurado para observar o recurso de filtragem conforme esta issue: . Estes são meus esclarecimentos de planejamento aprovados: . Permaneça neste worktree e branch de filtragem. + + Identifique a cópia de trabalho, inicie seu servidor de desenvolvimento e use ferramentas reais de navegador para exercitar a seleção de várias categorias, a filtragem por distribuidora, a filtragem combinada, os controles acessíveis e qualquer comportamento acordado de limpeza de filtros ou resultados vazios. Relate observações em relação aos critérios, incluindo falhas ou verificações bloqueadas. Não afirme comportamentos que não observou. + + Esta etapa é uma observação no navegador, não outra execução automatizada completa de testes. Não altere código da aplicação, testes, skills ou perfis de agente, não faça commit, push nem crie um PR. Relate ferramentas MCP ou pré-requisitos ausentes como bloqueios e pergunte antes de instalar qualquer coisa. Não reutilize o servidor de outra cópia de trabalho nem interrompa processos não relacionados. Ao terminar, pare apenas o servidor que você iniciou. + ``` + +Examine as chamadas de ferramentas MCP do Playwright, a URL em teste e as observações relatadas do navegador. Uma narrativa baseada apenas no código-fonte ou em resultados E2E anteriores não demonstra o uso de MCP. + +2. Compare o resumo com a issue e os esclarecimentos aprovados. Se houver um defeito, autorize uma correção específica separadamente, revise o diff alterado e repita as verificações automatizadas e observações do navegador relevantes. Evidências anteriores à correção não comprovam a revisão resultante. +3. Confirme que o agente parou o próprio servidor. Mantenha esta sessão de filtragem aberta e permaneça no modo **Interactive** antes de criar o perfil QA na Lição 7. + +Esta etapa estabelece observação direta, não substitui a cobertura automatizada. Falhas ou observações bloqueadas permanecem visíveis para o QA. + +## Resumo e próximos passos + +Parabéns! Você usou o servidor MCP do Playwright para explorar o recurso em um navegador real a partir do aplicativo GitHub Copilot. Recapitulando, você: + +- aprendeu o que é o Model Context Protocol (MCP) e como o aplicativo disponibiliza ferramentas MCP. +- configurou o servidor MCP do Playwright pelo **Customize**. +- pediu ao agente que controlasse um navegador e explorasse o recurso de filtragem. + +Em seguida, reúna os requisitos, as observações do navegador, a cobertura e a skill em um perfil especializado. Continue nesta mesma sessão para a [Lição 7 - Criar e usar um agente QA][next-lesson]. Não crie o PR do recurso ainda. + +## Recursos + +- [O que é MCP e por que todos estão falando sobre ele?][mcp-blog-post] +- [Servidor MCP do Microsoft Playwright][playwright-mcp-server] +- [Configurar servidores MCP no aplicativo GitHub Copilot][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/7-canvases.md b/docs/pt-br/app/7-canvases.md deleted file mode 100644 index abbd6aa6..00000000 --- a/docs/pt-br/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "Lição 7 - Planejar com canvases" -description: "Crie um canvas compartilhado e orientado por agentes no aplicativo GitHub Copilot para planejar e acompanhar seu trabalho junto com o agente." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Até agora, você orientou agentes pelo chat. No entanto, grande parte do trabalho não acontece em uma conversa, mas em um quadro, documento ou checklist. Os **canvases** oferecem a você e ao agente uma superfície compartilhada exatamente para esse tipo de trabalho, dentro do aplicativo. Nesta lição, você criará um canvas simples para planejar e acompanhar o backlog no qual vem trabalhando. - -Nesta lição, você vai: - -- entender o que é um canvas e quando usá-lo. -- criar um canvas compartilhado de quadro Kanban para fazer a triagem do backlog. -- salvar o canvas no repositório e integrá-lo para a equipe. -- abrir o canvas em uma nova sessão e começar a trabalhar a partir dele. - -## Cenário - -Analisar uma lista de issues pode ser uma tarefa desafiadora, mesmo nas melhores condições. As pessoas desenvolvedoras da Tailspin Toys procuram uma ferramenta que permita fazer rapidamente a triagem de issues e começar a trabalhar nelas no aplicativo Copilot. - -## O que é um canvas? - -Um [canvas][canvas-docs] é uma superfície interativa e compartilhada para um artefato de trabalho, como um plano, um quadro de triagem, um checklist de lançamento, um painel ou um documento. Embora o chat seja ótimo para descrever intenções e analisar ambiguidades, a maior parte do trabalho acontece em uma *superfície*. Os canvases permitem colaborar com o agente diretamente nessa superfície. - -Os canvases são **bidirecionais**: o agente pode atualizar o canvas enquanto trabalha, e você pode editar a mesma superfície. Quando você cria um canvas, o agente o desenvolve com base no prompt e no fluxo de trabalho. Você pode pedir que ele adicione, remova ou revise recursos durante o processo. Depois de criado, o canvas é aberto no painel direito do aplicativo. - -Alguns exemplos comuns incluem: - -- **Canvases Markdown** para planejar o dia e priorizar issues e pull requests. -- **Quadros Kanban agênticos** nos quais pessoas e agentes adicionam cards e movem o trabalho entre colunas. -- **Quadros de triagem de issues** que resumem as principais issues e os temas recorrentes de um repositório. - -## Por que usar um canvas? - -Use um canvas quando uma tarefa exigir estrutura, iteração e verificação e o chat não for suficiente. Um canvas permite: - -- fundamentar o trabalho do agente em um artefato real adequado ao seu fluxo de trabalho. -- orientar ou corrigir o trabalho diretamente na superfície compartilhada e depois permitir que o agente continue a partir das suas alterações. -- acompanhar o progresso como alterações visíveis em um artefato, e não apenas como respostas no chat. - -## Criar um canvas para acompanhar o trabalho - -Você já entregou muitos recursos: a avaliação por estrelas, o padrão de documentação e o recurso de filtragem foram integrados. No entanto, ainda há itens no backlog. Vamos criar um canvas para ajudar a fazer rapidamente a triagem do trabalho. - -1. Volte ao aplicativo GitHub Copilot ou abra-o. -2. Selecione **Home screen**. -3. Verifique se `tailspin-toys` está selecionado como repositório. -4. Na caixa de prompt, use o prompt a seguir para criar um canvas que atenda às nossas necessidades: - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -O Copilot começará a criar o canvas. - -> [!NOTE] -> A criação levará alguns minutos. Como essa é uma tarefa complexa, talvez a primeira versão não atenda a todas as suas expectativas. Você pode continuar enviando prompts para criar a ferramenta ideal para suas necessidades. - -## Salvar o canvas e integrá-lo ao repositório - -Os canvases podem se tornar ativos do repositório, assim como arquivos de instruções e skills. Vamos pedir ao Copilot que adicione o canvas ao repositório e faça o merge para que toda a equipe possa usá-lo. - -1. Na mesma sessão, peça ao Copilot que salve o canvas no repositório usando o prompt a seguir: - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Depois que o Copilot salvar os arquivos do canvas, selecione o menu suspenso ao lado de **Create PR** no canto superior direito. -3. Selecione **Agent merge** para habilitá-lo. - - ![Menu suspenso Create PR expandido no aplicativo GitHub Copilot, com uma seta apontando para a opção Agent merge](../../_images/app-enable-agent-merge.png) - -4. O texto do botão mudará para **Agent merge**. -5. Selecione o botão **Agent merge** para iniciar o processo. - -O aplicativo Copilot começará a criar e gerenciar o PR. Primeiro, ele explora o projeto para determinar a melhor maneira de criar um PR e depois cria o pull request. - -Após alguns instantes, você verá que o Copilot voltou a trabalhar, agora analisando as condições do PR, incluindo o processo de CI que executa todos os testes do repositório. Ele informará o status das revisões deixadas por outras pessoas da equipe, das verificações que precisam ser executadas e da possibilidade de fazer o merge do PR. - -6. Permita que o Agent Merge faça o merge do pull request selecionando o menu suspenso ao lado de **Agent merge** e depois **Merge pull request**. - - ![Menu suspenso Agent merge mostrando as ações permitidas ao agente — Address reviews, Fix CI failures, Resolve conflicts — com uma seta apontando para Merge pull request](../../_images/app-agent-merge-merge.png) - -7. Aguarde até que todos os processos de CI sejam concluídos com êxito e fiquem verdes. Quando isso acontecer, o Copilot fará o merge do pull request automaticamente. - -Você criou um novo canvas compartilhado para a equipe. - -## Trabalhar no canvas - -Com o canvas criado, vamos iniciar uma nova sessão e usá-lo. - -1. No aplicativo Copilot, inicie uma nova sessão selecionando **New session** ao lado de **tailspin-toys**. -2. Peça ao Copilot que abra o canvas de triagem usando o prompt a seguir: - - ```plaintext - Open the triage issues canvas - ``` - -3. O canvas criado será aberto nessa nova sessão. -4. Selecione **Add to current context** em uma das issues que mais lhe interessam. -5. O Copilot começará a trabalhar na issue. - -Você usou um canvas criado por você para otimizar o processo de desenvolvimento. - -## Resumo e próximos passos - -Você criou uma superfície compartilhada na qual você e o agente podem colaborar. Você: - -- aprendeu o que são canvases e quando usá-los. -- criou com o agente um canvas compartilhado de quadro Kanban para triagem. -- salvou o canvas no repositório e fez o merge dele com o Agent Merge. -- abriu o canvas em uma nova sessão e o usou para começar a trabalhar. - -Com o backlog acompanhado, é hora de revisar tudo o que você criou e decidir os próximos passos. Continue para a [Lição 8 - Revisão e próximos passos][next-lesson]. - -## Recursos - -- [Trabalhar com extensões de canvas no aplicativo GitHub Copilot][canvas-docs] -- [Canvases no Awesome Copilot][awesome-copilot-canvases] -- [Sobre o aplicativo GitHub Copilot][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/7-qa-agent.md b/docs/pt-br/app/7-qa-agent.md new file mode 100644 index 00000000..9257a502 --- /dev/null +++ b/docs/pt-br/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +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-14 +--- + +Nas lições anteriores, você criou uma skill quality-checks e deu ao Copilot acesso a um navegador pelo MCP do Playwright. Agora reúna essas capacidades com um **agente personalizado de QA** que revise o recurso de filtragem em relação aos requisitos. + +Nesta lição, você vai: + +- entender como um agente personalizado trabalha com instruções, skills e ferramentas MCP. +- criar e examinar um perfil de QA reutilizável. +- selecionar o agente de QA e revisar suas conclusões em relação à issue de filtragem. +- salvar o perfil e quaisquer testes justificados para o PR do recurso. + +## Cenário + +A Tailspin Toys está se preparando para lançar a filtragem por categoria e editora. As verificações automatizadas e a exploração no navegador forneceram evidências úteis à equipe, mas passar nos testes não demonstra, por si só, que todos os requisitos acordados estão cobertos. Antes de abrir o PR, a equipe quer uma revisão focada do que foi solicitado, do que foi implementado e do que ainda precisa de atenção. + +Você criará um agente de QA que parte da issue e das decisões de planejamento aprovadas, examina a cobertura e usa a skill e as ferramentas do navegador para reunir evidências. Seu papel é identificar lacunas e explicar se o recurso está pronto para revisão, não aprovar o próprio trabalho nem integrar o PR. + +## O que é um agente personalizado? + +Um agente personalizado é um papel especializado reutilizável definido em um perfil Markdown. Suas instruções orientam como o Copilot aborda uma tarefa; selecionar o perfil aplica esse papel à conversa. Neste workshop, você definirá o papel em `.github/agents/qa.agent.md` e o selecionará no aplicativo. + +As personalizações que você criou têm funções distintas. As instruções do repositório descrevem os padrões da equipe. A skill quality-checks reúne verificações repetíveis. O MCP do Playwright fornece ferramentas de navegador. O perfil de QA informa ao Copilot como usar essas capacidades para avaliar requisitos e relatar conclusões. Ele não as substitui nem exige outra sessão de agente. + +## Criar o perfil de QA + +Continue na sessão de filtragem da Lição 6, mantendo o mesmo worktree e branch. Confirme que a sessão está no modo **Interactive**, que a skill quality-checks está presente e que o MCP do Playwright está disponível. O PR do recurso vem na Lição 8; esta lição adiciona um perfil e, apenas quando necessário, testes. + +Envie o prompt a seguir ao agente padrão do Copilot. Você examinará o arquivo resultante antes de selecionar QA: + +```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 + +1. Abra **Changes** e selecione `.github/agents/qa.agent.md`. Você também pode encontrá-lo no painel de revisão de arquivos. +2. Leia o frontmatter. `description` é obrigatório, e `name: QA` torna o perfil reconhecível no seletor. Deixe `model` e `tools` sem especificar neste exercício para usar o modelo selecionado e as ferramentas disponíveis; as permissões normais continuam valendo. +3. Leia as instruções como uma lista de revisão: elas partem dos requisitos, usam a skill e as ferramentas do navegador, adicionam testes apenas para lacunas reais e distinguem falhas de verificações bloqueadas? +4. Peça ao Copilot que corrija as lacunas antes de selecionar o perfil. Confirme que ele criou a definição sem iniciar QA nem alterar a aplicação. + +> [!NOTE] +> Um perfil especializado orienta o comportamento; ele não garante um resultado correto. Você ainda precisa examinar a atividade das ferramentas, as alterações nos testes e o relatório do agente. + +## 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. Mantenha a mesma cópia de trabalho e branch de filtragem. + +1. Na sessão atual, abra o seletor de agentes na caixa do prompt ou digite `/agent`, conforme a [documentação de personalização do aplicativo][customize-app]. +2. Selecione **QA** e verifique se o aplicativo identifica visivelmente **QA** como agente ativo antes de enviar o prompt de execução. +3. Se **QA** não estiver listado ou você não conseguir confirmar que está ativo, pause e peça ajuda à pessoa que conduz o workshop, mantendo este worktree e branch. Não crie outra sessão de recurso, não invente uma sequência de recarga nem substitua esta etapa por um pedido ao agente padrão para ler `qa.agent.md`. + +O seletor documentado está disponível durante uma sessão, mas a descoberta de um perfil de repositório recém-criado pode depender da versão do aplicativo. Não trate a criação do arquivo como prova de ativação. + +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 + +Leia o relatório junto com a issue de filtragem e os esclarecimentos aprovados: + +1. Verifique se cada critério está conectado a testes adequados e comportamento observável. Por exemplo, combinar categorias e uma editora exige evidências sobre os jogos retornados, não apenas sobre a resposta dos controles. +2. Examine a atividade real das ferramentas MCP do Playwright e confirme que o servidor testado pertence a esta cópia de trabalho. As verificações no navegador e E2E automatizadas não devem reutilizar um servidor desatualizado ou outra cópia de trabalho. +3. Revise os resultados de lint, testes de unidade, testes E2E e verificações de tipos. As quatro verificações devem usar os scripts da skill quality-checks; um resumo de comandos planejados não é execução. +4. Abra **Changes** para examinar os testes adicionados e compará-los com as lacunas do relatório. + +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 + +O papel de QA é verificar, então volte ao agente padrão antes de solicitar um commit: + +1. Mantenha o relatório de QA, a URL da issue, os esclarecimentos aprovados e a revisão testada disponíveis para a lição sobre o PR. +2. Na mesma sessão, use o seletor de agentes para voltar ao agente padrão do Copilot e confirme que **QA** não está mais selecionado. +3. Mantenha o mesmo worktree e branch. Se não encontrar a opção do agente padrão, peça ajuda à pessoa que conduz o workshop em vez de iniciar outra sessão de recurso ou enviar instruções de commit ao QA. + +Após revisar o perfil, quaisquer alterações de testes e as evidências resultantes, envie a solicitação de checkpoint ao agente padrão com esse contexto de QA: + +```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ê adicionou um papel especializado reutilizável ao fluxo de trabalho e revisou o trabalho dele. Nesta lição, você: + +- criou e examinou um perfil de QA que parte dos requisitos. +- selecionou o perfil para avaliar a cobertura e reunir evidências pela skill e pelo MCP do Playwright. +- revisou as conclusões e salvou o perfil com quaisquer alterações justificadas nos testes na branch de filtragem. + +Agora você tem os elementos para revisar o recurso: a implementação, a skill, o perfil de QA, os testes e o relatório de verificação. Leve adiante os achados não resolvidos; um resultado com falha ou bloqueado não autoriza a integração. Continue na [Lição 8 - Criar e integrar o PR do recurso][next-lesson] para revisar o marco completo e usar Agent Merge. + +## Recursos + +- [Personalização do aplicativo GitHub Copilot, incluindo a seleção de agentes personalizados][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/pt-br/app/8-create-pull-request.md b/docs/pt-br/app/8-create-pull-request.md new file mode 100644 index 00000000..34372126 --- /dev/null +++ b/docs/pt-br/app/8-create-pull-request.md @@ -0,0 +1,89 @@ +--- +title: "Lição 8 - Criar e integrar o PR do recurso" +description: "Revise a filtragem, a skill, o perfil QA e os testes em conjunto, crie o PR 3 e autorize explicitamente o Agent Merge." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +A implementação da filtragem, a skill quality-checks, o perfil QA e os testes associados estão salvos em commits de checkpoint em uma única branch. Revise-os em conjunto e use as evidências atuais de QA para preparar o PR 3. Você já fez o merge explicitamente dos PRs de avaliações por estrelas e instruções. Desta vez, usará o **Agent Merge** dentro do fluxo de PR, não como um recurso ou uma branch separados. + +Nesta lição, você vai: + +- aprender o que é o Agent Merge e como ele automatiza o ciclo de vida do merge. +- examinar o PR completo do recurso e as evidências de verificação. +- autorizar o Agent Merge somente após a revisão e confirmar que o PR foi integrado. + +## Cenário + +Nos últimos módulos, você explorou vários níveis de automação, desde a criação de código até permitir que o Copilot valide diretamente uma interface. Para acelerar ainda mais o desenvolvimento, a Tailspin Toys quer descobrir se pull requests já avaliados e validados podem ter o merge feito automaticamente. + +## Apresentação do Agent Merge + +O **Agent Merge** permite automatizar a etapa final de integração de um pull request por meio do aplicativo Copilot. Quando você o habilita, a sessão do aplicativo lê o pull request, resolve o que estiver bloqueando o merge, como verificações de CI com falha, comentários de revisão e a necessidade de rebase, e faz o merge assim que o GitHub permite. Ele é executado em segundo plano, continua funcionando após reinicializações do aplicativo e é desativado automaticamente quando o pull request é integrado. + +Até aqui, você selecionou **Merge pull request** por conta própria. O Agent Merge pode assumir essa responsabilidade, mas sua capacidade de editar código e fazer merge ainda exige autorização explícita. Revise as ações permitidas e o trabalho antes de conceder permissão de merge. + +## Revisar o marco completo + +Permaneça na sessão de filtragem das Lições 4–7. Verifique o diff completo da branch em relação a `main`, não apenas o último checkpoint: ele deve conter a filtragem, `.github/skills/quality-checks/SKILL.md`, os scripts incluídos, `.github/agents/qa.agent.md` e os testes associados. + +Use o seletor de agentes para voltar de **QA** ao agente geral do Copilot antes de solicitar commits ou ações de PR e mantenha o modo **Interactive**. O trabalho do perfil QA era verificar, não entregar. Mudar o agente selecionado não deve mudar a sessão, a cópia de trabalho ou a branch de filtragem. + +Este workshop combina deliberadamente o trabalho do recurso e a infraestrutura reutilizável de qualidade em um PR. Uma equipe de produção poderia separá-los; aqui, os commits de checkpoint preservam etapas revisáveis sem branches empilhadas ou PRs adicionais. + +Revise o relatório de QA da Lição 7. Reutilize suas evidências apenas se cobrirem a revisão final a ser enviada, com as quatro verificações e as observações relevantes no navegador concluídas. Se alterações de código, conflitos ou correções de CI modificarem o que foi testado, repita as verificações e observações afetadas e atualize as evidências. Um relatório **NO-GO** com falhas ou bloqueios não é aprovação de merge. + +Quando o diff e as evidências estiverem prontos, envie: + +```plaintext +Revise o diff completo da branch de filtragem em relação a main, incluindo o recurso de filtragem, a skill quality-checks e seus scripts, a definição do agente QA e os testes associados. Resuma os critérios da issue, os esclarecimentos aprovados e as evidências atuais de QA. Reutilize a verificação apenas se ela ainda se aplicar à revisão final; relate evidências desatualizadas, ausentes ou com falhas antes de prosseguir. + +Se as alterações revisadas e a verificação estiverem prontas, faça commit de quaisquer alterações aprovadas restantes do marco, envie esta branch e crie um único PR do recurso destinado a main, usando o modelo de PR do repositório e a URL real da issue de filtragem. Mantenha o histórico de checkpoints nesta branch. Não use uma skill de contribuição, não crie outra branch ou PR nem faça o merge ainda. +``` + +Abra o PR em **My work** e examine **Files changed**, a descrição, as revisões e os resultados das verificações. Examine os próprios arquivos de fluxo de trabalho do Tailspin Toys e as verificações obrigatórias; não presuma que toda verificação local ou observação do navegador é executada na CI. O build Astro e o verificador de links que publicam o workshop pertencem a outro repositório e não validam este recurso. + +## Usar o Agent Merge para gerenciar o PR + +Após revisar o PR existente, configure o Agent Merge nesta mesma sessão. Não crie um segundo PR. + +1. Volte à sessão de filtragem e confirme que ela está vinculada ao PR 3. +2. Abra o menu suspenso de ações de PR no canto superior direito. Antes de existir um PR, ele fica ao lado de **Create PR**; o rótulo pode mudar quando um PR está vinculado. +3. Selecione **Agent merge** para habilitá-lo. +4. Revise as permissões disponíveis, incluindo **Address reviews**, **Fix CI failures**, **Resolve conflicts** e **Merge pull request**. Mantenha a permissão de merge desativada enquanto houver achados ou verificações pendentes. +5. Antes de iniciá-lo, envie o escopo e a autorização a seguir e selecione **Agent merge**: + + ```plaintext + Gerencie este PR de filtragem existente com o Agent Merge. Resolva bloqueios de revisão ou CI apenas dentro do escopo deste PR. Não enfraqueça testes ou requisitos e pergunte antes de alterações não relacionadas ou instalações. Qualquer alteração na revisão testada exige atualizar as verificações relevantes e as evidências do navegador; não trate resultados antigos de QA como prova de código alterado. + + Não faça o merge até eu habilitar explicitamente Merge pull request após revisar o diff final e as evidências. Não crie outro PR nem comece a tarefa do canvas. + ``` + +6. Revise as alterações posteriores e os resultados atualizados. Quando o diff final estiver aprovado, a CI e as revisões obrigatórias passarem e as evidências de QA se aplicarem àquela revisão, autorize explicitamente o merge selecionando o menu suspenso ao lado de **Agent merge** e depois **Merge pull request**. + + ![Menu suspenso Agent merge mostrando as ações permitidas ao agente — Address reviews, Fix CI failures, Resolve conflicts — com uma seta apontando para Merge pull request](../../_images/app-agent-merge-merge.png) + +7. Confirme que o GitHub mostra o PR 3 como **Merged**, não apenas apto para merge ou na fila. O Agent Merge não contorna proteções do repositório nem permissões ausentes; resolva esses bloqueios antes de continuar. + +Somente após esse merge você deve iniciar o marco do canvas. A Lição 9 cria um worktree novo e avança sua branch de sessão por fast-forward até o `origin/main` mais recente para que o canvas comece com o recurso completo integrado. + +## Resumo e próximos passos + +Você automatizou várias partes do processo de desenvolvimento, incluindo a geração, o teste e a validação de código e, agora, o processo de pull request. Você: + +- aprendeu o que é o Agent Merge e como ele automatiza o ciclo de vida do merge. +- revisou o diff completo de filtragem, skill, perfil QA e testes como PR 3. +- reutilizou as evidências atuais de QA, examinou a CI e autorizou explicitamente o Agent Merge. + +Em seguida, você explorará **canvases**, uma maneira mais completa de planejar e visualizar o trabalho com o agente. Continue para a [Lição 9 - Criar um canvas de triagem][next-lesson]. + +## Recursos + +- [Gerenciar issues e pull requests com o aplicativo GitHub Copilot][managing-issues-prs] +- [Sobre o aplicativo GitHub Copilot][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/8-review.md b/docs/pt-br/app/8-review.md deleted file mode 100644 index 704a1783..00000000 --- a/docs/pt-br/app/8-review.md +++ /dev/null @@ -1,83 +0,0 @@ ---- -title: "Lição 8 - Revisão e próximos passos" -description: "Recapitule o percurso do aplicativo GitHub Copilot, automatize trabalhos recorrentes e explore os próximos passos." -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -Nas últimas lições, você levou um recurso da ideia ao merge com o aplicativo GitHub Copilot. Nesse processo, você: - -- conectou um repositório e conheceu o espaço de trabalho do aplicativo e o backlog criado pelo modelo. -- iniciou sessões a partir de uma tarefa direta e de issues e usou os modos Plan e Autopilot para controlar como o agente trabalha. -- orientou o agente com instruções personalizadas e uma skill reutilizável. -- testou o trabalho com o servidor MCP do Playwright em um navegador real. -- colaborou com o agente em um canvas compartilhado. -- entregou alterações avançando por níveis de automação de merge, desde fazer o merge por conta própria no github.com até permitir que o **Agent Merge** integrasse um pull request. - -Vamos automatizar parte do trabalho recorrente, analisar boas práticas e explorar os próximos passos. - -## Automatizar trabalhos recorrentes - -O aplicativo pode executar agentes para você em uma agenda ou sob demanda por meio de **automações**, ideais para tarefas rotineiras como fazer a triagem de novas issues ou recapitular atividades recentes. Vamos criar uma automação simples e não destrutiva. - -1. Selecione **Automations** na barra lateral e depois selecione **New automation**. -2. Dê um nome a ela, como `Recap my recent work`. -3. Escolha um gatilho. **Manual** permite executá-la sob demanda; **On a schedule** a executa automaticamente; **When an issue is created** reage a novas issues. Escolha **Manual** para esta lição. -4. Insira um prompt somente leitura para impedir que a automação faça alterações. Por exemplo: - - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` - -5. Escolha o projeto, ou seja, seu repositório Tailspin Toys, e crie a automação. -6. Execute-a sob demanda para ver o resultado. - -> [!TIP] -> As automações podem ser executadas localmente ou na nuvem. Habilite **Run in the cloud** e escolha as **Tools** que uma automação pode usar quando quiser que ela seja executada sem supervisão e de acordo com uma agenda. Mantenha as automações agendadas com escopo limitado e sem ações destrutivas até confiar nos resultados. - -## Boas práticas - -Ao usar qualquer ferramenta de IA, a infraestrutura ao redor dela influencia a qualidade dos resultados. Arquivos de instruções, skills e agentes personalizados tiveram uma função neste workshop. Invista neles e reutilize-os entre as sessões. - -Associe o **modo e o modelo** à tarefa. Use **Plan** para analisar uma abordagem antes de desenvolver, **Interactive** para acompanhar alterações específicas e **Autopilot** somente para tarefas isoladas e com escopo bem definido. Escolha um modelo mais rápido para edições rotineiras e um modelo mais avançado, com maior esforço de raciocínio, para trabalhos complexos. - -O contexto continua tão importante quanto a infraestrutura. Descrever claramente *o que* você quer criar, *por que* e *como* muda significativamente o resultado. Os chats rápidos são ótimos para definir o escopo de uma ideia antes de transformá-la em uma sessão completa. - -## Mais recursos para explorar - -Você percorreu o fluxo de trabalho principal. Veja outros recursos que valem a pena conhecer: - -- **Quick chats** para perguntas rápidas e descartáveis que não exigem uma sessão completa. -- **Rubber duck** para analisar um problema e receber feedback relevante antes de começar a desenvolver. -- [**Agentes personalizados**][custom-agents] para empacotar uma função, suas ferramentas e instruções para trabalhos especializados e repetíveis. -- [`/chronicle`][chronicle] para gerar uma narrativa do que aconteceu em uma sessão. -- [Bring your own key (BYOK)][byok] para usar modelos do seu próprio provedor, incluindo modelos locais por meio de Ollama, Foundry Local ou LM Studio. -- [Sandboxes na nuvem][sandboxes] para executar sessões em um ambiente isolado hospedado pelo GitHub. -- [Deep links][deep-links] para abrir o aplicativo diretamente em um repositório, uma sessão ou um prompt. - -## Próximos passos - -A melhor maneira de melhorar com qualquer ferramenta é continuar usando-a. Use-a em código de produção, em projetos pessoais ou naquele pequeno aplicativo que você planeja criar há anos. Compartilhe o que aprendeu com sua equipe e aprenda com as experiências dela. E, como sempre, explore a documentação. - -Para conhecer melhor o ecossistema do GitHub Copilot, confira o [percurso do VS Code](../../vscode/), o [percurso do Copilot CLI](../../cli/) ou o [percurso do agente de nuvem](../../cloud/). - -## Recursos - -- [Sobre o aplicativo GitHub Copilot][about-copilot-app] -- [Introdução ao aplicativo GitHub Copilot][getting-started] -- [Personalizar o aplicativo GitHub Copilot][customize] -- [Usar automações][using-automations] -- [Trabalhar com extensões de canvas][canvas-docs] -- [Sobre sandboxes locais e na nuvem][sandboxes] - -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app -[getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started -[customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app -[using-automations]: https://docs.github.com/copilot/how-tos/github-copilot-app/using-automations -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[chronicle]: https://docs.github.com/copilot/how-tos/copilot-cli/use-copilot-cli/chronicle -[custom-agents]: https://docs.github.com/copilot/concepts/agents/cloud-agent/about-custom-agents -[byok]: https://docs.github.com/copilot/how-tos/github-copilot-app/use-byok-models -[deep-links]: https://docs.github.com/copilot/how-tos/github-copilot-app/open-with-deep-links \ No newline at end of file diff --git a/docs/pt-br/app/9-canvases.md b/docs/pt-br/app/9-canvases.md new file mode 100644 index 00000000..3d82363f --- /dev/null +++ b/docs/pt-br/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "Lição 9 - Criar um canvas de triagem" +description: "Crie e revise um canvas de triagem salvo no repositório, integre o PR 4 e reabra-o para adicionar contexto de issues sem iniciar outro recurso." +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +Até agora, você orientou agentes pelo chat. No entanto, grande parte do trabalho não acontece em uma conversa, mas em um quadro, documento ou checklist. Os **canvases** oferecem a você e ao agente uma superfície compartilhada exatamente para esse tipo de trabalho, dentro do aplicativo. Nesta lição, você criará um canvas simples para planejar e acompanhar o backlog no qual vem trabalhando. + +Nesta lição, você vai: + +- entender o que é um canvas e quando usá-lo. +- criar um canvas compartilhado de quadro Kanban para fazer a triagem do backlog. +- salvar o canvas no repositório e integrá-lo para a equipe. +- reabrir o canvas e adicionar contexto de issues sem implementar outro recurso. + +## Cenário + +Analisar uma lista de issues pode ser desafiador. As pessoas desenvolvedoras da Tailspin Toys querem uma ferramenta para fazer a triagem de issues e adicionar seus detalhes ao contexto de uma sessão. Adicionar contexto não autoriza implementar uma issue; este exercício termina com um quadro reutilizável, não com um quinto PR. + +## O que é um canvas? + +Um [canvas][canvas-docs] é uma superfície interativa e compartilhada para um artefato de trabalho, como um plano, um quadro de triagem, um checklist de lançamento, um painel ou um documento. Embora o chat seja ótimo para descrever intenções e analisar ambiguidades, a maior parte do trabalho acontece em uma *superfície*. Os canvases permitem colaborar com o agente diretamente nessa superfície. + +Os canvases são **bidirecionais**: o agente pode atualizar o canvas enquanto trabalha, e você pode editar a mesma superfície. Quando você cria um canvas, o agente o desenvolve com base no prompt e no fluxo de trabalho. Você pode pedir que ele adicione, remova ou revise recursos durante o processo. Depois de criado, o canvas é aberto no painel direito do aplicativo. + +Alguns exemplos comuns incluem: + +- **Canvases Markdown** para planejar o dia e priorizar issues e pull requests. +- **Quadros Kanban agênticos** nos quais pessoas e agentes adicionam cards e movem o trabalho entre colunas. +- **Quadros de triagem de issues** que resumem as principais issues e os temas recorrentes de um repositório. + +## Por que usar um canvas? + +Use um canvas quando uma tarefa exigir estrutura, iteração e verificação e o chat não for suficiente. Um canvas permite: + +- fundamentar o trabalho do agente em um artefato real adequado ao seu fluxo de trabalho. +- orientar ou corrigir o trabalho diretamente na superfície compartilhada e depois permitir que o agente continue a partir das suas alterações. +- acompanhar o progresso como alterações visíveis em um artefato, e não apenas como respostas no chat. + +## Criar um canvas para acompanhar o trabalho + +Confirme que o PR 3 foi integrado. As avaliações por estrelas, o padrão de documentação, o recurso de filtragem, a skill de qualidade e o perfil QA devem estar em `main` antes de iniciar o canvas. Use uma sessão nova e uma branch para este último marco de PR. + +1. Volte ao aplicativo GitHub Copilot ou abra-o. +2. Selecione **Home screen**. +3. Verifique se `tailspin-toys` está selecionado como repositório. +4. Escolha **new working tree** e o modo **Interactive**. Envie esta solicitação de estado inicial antes de criar arquivos: + + ```plaintext + Prepare esta nova sessão de canvas sem implementar nada. Confirme que este é um worktree novo e limpo, busque as atualizações de origin e avance a branch da sessão atual por fast-forward até origin/main. Informe a cópia de trabalho, a branch e as revisões correspondentes de HEAD e origin/main. Verifique se o PR de filtragem foi integrado e se o recurso de filtragem, a skill quality-checks e o perfil QA estão presentes. + + Pare se houver alterações pendentes, divergências ou se o merge anterior estiver ausente. Não redefina, não descarte trabalho, não mude de branch nem crie outra branch. Pare após informar o estado inicial. + ``` + +5. Verifique o relatório do estado inicial e solicite o canvas salvo no repositório: + + ```plaintext + Crie um canvas Kanban básico de triagem salvo neste repositório usando o fluxo de extensões de canvas suportado pelo aplicativo. Salve sua definição em .github/extensions/ para que a equipe possa reutilizá-lo. Examine as extensões existentes e preserve-as; não sobrescreva o explorador de banco de dados incluído. + + Leia as issues abertas atuais. Destaque as três com maior probabilidade de precisar de atenção e mostre as demais abaixo. Inclua em cada issue destacada o título, o resumo do conteúdo, a URL e uma justificativa para sua prioridade. Trate a classificação como sugestão, não como instrução para alterar issues. + + Dê a cada card uma ação Add to current context que anexe os detalhes da issue apenas a esta sessão. Ela não deve iniciar a implementação, criar sessões ou branches, alterar o estado da issue nem criar PRs. Mantenha o escopo do canvas limitado e torne-o acessível por teclado. + + Mostre os arquivos gerados e abra o canvas para inspeção. Não altere código da aplicação, não faça commit, push nem crie um PR. Pergunte antes de instalar qualquer coisa ou adicionar dependências. + ``` + +O Copilot cria os arquivos do canvas e abre a superfície compartilhada. Revise a extensão gerada antes de confiar em suas ações; ela é conteúdo executável do repositório, não apenas uma imagem. + +> [!NOTE] +> Se a primeira versão precisar de melhorias, solicite alterações específicas dentro do escopo de triagem. Não transforme este exercício na implementação de uma issue do backlog. + +## Inspecionar e exercitar o canvas + +1. Abra **Changes** e confirme que a definição do canvas está salva no repositório em `.github/extensions/`, não apenas para seu usuário ou sessão. Verifique se as extensões existentes e os arquivos da aplicação permanecem inalterados. +2. Compare o quadro com as issues abertas reais e avalie as explicações da classificação. +3. Verifique se os cards e controles são legíveis e utilizáveis por teclado. +4. Selecione **Add to current context** em uma issue e confirme que apenas seus detalhes entram na conversa. Nenhuma implementação ou alteração de estado da issue deve começar. +5. Revise as correções e peça ao Copilot que execute a validação existente aplicável aos arquivos alterados. Registre resultados e bloqueios, em vez de presumir que uma superfície interativa está correta apenas porque abriu. + +## Salvar o canvas e integrá-lo ao repositório + +O canvas já é um ativo do repositório. Faça commit e envie apenas o trabalho revisado do canvas como PR 4: + +1. Na mesma sessão, envie: + + ```plaintext + Revise o diff do canvas de triagem salvo no repositório e suas evidências de validação. Faça commit dos arquivos aprovados do canvas na branch desta sessão, envie-a e crie um único PR destinado a main usando o modelo de PR do repositório. Descreva o comportamento do canvas e como verificamos que adicionar uma issue apenas adiciona contexto. Não faça o merge ainda nem implemente uma issue do backlog. + ``` + +2. Revise o diff completo do PR e as verificações em **My work**. Confirme que ele contém o canvas, não trabalho da aplicação não relacionado. +3. Na mesma sessão do canvas, abra o menu suspenso de ações de PR e selecione **Agent merge**. Revise as ações permitidas e mantenha **Merge pull request** desativado até aprovar o resultado final. +4. Defina o escopo antes de iniciar o Agent Merge: + + ```plaintext + Gerencie este PR de canvas existente com o Agent Merge. Resolva apenas bloqueios de revisão e CI dentro do escopo; pergunte antes de alterações não relacionadas ou instalações. Se o canvas mudar, repita a validação afetada e atualize as evidências. Não faça o merge até eu habilitar explicitamente Merge pull request após a revisão. Não implemente issues do backlog nem crie outro PR. + ``` + +5. Selecione **Agent merge** e revise as alterações posteriores. Examine as verificações reais de CI do repositório do participante e resolva falhas; a CI não substitui o exercício do canvas. + +6. Quando o diff final e as evidências atuais estiverem aprovados e as verificações e revisões obrigatórias passarem, autorize explicitamente o Agent Merge a fazer o merge selecionando seu menu suspenso e depois **Merge pull request**. + + ![Menu suspenso Agent merge mostrando as ações permitidas ao agente — Address reviews, Fix CI failures, Resolve conflicts — com uma seta apontando para Merge pull request](../../_images/app-agent-merge-merge.png) + +7. Confirme que o GitHub mostra o PR 4 como **Merged** antes de continuar. + +Você criou um novo canvas compartilhado para a equipe. + +## Reabrir o canvas sem iniciar outro recurso + +Reabra o canvas salvo no repositório na mesma sessão do canvas após o merge do PR. Esta é uma etapa de inspeção, não outra branch ou marco de PR. + +1. Volte à sessão do canvas, mantenha o modo **Interactive** e feche o painel do canvas se ainda estiver aberto. +2. Envie: + + ```plaintext + Reabra o canvas de triagem do repositório nesta mesma sessão. Adicionarei uma issue ao contexto apenas para examinar seus detalhes. Não edite arquivos, não implemente a issue, não altere seu estado, não crie outra sessão ou branch, não faça commit, push nem abra um PR. + ``` + +3. Confirme que o canvas salvo abre novamente sem regenerar sua definição. +4. Selecione **Add to current context** em uma das issues que mais lhe interessam. +5. Confirme que os detalhes da issue selecionada aparecem no contexto sem iniciar a implementação. Pare aqui: o workshop tem quatro marcos de PR, não cinco. + +Você usou um canvas criado por você para otimizar o processo de desenvolvimento. + +## Resumo e próximos passos + +Você criou uma superfície compartilhada na qual você e o agente podem colaborar. Você: + +- aprendeu o que são canvases e quando usá-los. +- criou com o agente um canvas compartilhado de quadro Kanban para triagem. +- salvou o canvas no repositório e fez o merge dele com o Agent Merge. +- reabriu o canvas integrado e adicionou contexto de issues sem iniciar outro recurso. + +Com o backlog acompanhado, é hora de revisar tudo o que você criou e decidir os próximos passos. Continue para a [Lição 10 - Revisão e próximos passos][next-lesson]. + +## Recursos + +- [Trabalhar com extensões de canvas no aplicativo GitHub Copilot][canvas-docs] +- [Canvases no Awesome Copilot][awesome-copilot-canvases] +- [Sobre o aplicativo GitHub Copilot][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/pt-br/app/README.md b/docs/pt-br/app/README.md index 82e8ba78..afd949e8 100644 --- a/docs/pt-br/app/README.md +++ b/docs/pt-br/app/README.md @@ -3,12 +3,14 @@ slug: pt-br/app title: "Aplicativo GitHub Copilot" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- O [**aplicativo GitHub Copilot**](https://docs.github.com/copilot/concepts/agents/github-copilot-app) é um aplicativo para desktop criado com base no Copilot CLI que reúne o desenvolvimento orientado por agentes em um espaço de trabalho único e focado. Ele oferece sessões paralelas de agentes, modos de sessão alternáveis, canvases compartilhados e gerenciamento nativo de issues e pull requests do GitHub, incluindo o **Agent Merge**, que conduz um pull request por rebases, feedback de revisão, correções de CI e merge. -Ao longo destas lições, você instalará o aplicativo e configurará o projeto. Depois, conhecerá o espaço de trabalho do aplicativo e o backlog que o modelo criou para você. Você começará com uma pequena alteração, adicionando uma avaliação por estrelas, e então adicionará a partir de uma issue um padrão de instruções personalizadas, criará um recurso de filtragem em uma sessão isolada de agente e o verificará com uma skill reutilizável. Você adicionará o servidor MCP do Playwright para explorar o recurso em um navegador real e, em seguida, avançará por níveis de automação de merge até que o **Agent Merge** conclua o merge do pull request. Por fim, você colaborará em um canvas compartilhado e automatizará trabalhos recorrentes, completando todo o ciclo, da ideia ao recurso integrado. +As Lições 0–1 de configuração preparam o projeto e o espaço de trabalho do aplicativo. Os nove módulos principais, as Lições 2–10, começam com uma melhoria rápida de avaliações por estrelas e uma convenção de documentação demonstrada em código real. Depois, você planejará e criará a filtragem, criará e executará uma skill quality-checks com scripts de shell, observará o recurso pelo MCP do Playwright e criará um agente personalizado QA para avaliar requisitos e cobertura. Você revisará o PR completo do recurso e autorizará o Agent Merge e, depois, criará e integrará um canvas compartilhado de triagem. + +O workshop tem quatro marcos de PR: avaliações por estrelas; instruções com sua demonstração; filtragem com a skill, o perfil QA e os testes; e, por fim, o canvas. Comece cada marco a partir de `main` atualizado, usando uma branch por PR em vez de uma por módulo. As Lições 4–8 permanecem na mesma sessão, worktree e branch de filtragem. Reabrir o canvas adiciona contexto de issues sem iniciar outro recurso ou um quinto PR. As automações são vinculadas como próximo passo, não como exercício adicional. ## Lições @@ -16,13 +18,15 @@ Ao longo destas lições, você instalará o aplicativo e configurará o projeto |--------|-------|-------------| | [0. Pré-requisitos][ex0] | Configuração | Instale o Node.js e crie sua cópia do projeto Tailspin Toys | | [1. Instalar o aplicativo Copilot][ex1] | Configuração | Instale o aplicativo, conecte seu projeto e conheça o espaço de trabalho | -| [2. Executar sua primeira sessão de agente][ex2] | Primeira alteração | Inicie uma sessão e entregue uma pequena alteração como seu primeiro pull request | -| [3. Orientar o Copilot com instruções personalizadas][ex3] | Contexto | Adicione a partir de uma issue um padrão de documentação e faça o merge | -| [4. Criar um recurso com o Autopilot][ex4] | Recurso principal | Use Plan e Autopilot para criar a filtragem e verifique-a com uma skill | -| [5. Testar com o MCP do Playwright][ex5] | Ferramentas externas | Adicione o servidor MCP do Playwright e explore o recurso em um navegador | -| [6. Fazer merge com o Agent Merge][ex6] | Merge | Permita que o Agent Merge corrija e integre o pull request de filtragem | -| [7. Planejar com canvases][ex7] | Colaboração | Crie um canvas compartilhado para planejar e acompanhar seu trabalho | -| [8. Revisão e próximos passos][ex8] | Resumo | Automatize tarefas recorrentes e explore os próximos passos | +| [2. Adicionar avaliações por estrelas: uma melhoria rápida][ex2] | Primeira alteração | Exiba as avaliações existentes e a alternativa para null e integre o PR 1 | +| [3. Orientar o Copilot com instruções personalizadas][ex3] | Contexto | Adicione um padrão de documentação e uma demonstração real e integre o PR 2 | +| [4. Criar a filtragem com Plan e Autopilot][ex4] | Implementação | Aprove o plano, implemente e verifique a filtragem e salve um checkpoint | +| [5. Criar e usar uma skill quality-checks][ex5] | Verificações repetíveis | Crie, revise e execute os scripts de shell incluídos | +| [6. Validar a funcionalidade com o MCP do Playwright][ex6] | Observação no navegador | Configure MCP pelo Customize e examine o comportamento da filtragem | +| [7. Criar e usar um agente QA][ex7] | Requisitos e cobertura | Selecione um perfil especializado e reúna evidências de verificação final | +| [8. Criar e integrar o PR do recurso][ex8] | Revisão e merge | Revise a filtragem, a skill, o perfil QA e os testes e autorize o Agent Merge para o PR 3 | +| [9. Criar um canvas de triagem][ex9] | Colaboração | Compartilhe um canvas salvo no repositório no PR 4 e adicione contexto de issues | +| [10. Revisão e próximos passos][ex10] | Resumo | Revise o fluxo, os artefatos e outros recursos | ## Pré-requisitos @@ -50,9 +54,11 @@ Antes de participar deste workshop, verifique se você tem: [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students \ No newline at end of file diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index d3fc1484..9c9f0788 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -27,7 +27,7 @@ GitHub Copilot 最近新增的功能为开发人员提供了贯穿整个软件 ### 🤖 [Copilot App](app/) -**GitHub Copilot app** 是一款基于 Copilot CLI 构建的桌面应用。它支持并行运行智能体会话、切换会话模式、在画布上协作,以及直接管理 GitHub 议题和拉取请求。其中包括 **Agent Merge**,可引导拉取请求完成变基、处理审查反馈、修复 CI 问题并最终合并。 +**GitHub Copilot app** 是一款基于 Copilot CLI 构建的桌面应用。使用应用的隔离会话和 **Agent Merge**,按相同的设置和九个核心模块完成星级评分、指令、筛选功能、技能、MCP、QA 和功能 PR 工作流。创建并合并保存在存储库中的画布,完成第四个拉取请求里程碑,然后总结。 ### ☁️ [Copilot Cloud Agent](../cloud/) diff --git a/docs/zh-cn/app/0-prerequisites.md b/docs/zh-cn/app/0-prerequisites.md index b23c75d0..33ccf52c 100644 --- a/docs/zh-cn/app/0-prerequisites.md +++ b/docs/zh-cn/app/0-prerequisites.md @@ -15,18 +15,18 @@ GitHub Copilot app 是一款桌面应用,作为 Copilot 和 GitHub 的中央 ## 安装 Node.js -多节课程会要求智能体构建功能,并在本地运行 Tailspin Toys 测试套件。这需要项目唯一依赖的运行时 [**Node.js**][nodejs]。请安装 **22 或更高版本**;当前的 **LTS** 版本是稳妥的选择。 +多节课程会要求智能体构建功能,并在本地运行 Tailspin Toys 测试套件。这需要 [**Node.js**][nodejs]。使用 **Node.js 22.13 或更高版本**,并查看当前检出项目的 `package.json` 和 README,确认支持的版本。 所有平台上最简单的方式都是使用官方安装程序: 1. 在操作系统中使用 Windows Terminal、macOS 终端或常用工具打开终端窗口。 -2. 运行以下命令,确认已安装 Node.js 22 或更高版本: +2. 运行以下命令,确认已安装 Node.js 22.13 或更高版本: ```shell node --version ``` -3. 如果看到 `v22` 或更高版本号,可以跳到下一节。 +3. 如果显示的版本至少为 `v22.13.0`,且项目支持该版本,可以跳到下一节。 > [!TIP] > 仅当尚未安装 Node 或需要更新时,才需要完成以下步骤。 @@ -41,10 +41,10 @@ GitHub Copilot app 是一款桌面应用,作为 Copilot 和 GitHub 的中央 node --version ``` -9. 应会看到 `v22.x.x` 或更高版本。 +9. 确认显示的版本至少为 `v22.13.0`,且项目支持该版本。 -> [!TIP] -> 更喜欢容器?如果已安装 [**Docker**][docker],可以使用存储库的[开发容器][dev-containers],无需在本地安装 Node.js。开发容器已包含 Node,两种方式无需同时使用。 +> [!IMPORTANT] +> App 学习路径使用本地工作树。仅安装在容器中的运行时无法供这些本地会话使用。每个工作树还需要项目依赖项及用于 E2E 检查的 Playwright Chromium。准备工作树时,请遵循练习存储库的 README,并在批准前审查所有安装请求。 ## 设置实验存储库 @@ -64,6 +64,8 @@ GitHub Copilot app 是一款桌面应用,作为 Copilot 和 GitHub 的中央 > [!NOTE] > 通过模板创建存储库时,系统会自动创建一组 GitHub 议题作为待办事项。整个研讨会都会使用这些议题,无需自行创建。 +使用修订后模板的新副本:其中包含存储库指令、应用代码、测试和现有画布扩展,但不附带自定义智能体或技能。你将在研讨会中创建自己的 quality-checks 技能和 QA 配置文件。如果使用旧副本,应先检查现有自定义配置,而不是直接覆盖。 + ## 总结与后续步骤 准备工作已完成。你安装了 Node.js,因此可以在本机构建和测试项目;还通过模板创建了自己的 Tailspin Toys 存储库副本。 @@ -79,7 +81,5 @@ GitHub Copilot app 是一款桌面应用,作为 Copilot 和 GitHub 的中央 [next-lesson]: ../1-install-copilot-app/ [nodejs]: https://nodejs.org/ [node-download]: https://nodejs.org/en/download -[docker]: https://www.docker.com/products/docker-desktop/ -[dev-containers]: https://code.visualstudio.com/docs/devcontainers/containers [template-repository]: https://docs.github.com/repositories/creating-and-managing-repositories/creating-a-template-repository [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/1-install-copilot-app.md b/docs/zh-cn/app/1-install-copilot-app.md index 0d9564e9..c524cd84 100644 --- a/docs/zh-cn/app/1-install-copilot-app.md +++ b/docs/zh-cn/app/1-install-copilot-app.md @@ -41,23 +41,23 @@ lastUpdated: 2026-07-09 连接项目后,花一点时间熟悉工作区。应用将功能组织在侧边栏的以下几个区域: -- **Sessions**:智能体执行工作的区域。每个会话都在独立工作区中运行,因此可以同时运行多个会话,且更改不会发生冲突。下一课将启动第一个会话。 +- **Sessions**:智能体执行工作的区域。本研讨会请选择 **new working tree**,为每个 PR 里程碑提供隔离的检出目录和分支。应用还有其他工作区选项,但本研讨会不使用它们。 - **Quick chats**:适合提问和集思广益的轻量对话,无需单独创建分支或工作区。本课结束时会进行一次快速聊天。 - **My work**:通过应用的 **GitHub 原生集成**显示议题和拉取请求。在这里,无需离开应用即可浏览和筛选议题与拉取请求、检查 CI 状态、从议题启动会话以及审查拉取请求。 -- **Automations**:可按计划或按需运行的已保存智能体任务。本学习路径接近结束时会创建一个自动化任务。 +- **Customize**:发现和管理 MCP 服务器、技能及画布。你将使用它配置 Playwright MCP。 +- **Automations**:可按计划或按需运行的已保存智能体任务。总结课程会将其作为后续方向提供链接,而不再添加研讨会练习。 ### 查找模板创建的待办事项 由于应用与 GitHub 原生集成,存储库中待处理的工作会直接显示在应用内。通过模板创建存储库时,系统已生成一组议题。现在确认它们是否存在。 1. 在侧边栏中选择 **My work**。 -2. 模板在待办列表中创建了八个议题。本课程聚焦以下三个,确认它们可见: +2. 按标题查找以下议题,不要假设议题编号: - Allow users to filter games by category and publisher - Update our repository coding standards - - Implement pagination on the game list page -3. 选择一个议题以阅读详细信息。每个议题也可以作为智能体会话的启动点,后续课程会从这些议题开始工作。 +3. 选择一个议题以阅读详细信息。每个议题也可以作为智能体会话的启动点,后续课程会从这些议题开始工作。其他待办议题用于为画布提供上下文,而不是另一项实现任务。 > [!NOTE] > My work 中的项目会自动筛选,仅显示已添加到 Copilot app 的存储库中的项目。要查看其他存储库中的工作项,请将相应存储库添加到应用。 @@ -70,7 +70,7 @@ lastUpdated: 2026-07-09 2. 询问应用自身的会话工作方式: ```plaintext - How does the GitHub Copilot app use worktrees? + GitHub Copilot app 如何使用工作树? ``` 3. 在对话视图中阅读回复。每个会话都在独立的 git 工作树中运行,因此可以并行运行多个智能体,而不会造成更改冲突。你可以随时继续对话或开始新聊天。 @@ -84,7 +84,13 @@ lastUpdated: 2026-07-09 - 熟悉工作区,并在 **My work** 中找到模板创建的待办事项。 - 使用快速聊天提出一次性问题。 -接下来,你将启动第一个智能体会话,并对项目进行第一次更改,即在游戏卡片上显示星级评分。继续学习[第 2 课 - 运行第一个智能体会话][next-lesson]。 +## 分开管理 PR 里程碑 + +你将合并四个 PR:星级评分;指令及小型示例改动;筛选功能及技能、QA 配置文件和测试;最后是分类画布。每个 PR 里程碑使用一个分支。第 4–8 课沿用同一筛选会话、工作树和分支,以检查点提交保存进度,而不额外创建 PR。 + +新的 App 工作树可能从过时的本地状态开始。每个新里程碑在编辑文件前,都应获取存储库更新,并将新会话分支快进到最新的 `origin/main`。后续课程会明确展示这些步骤。不要堆叠分支、挑选之前的提交,也不要将进行中的筛选会话切换到其他分支。 + +接下来,你将启动第一个智能体会话,并对项目进行第一次更改,即在游戏卡片上显示星级评分。继续学习[第 2 课 - 添加星级评分:快速上手][next-lesson]。 ## 资源 @@ -92,7 +98,7 @@ lastUpdated: 2026-07-09 - [GitHub Copilot app 入门][getting-started] - [在 GitHub Copilot app 中使用智能体会话][agent-sessions] -[ex0]: ../0-prerequisites/ +[previous-lesson]: ../0-prerequisites/ [next-lesson]: ../2-add-star-rating/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started diff --git a/docs/zh-cn/app/8-review.md b/docs/zh-cn/app/10-review.md similarity index 50% rename from docs/zh-cn/app/8-review.md rename to docs/zh-cn/app/10-review.md index c00c5c7b..8a753922 100644 --- a/docs/zh-cn/app/8-review.md +++ b/docs/zh-cn/app/10-review.md @@ -1,44 +1,43 @@ --- -title: "第 8 课 - 回顾与后续步骤" -description: "回顾 GitHub Copilot app 学习路径,自动执行重复性工作,并探索后续方向。" +title: "第 10 课 - 总结与后续步骤" +description: "回顾 App 的九个核心模块、四个 PR 里程碑和可复用质量工作流,再探索更多资源。" authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- 在过去几节课程中,你使用 GitHub Copilot app 将一项功能从构想推进到合并,包括: - 连接存储库,并熟悉应用工作区和模板创建的待办事项。 - 从直接任务和议题启动会话,并使用 Plan 和 Autopilot 模式控制智能体的工作方式。 -- 使用自定义指令和可复用技能引导智能体。 +- 使用自定义指令引导智能体,再让它创建包含 shell 脚本的可复用技能,审查并运行这些脚本,完成 lint、单元测试、端到端测试和类型检查。 - 使用 Playwright MCP 服务器在真实浏览器中测试工作。 +- 创建并选择 QA 自定义智能体,以评估需求、覆盖情况、技能脚本结果和浏览器证据。 - 在共享画布上与智能体协作。 -- 逐步提高更改交付的合并自动化程度,从自行在 github.com 上合并,到让 **Agent Merge** 完成拉取请求。 +- 明确执行早期 PR 的合并,再在功能和画布 PR 工作流中授权 **Agent Merge**。 -接下来自动执行一些重复性工作、讨论最佳实践,并了解后续方向。 +完成设置课程第 0–1 课后,你学习了九个核心模块,即第 2–10 课。现在回顾产出和后续方向;本总结不再启动新的动手任务。 -## 自动执行重复性工作 +## 交付的内容 -应用可通过**自动化**按计划或按需运行智能体,非常适合对新议题进行分类或汇总近期活动等日常任务。接下来创建一个简单的非破坏性自动化任务。 +本研讨会有四个 PR 里程碑,每个里程碑都从更新后的 `main` 开始,使用各自的分支: -1. 在侧边栏中选择 **Automations**,再选择 **New automation**。 -2. 为其指定名称,例如 `Recap my recent work`。 -3. 选择触发器。**Manual** 支持按需运行;**On a schedule** 会自动运行;**When an issue is created** 会在创建新议题时响应。本课请选择 **Manual**。 -4. 输入只读提示词,确保自动化任务无法更改任何内容,例如: +1. **星级评分**:在游戏卡片上显示现有的 `starRating`,以及明确的未评分状态。 +2. **指令及示例改动**:添加文档约定,并通过一个小型的真实代码改动验证其效果。 +3. **筛选功能及质量工作流**:实现议题需求,创建包含 shell 脚本的 `quality-checks` 技能和 QA 配置文件,并包含相关测试。 +4. **保存在存储库中的分类画布**:共享一个添加议题上下文的看板,而不自动实现其他功能。 - ```plaintext - Summarize the pull requests merged in this repository over the last week, and list any issues still open in the backlog. - ``` +第 4–8 课使用同一筛选会话、工作树和分支。检查点提交在 PR 3 内保留进度;技能、MCP 配置和 QA 无需单独的功能分支。每个后续里程碑都在前一个 PR 合并,且新会话分支从 `origin/main` 更新后才开始。 -5. 选择项目(你的 Tailspin Toys 存储库)并创建自动化任务。 -6. 按需运行该任务以查看结果。 +## 不同类型的验证 -> [!TIP] -> 自动化任务可以在本地或云中运行。如果希望自动化任务按计划无人值守运行,请启用 **Run in the cloud**,并选择允许它使用的 **Tools**。在信任其输出之前,应确保计划任务范围明确且不具破坏性。 +早期功能使用现有 npm 检查。筛选功能增加了手动浏览器检查。技能通过随附脚本让四项检查可重复执行,MCP 增加了智能体的直接浏览器观察,QA 则将需求和覆盖情况与最终验证结合起来。PR 仅在 QA 证据仍适用于所提交的修订版本时才复用它。 + +新增测试应填补真实缺口;不需要新增测试的 QA 运行也可能完全正确。缺少工具、跳过检查和失败都是需要明确报告的阻塞项,而不是通过。授权合并前审查代码和证据,并在改动后更新受影响的证据。 ## 最佳实践 -使用任何 AI 工具时,其周边基础设施都会影响输出质量。指令文件、技能和自定义智能体都在本研讨会中发挥了作用。应投入精力完善这些资产,并在会话间复用。 +使用任何 AI 工具时,其周边基础设施都会影响输出质量。本研讨会中,你创建了指令、技能和 QA 配置文件;应审查它们,并在会话间复用。自定义智能体定义专业角色和指令,可用工具由配置和操作环境权限决定;技能则将可复用的任务指令、可执行脚本和辅助资源打包,供按需加载。自定义智能体也能执行脚本,包括技能随附的脚本。确认脚本实际执行且自定义智能体确已选中,而不是仅凭令人信服的描述作出判断。 根据任务选择适合的**模式和模型**。使用 **Plan** 在构建前思考方法;使用 **Interactive** 参与范围明确的更改;仅对范围清晰且彼此隔离的任务使用 **Autopilot**。日常编辑可选择更快的模型,复杂工作则选择推理能力更强的模型并提高推理强度。 @@ -49,6 +48,7 @@ lastUpdated: 2026-07-09 你已经了解核心工作流。以下功能也值得探索: - **Quick chats**:适合不需要完整会话的一次性问题。 +- [**Automations**][using-automations]:用于重复性或按需任务,例如汇总近期工作。采用前审查计划、权限和范围;创建自动化任务属于后续方向,不是本研讨会的一部分。 - **Rubber duck**:用于分析问题,并在构建前获得高信噪比反馈。 - [**Custom agents**][custom-agents]:将角色、工具和指令打包,以便重复执行专业工作。 - [`/chronicle`][chronicle]:生成会话过程的叙述。 @@ -60,7 +60,7 @@ lastUpdated: 2026-07-09 熟练使用任何工具的最佳方式都是持续使用。可将它用于生产代码、业余项目,或那个构思多年却始终没有动手构建的小应用。与团队分享经验,也向团队学习。并且一如既往地探索文档。 -要探索 GitHub Copilot 生态系统的更多内容,请查看 [VS Code 学习路径](../../vscode/)、[Copilot CLI 学习路径](../../cli/)或 [Cloud agent 学习路径](../../cloud/)。 +要探索 GitHub Copilot 生态系统的更多内容,请查看 [VS Code 学习路径][vscode-harness]、[Copilot CLI 学习路径][cli-harness]或 [Cloud agent 学习路径][cloud-harness]。 ## 资源 @@ -71,6 +71,10 @@ lastUpdated: 2026-07-09 - [使用画布扩展][canvas-docs] - [关于云沙盒和本地沙盒][sandboxes] +[previous-lesson]: ../9-canvases/ +[vscode-harness]: ../../vscode/ +[cli-harness]: ../../cli/ +[cloud-harness]: ../../cloud/ [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app [getting-started]: https://docs.github.com/copilot/how-tos/github-copilot-app/getting-started [customize]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/zh-cn/app/2-add-star-rating.md b/docs/zh-cn/app/2-add-star-rating.md index 632d0194..b7d7c1c1 100644 --- a/docs/zh-cn/app/2-add-star-rating.md +++ b/docs/zh-cn/app/2-add-star-rating.md @@ -1,5 +1,5 @@ --- -title: "第 2 课 - 运行第一个智能体会话" +title: "第 2 课 - 添加星级评分:快速上手" description: "在 GitHub Copilot app 中启动第一个智能体会话,对游戏卡片进行一项小改动,并通过第一个拉取请求合并更改。" authors: - geektrainer @@ -22,7 +22,7 @@ Tailspin Toys 中的每款游戏都可以有星级评分,该评分已显示在 ## 会话剖析 -**会话**是与智能体的对话,在独立工作区中运行。每个会话都有**专用的 git 工作树和分支**,因此可以同时运行多个会话,例如一个添加功能,另一个修复 bug,而不会造成更改冲突。会话按存储库分组显示在侧边栏中,选择任一会话即可切换。 +**会话**是与智能体的对话。本研讨会选择 **new working tree**,为会话提供专用的检出目录和分支。这样可以隔离每个 PR 里程碑,而无需为每课单独创建分支。会话按存储库分组显示在侧边栏中,选择任一会话即可切换。 会话中包含三类内容:与智能体的**对话**、智能体探索和编辑文件时的**工具活动**,以及带有差异的**已更改文件**列表。 @@ -36,16 +36,20 @@ Tailspin Toys 中的每款游戏都可以有星级评分,该评分已显示在 ![GitHub Copilot app 提示框,其中存储库选择器设为 tailspin-toys,提示框下方显示模型选择器](../../_images/app-2-start-session.png) -4. 使用以下提示词请求更改: +4. 在提示框下方选择 **new working tree** 和 **Interactive** 模式。使用以下提示词请求更改: ```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. + 编辑前,确定当前检出目录和分支,确认这是一个干净的新工作树,获取 origin,并将当前会话分支快进到 origin/main。确认 HEAD 与 origin/main 一致。如果工作树不干净、已发生分叉或无法更新,停止并说明原因;不要重置或丢弃工作。 + + 在游戏卡片上显示每款游戏的星级评分。Game 类型已包含 starRating 字段,表示满分为 5 的评分,游戏尚未评分时为 null。在 src/components/GameCard.astro 的每张卡片上显示评分;当 starRating 为 null 时,改为显示 "No rating yet"。保持改动小,不要重构卡片布局或更改数据模型。 + + 遵循存储库指令,添加或更新适当的测试,并运行相关的现有 npm 检查。检查先决条件,并在安装任何内容前先询问。报告更改的文件和检查结果,然后停止,供我审查。不要提交、推送、打开拉取请求或实现其他功能。 ``` > [!NOTE] > 请注意,提示词包含了 Copilot 要更新的文件名。虽然不要求指定 Copilot 应在工作中包含哪些文件,但指出正确方向既能帮助 Copilot 快速生成代码,也能减少令牌用量。 -5. 选择 Enter 将提示词发送给 Copilot。 +5. 按 Enter 将提示词发送给 Copilot。 Copilot app 首先创建新的工作树,即项目的隔离副本。随后,它会探索项目,找到添加新功能所需更新的文件,然后创建必要的代码。现在,你已经使用 Copilot app 添加了一项新功能。 @@ -76,7 +80,9 @@ Copilot app 首先创建新的工作树,即项目的隔离副本。随后, ## 检查更改 -当然,不能只阅读代码就假定它能正常工作,还应进行视觉测试。为此,需要从终端启动应用,再确认一切正常。Copilot app 恰好内置了终端。 +打开浏览器前,先审查智能体的自动化检查结果。确认测试覆盖数值类型的 `starRating` 和 `null` 回退状态,并使用项目现有的 npm 脚本,而不是尚未创建的技能。缺少先决条件或跳过检查不算通过。 + +然后使用会话内置的终端手动检查应用。启动服务器前先确定工作树,不要复用其他检出目录的服务器。 1. 在 Copilot app 右侧的审查面板中选择 **Terminal**。如果没有 **Terminal** 按钮,请选择 **+**(标记为 **Open in panel**),再选择 **Terminal**。 @@ -89,26 +95,30 @@ Copilot app 首先创建新的工作树,即项目的隔离副本。随后, ``` 3. 服务器启动后(只需片刻),打开浏览器窗口。 -4. 转到 [http://localhost:4321](http://localhost:4321)。 -5. 现在应能在主页上的所有游戏中看到星级评分。 +4. 打开服务器输出的本地 URL,通常是 `http://localhost:4321`。如果端口已被占用,应先确认其归属,而不是停止无关进程。 +5. 确认已评分的游戏卡片显示满分为五分的评分值。如果有未评分数据,确认显示 **No rating yet**;否则,使用自动化测试验证空值情况,不要声称已亲眼观察到它。 6. 返回终端窗口。 -7. 选择 Ctrl+C 停止开发服务器。 +7. 按 Control+C(Mac)或 Ctrl+C(Windows/Linux),停止自己启动的开发服务器。 ## 打开并合并第一个拉取请求 -更改看起来没有问题,现在可以交付。你将要求智能体打开拉取请求,然后在 github.com 上自行审查并合并。目前先手动管理此流程,后续课程将探索 Copilot 如何自动处理其中部分工作。 +更改看起来没有问题,现在可以交付 PR 1。先单独授权提交和创建 PR,不要与实现授权混在一起: + +```plaintext +审查星级评分改动及其测试的完整差异,汇总验证结果,并在当前会话分支上提交已审查的更改。推送分支,并使用存储库的 PR 模板创建以 main 为目标的拉取请求。不要合并。 +``` -1. 在右上角选择 **Create PR**。 +1. 打开会话中已创建的 PR 链接。如果应用显示 **Create PR** 确认提示,选择它以批准请求,不要创建第二个 PR。 2. 如果系统提示,请选择 **Sign in with your browser**,并按照提示完成身份验证。 3. Copilot 开始创建 PR。 -PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后,右上角的按钮会变为 **Ready to merge**,表示 PR 已可合并。 +PR 创建后,在 **My work** 中检查完整的 PR 差异和检查结果。阅读练习存储库的工作流结果,等待必需的检查和审查完成,并在合并前解决失败项。**Ready to merge** 不能替代对更改或本地验证证据的审查。 4. 选择聊天上方的 **PR** 气泡,在审查窗格中打开并查看拉取请求。可根据需要在此审查 PR。 5. 准备好后,选择 **Ready to merge**。 6. 在新对话框窗口中选择 **Merge pull request**,合并拉取请求。 -现在,新功能已推送到网站。 +确认 PR 1 已合并到 `main` 后再继续。合并练习存储库本身并不会部署网站。下一课会创建新工作树,并从 `origin/main` 更新,以包含此 PR。 ## 总结与后续步骤 @@ -118,7 +128,7 @@ PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后 - 指示智能体对游戏卡片进行一项范围明确的小改动。 - 在工作区差异视图中审查了更改。 - 在本地运行应用,并在浏览器中确认了星级评分。 -- 打开并自行在 github.com 上合并了拉取请求。 +- 打开了 PR 1,审查了检查结果,并明确执行了合并。 接下来,你将从待办事项中的一个议题开始,使用应用向存储库添加自定义指令标准。继续学习[第 3 课 - 使用自定义指令引导 Copilot][next-lesson]。 @@ -129,6 +139,7 @@ PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后 - [使用 GitHub Copilot app 管理议题和拉取请求][managing-issues-prs] [prior-lesson]: ../1-install-copilot-app/#安装并配置-github-copilot-app +[previous-lesson]: ../1-install-copilot-app/ [next-lesson]: ../3-custom-instructions/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions [about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app diff --git a/docs/zh-cn/app/3-custom-instructions.md b/docs/zh-cn/app/3-custom-instructions.md index 5ab57279..04948f8e 100644 --- a/docs/zh-cn/app/3-custom-instructions.md +++ b/docs/zh-cn/app/3-custom-instructions.md @@ -1,9 +1,9 @@ --- title: "第 3 课 - 使用自定义指令引导 Copilot" -description: "使用 GitHub Copilot app 向存储库添加自定义指令标准,从待办议题开始,并通过拉取请求合并更改。" +description: "添加文档标准,在一个现有的小型辅助函数或组件上展示其效果,并通过第二个拉取请求一并合并。" authors: - geektrainer -lastUpdated: 2026-07-09 +lastUpdated: 2026-09-11 --- 使用生成式 AI 时,上下文至关重要。如果任务需要以特定方式完成,或 Copilot 应了解一些背景信息,就应提供这些上下文。[指令文件][instruction-files]是实现此目的最强大的工具之一,它不仅说明需要什么代码,还说明代码应如何组织。本课将向存储库添加文档标准,并采用后续大多数工作的方式:从待办议题开始,让智能体完成更改。 @@ -12,15 +12,17 @@ lastUpdated: 2026-07-09 - 探索存储库指令和路径范围指令文件如何传递给智能体。 - 从待办事项中的指令议题启动会话。 -- 要求智能体向 `.github/copilot-instructions.md` 添加文档标准。 -- 审查更改,并通过拉取请求合并更改。 +- 要求智能体向适当的存储库指令文件添加范围明确的文档标准。 +- 通过一个小型的真实代码改动展示标准的效果,完成验证,并合并 PR 2。 ## 场景 与所有优秀的开发团队一样,Tailspin Toys 针对开发实践制定了一组准则和要求,其中包括: -- 应以 TSDoc 文档注释的形式向代码添加文档。 -- 应记录格式规范,并通过 lint 强制执行。 +- 注释应说明意图和不明显的决策,而不是复述代码。 +- `db/` 和 `src/lib/` 中导出的函数应使用 TSDoc/JSDoc 记录用途、参数和返回值;如果存在可注入的 `db` 参数,也应记录。 +- 可复用的 Astro 组件应记录其 `Props` 契约,并在相关代码变化时同步更新注释。 +- 应保留现有格式和 lint 指导。 通过指令文件,可以确保 Copilot 获得正确的信息,按照这些实践完成任务。 @@ -28,13 +30,13 @@ lastUpdated: 2026-07-09 自定义指令可向 Copilot 提供上下文和偏好,使其更好地理解编码风格与要求。这项强大功能可引导 Copilot 提供更相关的建议和代码片段。你可以指定首选编码约定、库,甚至希望代码中包含的注释类型。可以为整个存储库创建指令,也可以针对特定文件类型提供任务级上下文。 -指令文件分为两类: +项目使用两类指令文件: - `.github/copilot-instructions.md`:每次针对存储库的请求都会发送给 Copilot 的单个指令文件。此文件应包含项目级信息,即与大多数发送给 Copilot 的聊天或 CLI 请求相关的上下文,例如所用技术栈、正在构建的内容概述、最佳实践和其他全局指导。 - `.github/instructions/*.instructions.md`:可针对特定任务或文件类型创建。可以用它们为特定语言(如 TypeScript 或 Astro)提供准则,也可以为创建 UI 组件或一组新单元测试等任务提供指导。 > [!NOTE] -> Copilot 还支持通过 AGENTS.md、CLAUDE.md 和 GEMINI.md 等其他标准引入指令指导,确保 Copilot 始终具有正确的上下文。 +> 其他指令格式及支持情况因操作环境而异。依赖某种格式前,请查阅[自定义指令支持参考][custom-instructions-support]。 ### 管理指令文件的最佳实践 @@ -74,49 +76,55 @@ lastUpdated: 2026-07-09 11. 最后,打开 `.github/instructions/drizzle.instructions.md` 并滚动到底部。注意其中指向其他指令文件(如 `unit-tests.instructions.md`)和项目现有文件的链接。这样可以将较大的指令集拆分为较小的可复用文件,并让 Copilot 在生成代码时参考示例。(其中的路径相对于指令文件,而非存储库根目录。) > [!NOTE] -> `copilot-instructions.md` 中的 **Code formatting requirements** 部分记录了项目编码标准,但尚未要求代码内文档。接下来,你将添加 TSDoc 文档注释和文件注释标头的规则。 +> 添加规则前,将现有指导与实际编码标准议题进行比较。本课关注说明意图的注释、导出的数据层函数文档和 Astro `Props` 契约,而不是统一要求文件标头或复述代码的注释。 ## 从指令议题开始 -上一课通过直接提示词启动了会话。不过,大多数工作都从议题开始。接下来,根据用于更新指令文件的议题创建新会话,再请求更新。 +创建此会话前,确认 PR 1 已合并。为 PR 2 创建新工作树,不要继续使用星级评分分支。大多数工作都从议题开始,因此使用编码标准议题提供需求。 > [!NOTE] > 指令文件对 Copilot 生成的代码影响很大,因此应确保它们能清晰地引导 Copilot。让 Copilot 创建第一版(正如本课将要做的),再由你审查更新是否满足要求,是一种有效方法。 1. 在侧边栏中选择 **My work**。 2. 选择标题为 **Update our repository coding standards** 的议题,将其打开。 -3. 选择右上角的 **New session**,根据该议题启动新会话。 +3. 选择右上角的 **New session**,选择 **new working tree**,再选择 **Interactive** 模式。 ![GitHub Copilot app 的议题视图,箭头指向右上角的 New session 按钮](../../_images/app-new-session-from-issue.png) -4. 使用以下提示词,请求 Copilot 更新指令文件以满足议题中记录的要求: +4. 使用以下提示词。即使应用的本地检出内容已过时,编辑前更新新会话分支,也能确保实际起点是最新合并后的 `main`: - ```plaintext - Following this issue, make the updates to the instructions files in this project to meet the requirements documented. Don't create the PR quite yet! - ``` + ```plaintext + 编辑前,确定当前检出目录和分支,确认这是一个干净的新工作树,获取 origin,并将当前会话分支快进到 origin/main。确认 HEAD 与 origin/main 一致,并包含已合并的星级评分 PR。如果工作树不干净、已发生分叉或缺少该合并,停止;不要重置、丢弃工作或创建其他分支。 + + 阅读议题 "Update our repository coding standards" 和现有存储库指令。添加范围明确的文档约定:说明意图而不是机械过程;使用 TSDoc/JSDoc 记录 db/ 和 src/lib/ 中导出函数的用途、参数、返回值,以及存在时可注入的 db 参数;记录可复用 Astro 组件的 Props 契约;并在相关代码变化时同步更新注释。 + + 将每条规则放入适当的现有指令文件,避免重复或矛盾,并在 README 中链接到或概述更新后的标准。保留现有格式和 lint 指导。不要统一要求文件标头、迁移格式工具、重写整个应用的文档或实现筛选功能。向我展示指令差异,然后停止,供我审查。不要创建技能或智能体、提交、推送或创建 PR。 + ``` Copilot 会进行更新。 ## 审查更改 -接下来阅读 Copilot 所做的更新,并要求它提供根据更新后指令生成的代码示例。 +阅读更新后的指导,再通过真实文件展示其效果。仅提供建议代码片段,无法证明存储库指令影响了代码改动。 1. 选择右上角的 **Changes**,打开代码更改。 ![GitHub Copilot app 会话面板选项卡,箭头指向 Changes 选项卡](../../_images/app-select-changes.png) -2. 审查更新后的指令文件,确认其中包含有关向代码添加文档和注释的准则。 +2. 审查更新后的指令文件和 README 引用。确认规则符合议题的注释理念、导出函数文档要求和组件契约,不要自行添加统一的文件标头要求。 > [!NOTE] > AI 具有概率性而非确定性,因此实际文本会有所不同。 -3. 使用以下提示词,要求 Copilot 创建它现在会生成的代码示例: +3. 审查指令后,在同一会话中请求一个范围明确的示例改动: + + ```plaintext + 在 db/ 或 src/lib/ 中一个现有的小型导出 TypeScript 辅助函数,或一个可复用 Astro 组件上展示更新后的文档约定。检查存储库,选择合适的现有文件;不要假设已有 publishers 辅助函数。进行一项不改变行为的小型可读性改进,并应用相关函数文档或 Props 契约指导。解释不明显的意图,不添加仅复述代码的注释。 - ```plaintext - Do not make any updates, but show me what the code would look like. Based on the new instructions, if I asked Copilot to create a new library component to return all Publishers what would that code look like? - ``` + 将更改限制在该示例及直接相关的测试内。不要实现筛选功能或创建新功能。运行相关的现有 npm 检查,报告更改内容及指令如何影响代码,然后停止,供我审查。在安装任何内容前先询问。不要提交、推送或创建 PR。 + ``` -4. 审查 Copilot 提议的代码。注意其中包含 TSDoc 文档注释和文件标头注释,这正是更新后的指令所要求的内容。 +4. 审查实际文件差异,而不只是聊天回复。检查文档是否说明了真实行为,以及可读性改动是否保留了原有行为。审查相关测试、lint 和类型检查结果,解决失败项后再继续。 现在,你已更新项目中的指令文件,并了解了更新带来的影响。 @@ -124,17 +132,23 @@ Copilot 会进行更新。 指令文件会成为存储库中的资产,与团队其他成员共享。接下来像处理任何其他资产一样,为此次工作创建 PR。 -1. 在右上角选择 **Create PR**。 +先一并授权已审查的指令和示例改动: + +```plaintext +审查编码标准指令、README 引用和范围明确的代码示例的完整差异,包括相关测试。汇总验证结果,并在当前会话分支上提交这些已审查的更改。推送分支,使用存储库的 PR 模板创建一个以 main 为目标的拉取请求,并关联编码标准议题。除非满足议题的每项验收标准,否则将其描述为部分贡献;不要为未完成的工作使用关闭议题的关键字。不要合并。 +``` + +1. 打开会话中的 PR 链接。如果应用显示 **Create PR** 确认提示,选择它,不要创建重复的 PR。 2. 如果系统提示,请选择 **Sign in with your browser**,并按照提示完成身份验证。 3. Copilot 开始创建 PR。 -PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后,右上角的按钮会变为 **Ready to merge**,表示 PR 已可合并。 +在 **My work** 中检查完整的 PR 差异,包括指令和代码更改。审查练习存储库的 CI 结果及必需的审查。在选择 **Ready to merge** 前解决失败项;CI 不能替代示例改动或你的审查。 4. 选择 **Ready to merge**。 5. 在新对话框窗口中选择 **Merge pull request**,合并拉取请求。 > [!NOTE] -> 标准合并到默认分支后,便会成为每位成员和每个新会话的项目组成部分。下一课从最新默认分支启动筛选会话时,智能体会自动遵循此标准。生成的 TypeScript 无需提示便会包含 TSDoc 文档注释。这是指令影响代码生成的一个虽小但真实的示例。 +> 开始筛选功能前,确认 PR 2 已合并到 `main`。仅创建新工作树并不能保证代码是最新的:第 4 课会先获取更新,将新会话分支快进到 `origin/main`,并在规划前确认前两个合并都已包含在内。 ## 总结与后续步骤 @@ -142,10 +156,10 @@ PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后 - 探索了存储库中的 `copilot-instructions.md` 和路径范围 `*.instructions.md` 文件。 - 从待办事项中的指令议题启动了会话。 -- 要求智能体向 `.github/copilot-instructions.md` 添加文档标准。 -- 审查了更改,并通过拉取请求将其合并。 +- 要求智能体向适当的指令文件添加范围明确的文档规则,并从 README 引用这些规则。 +- 检查了标准对真实代码改动的影响,验证了结果,并通过 PR 2 一并合并。 -接下来,你将在新会话中构建筛选功能,并观察它如何采用刚合并的标准。继续学习[第 4 课 - 使用 Autopilot 构建功能][next-lesson]。 +接下来,你将在新会话中构建筛选功能,并检查它是否遵循刚合并的标准。继续学习[第 4 课 - 使用 Plan 和 Autopilot 构建筛选功能][next-lesson]。 ## 资源 @@ -154,6 +168,7 @@ PR 创建后,Copilot 会监视存储库中需要运行的工作流。片刻后 - [创建自定义指令的最佳实践][instructions-best-practices] - [Awesome Copilot:指令文件和其他资源集合][awesome-copilot] +[previous-lesson]: ../2-add-star-rating/ [next-lesson]: ../4-build-filtering/ [instruction-files]: https://docs.github.com/copilot/customizing-copilot/about-customizing-github-copilot-chat-responses [customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/zh-cn/app/4-build-filtering.md b/docs/zh-cn/app/4-build-filtering.md index 653e19d1..e2bf470e 100644 --- a/docs/zh-cn/app/4-build-filtering.md +++ b/docs/zh-cn/app/4-build-filtering.md @@ -1,186 +1,128 @@ --- -title: "第 4 课 - 使用 Autopilot 构建功能" -description: "在 GitHub Copilot app 中使用 Plan 和 Autopilot 模式构建静态客户端筛选功能,观察它如何继承文档标准,并使用智能体技能进行验证。" +title: "第 4 课 - 使用 Plan 和 Autopilot 构建筛选功能" +description: "根据议题规划筛选功能,明确批准 Autopilot,使用现有 npm 检查和手动浏览器访问进行验证,并保存检查点。" authors: - geektrainer -lastUpdated: 2026-07-13 +lastUpdated: 2026-09-11 --- -本项目已完成一些小更新。但更复杂的更改需要更完善的流程。GitHub Copilot app 可以配合现有流程,确保以正确的方式构建正确的内容。这是连续三节课程中的第一节,你将遵循典型开发流程:先使用议题生成新功能,再使用智能体技能运行验证测试和 lint。 +你已合并星级评分、文档标准及其代码示例。现在开始构建筛选功能。这是一个较大 PR 里程碑的起点:第 4–8 课始终沿用同一会话、工作树和分支。 本课将介绍如何: -- 从筛选议题启动新会话。 -- 使用 **Plan** 模式规划功能,再通过 **Autopilot** 构建功能。 -- 确认生成的代码遵循之前合并的文档标准。 -- 使用项目的 `quality-checks` 技能验证工作。 +- 从更新后的 `main` 开始,并阅读实际的筛选议题。 +- 在 **Plan** 模式中明确需求,再明确批准 **Autopilot**。 +- 审查筛选功能和测试,然后运行四项现有 npm 检查。 +- 在浏览器中手动检查功能,并保存检查点。 + +技能、MCP 验证、QA 配置文件及功能 PR 将在后续模块中完成。不要在此实现步骤中提前创建它们。 ## 场景 -主页列出了所有游戏,但访问者无法缩小列表范围。筛选议题要求允许用户按**类别**和**发行商**筛选游戏。接下来使用 Copilot 实现该功能。 +Tailspin Toys 的游戏目录不断扩大,访客需要按类别和发行商缩小游戏范围。待办 issue 描述了功能,但类别如何组合等细节需要在编码前达成共识。你将使用 Plan 模式确定这些决策,然后授权 Autopilot 在明确范围内实现功能。 -## 背景 +## 会话模式 -将 AI 编码智能体引入开发流程不会改变基本原则。事实上,这些原则反而更加重要。大多数开发人员遵循类似以下的流程: +提示框下方的模式选择器控制智能体的自主程度: -1. 打开已创建的议题,查看需要完成的工作详情。 -2. 为需要构建的内容制定计划。 -3. 构建并审查代码。 -4. 运行测试以验证代码。 -5. 手动验证新功能。 -6. 创建拉取请求 (PR)。 -7. 代码通过审查且持续集成流程成功后,合并代码。 +- **Interactive** 让你在智能体工作和请求输入时持续参与。 +- **Plan** 在实现前准备计划,供你审查。 +- **Autopilot** 在批准的范围和权限内自主实现并迭代。 -> [!NOTE] -> 具体流程会因团队和组织而异,但大多数流程都是以上主题的变体。 +先规划,再明确批准,创建可复用的自定义配置前切回 Interactive。 -坚持这种标准方法,可以确保 AI 生成的代码满足既定要求,并经过与手写代码相同的审查流程。 +## 从更新后的 main 开始 -## 会话模式 +确认 PR 1 和 PR 2 已在 GitHub 上合并。为筛选功能创建新工作树,不要继续使用之前的任一分支。 -**会话模式**控制智能体的自主程度。可以从提示词字段下方的下拉菜单中设置模式,并随时更改: +1. 选择 **My work**,按标题找到 **Allow users to filter games by category and publisher**。打开议题并复制其实际 URL;不同存储库中的议题编号可能不同。 +2. 选择 **New session**,再选择 **new working tree**。更新基线时保持 **Interactive** 模式。 -- **Interactive**:你与智能体协同工作。智能体提出更改建议,并等待输入后再继续。 -- **Plan**:智能体先创建计划。你审查并批准计划后,智能体才会执行。 -- **Autopilot**:智能体完全自主工作,包括编写代码、运行测试和迭代,无需等待输入。 + ![GitHub Copilot app 的议题视图,箭头指向 New session 按钮](../../_images/app-new-session-from-issue.png) -## 规划筛选功能 +3. 在规划或编辑前发送以下准备请求: -发现潜在问题的最佳时机是在编写任何代码之前,而提前规划正是最好的方法。让 Copilot 进行规划时,它会生成一组步骤,并记录将采用的方法。你可以审查计划并提出改进建议,然后让 Copilot 根据计划生成代码。 - -接下来打开议题、启动新会话,再切换到 Plan 模式并发出请求,以创建计划。 + ```plaintext + 准备这个新的筛选会话,不要实现任何内容。确定检出目录和分支,确认工作树干净,获取 origin,并将当前会话分支快进到 origin/main。确认 HEAD 与 origin/main 一致,并包含已合并的星级评分和编码标准 PR。 -1. 在导航选项卡中选择 **My work**。 -2. 选择标题为 **Allow users to filter games by category and publisher** 的议题。 -3. 选择右上角的 **New session**。 + 如果检出目录不干净、已发生分叉或缺少任一合并,停止并说明原因。不要重置或丢弃工作、切换分支、创建其他分支或编辑应用文件。报告基线修订版本。 + ``` - ![GitHub Copilot app 的议题视图,箭头指向右上角的 New session 按钮](../../_images/app-new-session-from-issue.png) +4. 检查报告中的基线。仅获取更新不会更新工作树:工作开始前,当前会话分支必须完成快进,且其 `HEAD` 必须与获取后的 `origin/main` 一致。 -4. 选择 Shift+Tab,直到模式显示为 **Plan**。 +## 规划筛选功能 - ![GitHub Copilot app 提示框,箭头指向设为 Plan 的模式选择器](../../_images/app-4-plan-mode.png) +将模式选择器切换为 **Plan**。把下方的议题占位符替换为刚复制的 URL。 -5. 发送以下提示词。由于会话从筛选议题启动,因此该议题已在会话上下文中: +```plaintext +根据此议题规划筛选功能:。阅读完整验收标准和存储库指令,然后检查当前的静态 Astro 应用、现有数据访问辅助函数及测试。暂时不要实现。 - ```plaintext - Plan the work based on the requirements documented in the issue. Please ask any clarifying questions you might have as you build the plan. - ``` +涵盖议题要求的多类别选择、发行商筛选、类别与发行商组合筛选、适当的数据访问辅助函数、无障碍控件,以及单元测试和端到端测试覆盖。对于未明确的行为,例如多个类别如何组合、清除筛选和空结果,请让我决定,不要悄悄编造需求。除非需求和现有架构确有依据,否则不要引入服务器 API。 -6. 智能体在制定计划时可能会提出后续问题。根据你会如何构建功能来回答这些问题。 +提出范围明确的实现和验证计划,遵循存储库文档约定,并添加或更新必要的单元测试和端到端测试。在 package.json 中确认命令后,计划使用项目现有工具运行 npm run lint、npm run test:unit、npm run test:e2e 和 npm run typecheck:all。将议题 URL 和我批准的澄清内容记录在计划中,以便用于 QA。 -> [!NOTE] -> Copilot 具有概率性,因此它提出的具体后续问题会有所不同。事实上,它可能不会提出任何问题,这完全正常。 +在我批准前,将以下执行保障纳入计划:确定被测检出目录和服务器;运行检查前检查先决条件;安装软件、依赖项或浏览器前先询问;不要复用其他工作树的服务器;仅停止自己启动的服务器;报告其他端口冲突,不要停止无关进程。必须将缺少先决条件和跳过检查报告为阻塞项,而不是通过。 -7. 完成后,Copilot 会提供计划摘要。审查该计划,应会看到构建查询、添加筛选控件和测试的建议。可以根据需要提供反馈来完善计划,智能体会将建议纳入新版本。 +将以下实现边界纳入计划:在我明确批准 Autopilot 后,仅在同一工作树和分支上实现约定的筛选功能及其测试,运行四项检查,报告实现情况和全部检查结果,包括失败或阻塞项,然后停止,供我审查并进行手动浏览器检查。实现期间不要创建技能或自定义智能体、配置 MCP、更改分支、提交、推送或打开 PR。手动浏览器检查和检查点提交将在之后由我单独指示。 -## 使用 Autopilot 构建 +目前保持 Plan 模式,完成计划后停止,供我审查。不要实现、创建技能或自定义智能体、配置 MCP、更改分支、提交、推送或打开 PR。 +``` -计划创建后,让 Copilot 构建实现。 +回答澄清问题,并根据议题审查计划。检查其中是否包含数据访问改动、无障碍控件和测试,不要接受仅实现 UI 的方案。保存计划中的实际议题 URL 和批准的澄清内容,以供第 6 课和第 7 课使用;如果无需附加标准,使用 `none`。 -1. 在 **Plan summary** 对话框的选项列表中,选择最接近 **Approve and implement with autopilot** 的选项。 +批准前,确认计划本身包含四项检查、文档约定、先决条件和服务器保障、保持同一工作树及分支的要求,以及实现和验证后停止的边界。计划必须禁止在实现期间提前创建技能、智能体、设置 MCP、提交、推送和创建 PR。如果缺少任何边界,保持 **Plan** 模式请求修订计划,检查修订版后再批准。 -Copilot 将开始实现。 +## 明确批准 Autopilot -> [!NOTE] -> 如果 Copilot 未自动开始创建所需代码,可以使用类似 "Go ahead and start building out the plan!" 的提示词让它继续。 -> -> 创建所需更新需要几分钟。智能体会编辑和创建文件、编写并运行测试,以及进行迭代。此时可以回顾目前探索的内容,或稍作休息。 +只有经过审查的计划已包含需求和全部执行边界,才能在计划批准控件中选择 **Approve and implement with autopilot**,或当前版本中等效的明确 Autopilot 选项。确认模式指示器显示 **Autopilot**。 -## 审查更改 +批准后可能立即开始执行。因此,所有实现范围、安全规则和停止边界都必须在批准前写入已审查的计划;不要依赖执行开始后再通过后续消息补充。 -所有 AI 生成的代码在合并前都需要审查。接下来审查代码并运行网站,确保一切正常。 +Autopilot 可以编写代码和测试,并针对失败进行迭代,但这并不意味着获准完成后续研讨会模块。缺少先决条件是需要获批后解决的阻塞项,不是通过了检查。 -1. 选择右上角的 **Changes**,打开代码更改。 +## 审查并验证实现 - ![GitHub Copilot app 会话面板选项卡,箭头指向 Changes 选项卡](../../_images/app-select-changes.png) +1. 打开 **Changes**,检查筛选实现和测试。 +2. 对照议题和批准的澄清内容检查结果,包括多类别及发行商组合。检查新增或修改的辅助函数是否遵循第 3 课的文档标准。 +3. 查看全部四项 npm 检查的实际命令输出。此时直接运行命令,因为尚未创建 quality-checks 技能。 +4. 接受实现前,解决失败项并重新运行受影响的检查。Playwright 的 E2E 配置会构建并提供预览服务,且可能复用本地服务器;确保被测服务器属于此工作树,而不是之前的课程。 -2. 审查更改。应会看到新的 TypeScript、Astro 和测试文件。注意,新辅助函数包含 TSDoc 文档注释和文件标头注释。这是第 3 课中合并的文档标准,无需提示便已自动应用。 -3. 在 Copilot app 右侧的审查面板中选择 **Terminal**。如果没有 **Terminal** 按钮,请选择 **+**(标记为 **Open in panel**),再选择 **Terminal**。 +## 手动检查功能 - ![GitHub Copilot app 审查面板中的 Terminal 按钮](../../_images/app-terminal-screenshot.png) +手动审查前,将会话切回 **Interactive** 模式,并在第 5 课中保持该模式。 -4. 在终端窗口中输入以下命令,启动 Web 应用的开发服务器: +1. 在此会话的审查面板中打开 **Terminal**。如有需要,选择 **+**,再选择 **Terminal**。 +2. 确认终端位于筛选工作树中,然后运行: ```shell npm run dev ``` -5. 服务器启动后(只需片刻),打开浏览器窗口。 -6. 转到 [http://localhost:4321](http://localhost:4321)。 -7. 现在应能在主页上看到筛选器。 -8. 如果有任何问题,可以要求 Copilot 进行更新。 -9. 满意后,返回终端窗口。 -10. 选择 Ctrl+C 停止开发服务器。 - -## 使用 quality-checks 技能验证工作 +3. 在浏览器中打开此服务器输出的 URL,通常是 `http://localhost:4321`。如果端口已被占用,应先确定其归属,不要停止无关进程,也不要假定现有服务器包含本次更改。 +4. 按批准的行为测试类别选择、发行商选择及两者组合。检查键盘访问,以及约定的清除筛选和空结果行为。 +5. 如果发现失败,请求针对性修正,审查差异,重新运行受影响的自动化检查,再重复相关浏览器检查。 +6. 返回终端,按 Control+C(Mac)或 Ctrl+C(Windows/Linux),停止自己启动的服务器。下一模块运行 E2E 前,确认服务器已停止。 -可以仅查看差异就认为工作完成,但团队已经定义了质量标准和可重复的检查方式。 +这是你的手动浏览器观察。第 6 课才会通过 MCP 由智能体观察浏览器。 -**智能体技能**可指导 Copilot 如何执行重复性任务,例如运行测试、生成构建或创建拉取请求。技能是一个包含指令、脚本和资源的文件夹,智能体可以按需加载。[Agent Skills 是一项开放标准][agent-skills-repo],适用于多种智能体,因此同一技能可在智能体模式下的 Copilot Chat、Copilot cloud agent、Copilot CLI 和 GitHub Copilot app 中使用。 +## 保存检查点 -技能位于项目的 `.github/skills` 文件夹或全局 `~/.copilot/skills` 中。每个技能都在一个文件夹中,其中包含具有 YAML frontmatter(`name` 和 `description`)及 Markdown 指令的 `SKILL.md` 文件: +审查更改和验证结果后,授权创建本地提交: -```yaml ---- -name: quality-checks -description: Run the project's test suites and linter to verify code changes are ready to commit, push, or merge. ---- +```plaintext +审查当前差异,为筛选实现及其测试创建检查点提交。保持同一筛选分支和工作树。不要创建技能或智能体、配置 MCP、推送或打开拉取请求。 ``` -技能还可包含脚本、资产和参考资料子文件夹。[智能体技能规范][agent-skills-spec]介绍了完整结构。 - -> [!TIP] -> 技能会动态加载。智能体根据 `description` 字段决定适用的技能。清晰且针对具体场景的说明决定了技能是会被使用还是被忽略。 - -## 探索 quality-checks 技能 - -接下来探索该技能,了解其作用。 - -1. 如果审查面板尚不可见,请选择右上角的 **Toggle review panel** 将其打开。 - - ![GitHub Copilot app 顶部工具栏,箭头指向 Create PR 右侧的 Toggle review panel 按钮](../../_images/app-2-review-panel.png) - -2. 选择 **+**,向审查面板添加新项目。 -3. 选择 **File**。 -4. 搜索 `SKILL.md`。 -5. 从文件列表中选择 `SKILL.md .github/skills/quality-checks` 将其打开。 -6. 注意 `name` 和 `description`。说明会告知智能体*何时*使用该技能,即每当代码更改需要在提交、推送或合并前进行测试、lint 或验证时。 -7. 阅读该技能。它记录了哪个脚本运行哪个套件(单元测试、Playwright 端到端测试、ESLint)、运行顺序,以及如何调试常见故障。因此,智能体会按团队规定的方式运行检查,而不是猜测。 - -## 运行检查 - -在同一筛选会话中,要求智能体验证工作。你无需说出技能名称,智能体会根据请求进行匹配。 - -1. 返回 Copilot app。 -2. 使用 slash command `/quality-checks` 直接调用技能,然后选择 Enter。 -3. 智能体按照技能运行单元测试、lint 和端到端测试,并报告结果。如果有任何失败,请要求它修复问题并重新运行检查,直到全部通过。 -4. **保持此会话打开。**下一课将添加 Playwright MCP 服务器,并使用它在真实浏览器中查看筛选功能。 - ## 总结与后续步骤 -你端到端构建了一项真实功能,并按照团队的质量标准进行了验证。具体而言,你: - -- 从最新项目的筛选议题启动了新会话。 -- 使用 Plan 模式规划功能,并使用 Autopilot 构建功能。 -- 确认生成的辅助函数遵循第 3 课中合并的文档标准。 -- 使用 `quality-checks` 技能验证了工作。 - -接下来,你将连接 Playwright MCP 服务器,并要求智能体在真实浏览器中探索筛选功能。继续学习[第 5 课 - 使用 Playwright MCP 服务器测试][next-lesson]。 +你已明确筛选需求、审查实现和测试,并手动检查功能。此检查点属于 PR 3,而不是单独的 PR。保持 **Interactive** 模式,在同一会话中继续学习[第 5 课 - 创建并使用 quality-checks 技能][next-lesson]。 ## 资源 - [在 GitHub Copilot app 中使用智能体会话][agent-sessions] -- [关于 Agent Skills][about-agent-skills] -- [自定义 GitHub Copilot app][customize-app] - [关于 GitHub Copilot 的云沙盒和本地沙盒][sandboxes] -[ex0]: ../0-prerequisites/ -[ex2]: ../2-add-star-rating/ -[ex3]: ../3-custom-instructions/ -[next-lesson]: ../5-mcp-playwright/ +[previous-lesson]: ../3-custom-instructions/ +[next-lesson]: ../5-agent-skills/ [agent-sessions]: https://docs.github.com/copilot/how-tos/github-copilot-app/agent-sessions -[about-agent-skills]: https://docs.github.com/copilot/concepts/agents/about-agent-skills -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app [sandboxes]: https://docs.github.com/copilot/concepts/about-cloud-and-local-sandboxes -[agent-skills-repo]: https://github.com/agentskills/agentskills -[agent-skills-spec]: https://agentskills.io/specification \ No newline at end of file diff --git a/docs/zh-cn/app/5-agent-skills.md b/docs/zh-cn/app/5-agent-skills.md new file mode 100644 index 00000000..f80bb2ca --- /dev/null +++ b/docs/zh-cn/app/5-agent-skills.md @@ -0,0 +1,99 @@ +--- +title: "第 5 课 - 创建并使用 quality-checks 技能" +description: "让 Copilot 创建带有配套 shell 脚本的可复用质量检查技能,检查技能内容,并在筛选功能分支上执行。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +筛选功能已经实现,并已使用现有 npm 命令完成检查。现在,将这些检查封装为可复用的**智能体技能**。第 4–8 课始终使用同一个筛选功能会话和分支;本课不创建 pull request。 + +在本课中,将: + +- 在创建自定义配置前返回 **Interactive** 模式。 +- 让 Copilot 创建 `quality-checks`,然后停下来供你检查。 +- 通过配套脚本执行全部四项检查,并证明单文件测试参数只会选中指定文件。 +- 在筛选功能分支上为技能创建检查点。 + +## 场景 + +每次修改筛选功能,Tailspin Toys 都需要运行相同的质量检查。团队希望使用可复用的技能,而不是在每次对话中解释命令和前提条件。你将创建技能、检查脚本,并验证后续请求能否正确运行这些检查。 + +## 指令、脚本和资源 + +技能将可复用的任务指令、可执行脚本和辅助资源打包,供智能体按需加载。自定义智能体定义专业角色、指令和可用工具。两者相辅相成:自定义智能体可以执行脚本,包括技能附带的脚本。 + +存储库技能位于 `.github/skills//SKILL.md`,包含带有 `name` 和 `description` 的 frontmatter 以及 Markdown 指令。脚本和其他资源存放在旁边。这里将让 Copilot 生成 `.github/skills/quality-checks/SKILL.md` 及其配套脚本,而不是复制现成答案。[Agent Skills 规范][skill-spec]介绍了这种格式。 + +Copilot 根据已发现技能的描述,决定何时加载它。不要假定新技能会立即被已打开的会话发现;运行部分提供了明确读取技能的备用方式。格式可移植并不意味着无需满足 shell 或项目的前提条件。 + +## 创建技能 + +发送提示前,通过模式选择器将筛选功能会话切回 **Interactive** 模式。保持当前检出目录和分支。如果使用的旧版模板已经包含此技能,应先检查并扩展它,而不是覆盖已有的自定义内容。 + +```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 中提供 name 和 description frontmatter、运行全部四个封装脚本的指令、前提条件、故障排查方法,以及包含一个现有单元测试文件的可移植调用示例。所有 Bash 示例都必须显式调用 bash;绝不绕过 PowerShell 执行策略。解释 Playwright 的服务器复用:只停止确实由自己启动的服务器,否则先询问。 + +只创建技能和必需的脚本。不要运行检查或探测,不要安装任何内容、修改应用代码、提交或创建 PR。然后停止,等待检查。 +``` + +## 检查技能 + +1. 打开 **Changes** 查看生成的文件。也可以在审查面板中依次选择 **+**、**File**,然后搜索 `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。 + +## 运行技能 + +确认上一课的开发服务器已停止。Playwright 会为 E2E 构建并提供预览服务,但其本地配置可以复用端口 `4321` 上的服务器。其他检出目录的服务器不能为当前功能提供有效证据。 + +如果 app 提供 `/quality-checks`,选择它来显式调用已发现的技能,并附上以下请求。如果未发现技能,直接在此会话中发送相同请求;本练习支持通过读取技能的方式运行它。 + +```plaintext +读取 .github/skills/quality-checks/SKILL.md,并按照其中的指令验证此检出目录中的筛选功能。先检查每个封装脚本的代码,确认其推导出的目录包含此检出目录中预期的 package.json,且根目录无效时会明确报错并失败退出,而不是依赖 npm 在祖先目录中查找包。不要为模拟失败而移动、重命名、删除或修改存储库文件。实际运行其配套脚本,执行 lint、单元测试、端到端测试和类型检查。同时运行文档中只运行一个单元测试文件的示例,直接传递目标工具的参数,因为 npm 的 -- 分隔符由封装脚本负责。根据测试运行器的结果,确认仅运行了指定文件,并报告该文件名及实际执行的测试文件数量。仅回显参数或返回退出代码 0,不能证明文件选择正确。 + +报告每次脚本调用及其结果,包括失败、跳过的检查或缺失的前提条件。不要在技能脚本无法使用时悄悄改为直接运行 npm 命令。确认待测试的检出目录和服务器,只停止你启动的服务器,并在安装任何内容或停止其他进程前询问。不要修改应用代码、切换分支、提交、推送或创建 pull request。 +``` + +检查工具调用和输出。四个脚本都必须实际执行;描述检查内容或跳过检查都不算通过。对于单文件示例,将请求的文件名与运行器实际输出的文件结果及报告的数量进行比较:应只运行该文件。如果还运行了其他文件,回显参数或退出代码 0 都不足以证明正确。失败是有用的证据:修正技能,或在获批后解决环境配置阻碍,再重新运行受影响的检查。不要停止无关进程,也不要强行消除端口冲突。 + +## 保存检查点 + +检查技能及其运行结果后,授权创建本地检查点: + +```plaintext +检查当前差异,仅为 quality-checks 技能文件创建检查点提交。保留现有筛选功能分支。不要推送或创建 pull request。 +``` + +## 总结与后续步骤 + +你已创建、检查并运行可复用的 quality-checks 技能,包括其单文件测试示例。技能文件将与筛选功能、QA 配置和相关测试一起纳入第 8 课的功能 PR。继续在同一会话中完成[第 6 课 - 使用 Playwright MCP 验证功能][next-lesson]。 + +## 更多技能示例 + +以下社区示例仅供参考,不是额外任务。采用前先检查其前提条件和行为: + +- [贡献工作流:`make-repo-contribution`][contribution-example]。 +- [需求文档:`prd`][prd-example]。 +- [图表及配套导出脚本:`drawio`][drawio-example]。 +- [浏览器测试:`webapp-testing`][browser-example]。 + +上游贡献示例名为 `make-repo-contribution`;旧版 Tailspin 模板使用另一个名称 `make-contribution`。本工作坊不依赖其中任何一个贡献技能。 + +[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/app/5-mcp-playwright.md b/docs/zh-cn/app/5-mcp-playwright.md deleted file mode 100644 index 5e288516..00000000 --- a/docs/zh-cn/app/5-mcp-playwright.md +++ /dev/null @@ -1,86 +0,0 @@ ---- -title: "第 5 课 - 使用 Playwright MCP 服务器测试" -description: "将 Playwright MCP 服务器添加到 GitHub Copilot app,并要求智能体在真实浏览器中手动测试筛选功能。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -上一课使用项目的自动化测试套件创建并验证了筛选功能。测试可以自动验证代码,但让智能体确认行为同样很有价值。智能体可以对它在实际 UI 中发现的问题作出响应。接下来探索 MCP 如何让 AI 智能体访问外部功能,并添加 Playwright MCP 服务器,使 Copilot 可以直接与正在构建的网站交互。 - -本课将介绍如何: - -- 了解模型上下文协议 (MCP) 及 GitHub Copilot app 如何使用它。 -- 从应用设置中添加 Playwright MCP 服务器。 -- 要求智能体操控浏览器并探索筛选功能。 - -## 场景 - -单元测试和端到端测试很重要,但验证 UI 更新需要实际与 UI 交互。你希望 Copilot 能像用户一样使用正在开发的网站,以进一步自动执行更改并提高对更新符合预期的信心。 - -## 什么是模型上下文协议 (MCP)? - -[模型上下文协议 (MCP)][mcp-blog-post] 为 AI 智能体提供了与外部工具和服务通信的方式。借助 MCP,AI 智能体可以实时与外部工具和服务通信。这让它们既能访问最新信息(使用资源),也能代表你执行操作(使用工具)。 - -这些工具和资源通过 MCP 服务器访问。MCP 服务器是 AI 智能体与外部工具和服务之间的桥梁,负责管理双方的通信。外部工具可以是现有 API,也可以是 NPM 包等本地工具。每个 MCP 服务器代表 AI 智能体可访问的一组不同工具和资源。 - -以下是两种常用的现有 MCP 服务器: - -- [**GitHub MCP Server**](https://github.com/github/github-mcp-server):提供一组用于管理 GitHub 存储库的 API。AI 智能体可以创建新存储库、更新现有存储库,以及管理议题和拉取请求。 -- [**Playwright MCP Server**][playwright-mcp-server]:使用 Playwright 提供浏览器自动化功能。AI 智能体可以转到网页、填写表单和选择按钮。 - -还有许多其他 MCP 服务器可用于访问不同的工具和资源。GitHub 托管了一个 [MCP registry](https://github.com/mcp),以提高生态系统的可发现性并促进贡献。 - -> [!CAUTION] -> 应像对待项目中的任何其他依赖项一样对待 MCP 服务器。使用前请仔细审查其源代码、验证发布者并考虑安全影响。仅使用可信的 MCP 服务器,并谨慎授予对敏感资源或操作的访问权限。 - -## 添加 Playwright MCP 服务器 - -可以在应用设置中添加和管理 MCP 服务器。应用内置了常用服务器目录,只需几个步骤即可添加 [Playwright MCP 服务器][playwright-mcp-server]。 - -1. 选择 Ctrl+, 打开 Copilot app 设置页面。 -2. 选择 **MCP servers**。 -3. 在搜索对话框中输入 `Playwright`。 -4. 从 **Popular MCP servers** 列表中选择 **Playwright**。 -5. 选择 **Add server**,将其添加到可用 MCP 服务器列表。 -6. 选择 Esc 关闭设置对话框。 - -现在,Playwright MCP 服务器已添加。 - -## 要求 Copilot 通过 Playwright 探索功能 - -接下来要求 Copilot 使用 Playwright MCP 服务器手动测试该功能。 - -1. 使用以下提示词,要求 Copilot 验证新功能: - - ```plaintext - Start the dev server then use the Playwright MCP server to validate the functionality you just added exists. Use the details in the issue to ensure the newly added behavior matches the specs. - ``` - -Copilot 将通过 Playwright MCP 服务器启动浏览器、逐步执行每项操作并报告发现的结果。你会实际看到它在系统上打开浏览器执行任务。 - -2. 对照议题中的验收标准阅读摘要。如果发现问题,请提出后续问题,或要求它在打开拉取请求前修复代码。 -3. 保持此会话打开,下一课将完成该会话。 - -现在,Copilot 已像用户一样探索功能,并在浏览器中验证了其行为。 - -## 总结与后续步骤 - -你使用 Playwright MCP 服务器,从 GitHub Copilot app 在真实浏览器中探索了功能。总结来说,你: - -- 了解了模型上下文协议 (MCP),以及应用如何提供 MCP 工具。 -- 从应用设置中添加了 Playwright MCP 服务器。 -- 要求智能体操控浏览器并探索筛选功能。 - -功能已构建、验证并确认可以正常工作。现在可以使用 **Agent Merge** 打开并合并拉取请求。继续学习[第 6 课 - 使用 Agent Merge 合并][next-lesson]。 - -## 资源 - -- [MCP 是什么?为什么每个人都在谈论它?][mcp-blog-post] -- [Microsoft Playwright MCP Server][playwright-mcp-server] -- [在 GitHub Copilot app 中配置 MCP 服务器][customize-app] - -[next-lesson]: ../6-agent-merge/ -[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ -[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp -[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/6-agent-merge.md b/docs/zh-cn/app/6-agent-merge.md deleted file mode 100644 index 6001d43d..00000000 --- a/docs/zh-cn/app/6-agent-merge.md +++ /dev/null @@ -1,67 +0,0 @@ ---- -title: "第 6 课 - 使用 Agent Merge 合并" -description: "打开筛选功能的拉取请求,在 My work 中进行审查,并让 Agent Merge 修复阻塞项并完成合并,这是合并自动化阶梯的最高一级。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -筛选功能已构建、验证,并确认可以在浏览器中正常工作。最后一步是将其合并。在本学习路径中,你已经合并过两次,每次都是自行打开拉取请求并在 github.com 上合并。这一次将使用 **Agent Merge** 让应用处理繁重工作。它可以在应用内管理拉取请求的整个生命周期。 - -本课将介绍如何: - -- 了解 Agent Merge 及其如何自动执行合并生命周期。 -- 在筛选会话中启用 Agent Merge。 -- 观察它创建拉取请求、运行 CI,并在所有检查通过后合并。 - -## 场景 - -在前几课中,你探索了不同程度的自动化,从创建代码到让 Copilot 直接验证 UI。为了进一步加快开发速度,Tailspin Toys 希望了解是否可以自动合并经过审查和验证的拉取请求。 - -## Agent Merge 简介 - -通过 **Agent Merge**,可以使用 Copilot app 自动执行拉取请求落地前的最后阶段。启用后,应用会话会读取拉取请求并处理阻塞项,包括修复失败的 CI 检查、响应审查意见,以及在需要时变基。GitHub 允许后,它会立即合并。该功能在后台运行,应用重启后仍会继续,并在拉取请求合并后自动关闭。 - -此前,你一直在 github.com 上自行选择 **Merge pull request**。Agent Merge 将这项责任交给智能体,因此它可以管理 PR 直至完成,而你可以继续处理下一项任务。你仍需审查并批准工作,智能体只负责机械性的收尾步骤。 - -## 使用 Agent Merge 管理 PR - -你已手动审查代码、运行测试,甚至让 Copilot 验证了 UI。现在可以将新代码合并到代码库。接下来让 agent merge 管理 PR 的持续集成 (CI) 流程并完成合并。 - -1. 返回上一课中用于添加筛选功能且仍保持打开的会话。 -2. 在右上角选择 **Create PR** 旁的下拉菜单。 -3. 选择 **Agent merge** 以启用 agent merge。 - - ![GitHub Copilot app 中展开的 Create PR 下拉菜单,箭头指向 Agent merge 选项](../../_images/app-enable-agent-merge.png) - -4. 按钮文本现在会变为 **Agent merge**。 -5. 选择 **Agent merge** 按钮,启动 agent merge 流程。 - -Copilot app 随即开始创建并管理 PR。它先探索项目以确定创建 PR 的最佳方式,然后创建新 PR。 - -片刻后,Copilot 会再次开始工作并查看 PR 条件,即运行存储库全部测试的 CI 流程。它会报告其他团队成员留下的审查状态、需要运行的检查(CI 流程),以及 PR 是否可合并。 - -6. 选择 **Agent merge** 旁的下拉菜单,再选择 **Merge pull request**,允许 agent merge 合并拉取请求。 - - ![Agent merge 下拉菜单显示智能体获准执行的操作:Address reviews、Fix CI failures 和 Resolve conflicts,箭头指向 Merge pull request](../../_images/app-agent-merge-merge.png) - -7. 所有 CI 流程变为绿色(表示测试通过)后,Copilot 会合并拉取请求。 - -## 总结与后续步骤 - -你已自动执行开发流程中的多个环节,包括生成代码、测试和验证代码,以及拉取请求流程。你: - -- 了解了 Agent Merge 及其如何自动执行合并生命周期。 -- 在筛选会话中启用了 Agent Merge。 -- 观察了它创建拉取请求、运行 CI,并在所有检查通过后完成合并。 - -接下来,你将探索**画布**,这是一种与智能体共同规划和可视化工作的更丰富方式。继续学习[第 7 课 - 使用画布规划][next-lesson]。 - -## 资源 - -- [使用 GitHub Copilot app 管理议题和拉取请求][managing-issues-prs] -- [关于 GitHub Copilot app][about-copilot-app] - -[next-lesson]: ../7-canvases/ -[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/6-mcp-playwright.md b/docs/zh-cn/app/6-mcp-playwright.md new file mode 100644 index 00000000..42cd0885 --- /dev/null +++ b/docs/zh-cn/app/6-mcp-playwright.md @@ -0,0 +1,90 @@ +--- +title: "第 6 课 - 使用 Playwright MCP 验证功能" +description: "通过 Customize 配置 Playwright MCP,在现有功能工作树中通过浏览器观察筛选功能。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +上一课通过 quality-checks 技能封装并运行了项目检查。现在让智能体访问浏览器,直接观察筛选 UI。保持同一筛选会话、工作树和分支。本课添加浏览器证据,而不是另一个功能、一次完整测试套件运行或一个 PR。 + +本课将介绍如何: + +- 了解模型上下文协议 (MCP) 及 GitHub Copilot app 如何使用它。 +- 通过 **Customize** 添加 Playwright MCP 服务器。 +- 要求智能体操控浏览器并探索筛选功能。 + +## 场景 + +单元测试和端到端测试很重要,但验证 UI 更新需要实际与 UI 交互。你希望 Copilot 能像用户一样使用正在开发的网站,以进一步自动执行更改并提高对更新符合预期的信心。 + +## 什么是模型上下文协议 (MCP)? + +[模型上下文协议 (MCP)][mcp-blog-post] 为 AI 智能体提供了与外部工具和服务通信的方式。借助 MCP,AI 智能体可以实时与外部工具和服务通信。这让它们既能访问最新信息(使用资源),也能代表你执行操作(使用工具)。 + +这些工具和资源通过 MCP 服务器访问。MCP 服务器是 AI 智能体与外部工具和服务之间的桥梁,负责管理双方的通信。外部工具可以是现有 API,也可以是 NPM 包等本地工具。每个 MCP 服务器代表 AI 智能体可访问的一组不同工具和资源。 + +以下是两种常用的现有 MCP 服务器: + +- [**GitHub MCP Server**](https://github.com/github/github-mcp-server):提供一组用于管理 GitHub 存储库的 API。AI 智能体可以创建新存储库、更新现有存储库,以及管理议题和拉取请求。 +- [**Playwright MCP Server**][playwright-mcp-server]:使用 Playwright 提供浏览器自动化功能。AI 智能体可以转到网页、填写表单和选择按钮。 + +还有许多其他 MCP 服务器可用于访问不同的工具和资源。GitHub 托管了一个 [MCP registry](https://github.com/mcp),以提高生态系统的可发现性并促进贡献。 + +> [!CAUTION] +> 应像对待项目中的任何其他依赖项一样对待 MCP 服务器。使用前请仔细审查其源代码、验证发布者并考虑安全影响。仅使用可信的 MCP 服务器,并谨慎授予对敏感资源或操作的访问权限。 + +## 添加 Playwright MCP 服务器 + +当前的 [App 自定义文档][customize-app]使用侧边栏中的 **Customize** 来发现和管理 MCP。在存储库或 Copilot CLI 中配置的 MCP 服务器可能已在 App 中可用;添加前先检查已安装的服务器,避免重复。 + +1. 在侧边栏中选择 **Customize**。 +2. 选择 **MCP**,再检查 **Installed** 中是否已有 Playwright 服务器。 +3. 如有需要,在可用服务器中找到 **Playwright**,或使用发布者文档说明的自定义服务器流程。 +4. 批准前审查发布者、配置和所有安装提示。按提示添加服务器;组织策略或缺少先决条件可能阻止设置。 +5. 返回现有筛选会话,保持 **Interactive** 模式。请求验证前,确认 Playwright MCP 浏览器工具可用。不要通过创建新的功能工作树来绕过设置问题。 + +如果设置失败,应解决配置或权限问题,不要接受智能体未使用工具却声称已浏览的说法。浏览器是否可见取决于服务器配置;实际工具活动和观察结果才是证据。 + +## 要求 Copilot 通过 Playwright 探索功能 + +使用第 4 课保存的实际议题 URL 和批准的澄清内容。在智能体启动自己的服务器前,停止之前课程中手动启动的开发服务器。智能体必须确定被测检出目录和服务器。 + +1. 使用以下提示词,要求 Copilot 验证新功能: + + ```plaintext + 使用已配置的 Playwright MCP 服务器,根据此议题观察筛选功能:。以下是我批准的规划澄清内容:<粘贴约定的澄清内容,或填写 none>。保持当前筛选工作树和分支。 + + 确定检出目录,启动其开发服务器,并使用实际浏览器工具测试所要求的多类别选择、发行商筛选、组合筛选、无障碍控件,以及约定的清除筛选或空结果行为。根据验收标准报告观察结果,包括失败或受阻的检查。不要声称观察到了未实际观察的行为。 + + 此步骤是浏览器观察,不是再次运行完整自动化测试。不要更改应用代码、测试、技能或智能体配置文件,不要提交、推送或创建 PR。将缺少 MCP 工具或先决条件报告为受阻,并在安装任何内容前先询问。不要复用其他检出目录的服务器,也不要停止无关进程。完成后仅停止自己启动的服务器。 + ``` + +检查 Playwright MCP 工具调用、被测 URL 和报告中的浏览器观察结果。仅根据源代码或此前 E2E 结果撰写的描述,不能证明使用了 MCP。 + +2. 对照议题和批准的澄清内容阅读摘要。如果发现缺陷,单独授权针对性修复,审查更改的差异,并重复相关自动化检查和浏览器观察。修复前的证据不能证明修复后版本的状态。 +3. 确认智能体已停止自己启动的服务器。保持筛选会话打开,并在第 7 课创建 QA 配置文件前保持 **Interactive** 模式。 + +此阶段提供直接观察,不能替代自动化覆盖。失败或受阻的观察结果应保留,供 QA 使用。 + +## 总结与后续步骤 + +你使用 Playwright MCP 服务器,从 GitHub Copilot app 在真实浏览器中探索了功能。总结来说,你: + +- 了解了模型上下文协议 (MCP),以及应用如何提供 MCP 工具。 +- 通过 **Customize** 配置了 Playwright MCP 服务器。 +- 要求智能体操控浏览器并探索筛选功能。 + +接下来,通过专业配置文件将需求、浏览器观察、覆盖情况和技能结合起来。在同一会话中继续学习[第 7 课 - 创建并使用 QA 智能体][next-lesson]。暂时不要创建功能 PR。 + +## 资源 + +- [MCP 是什么?为什么每个人都在谈论它?][mcp-blog-post] +- [Microsoft Playwright MCP Server][playwright-mcp-server] +- [在 GitHub Copilot app 中配置 MCP 服务器][customize-app] + +[previous-lesson]: ../5-agent-skills/ +[next-lesson]: ../7-qa-agent/ +[mcp-blog-post]: https://github.blog/ai-and-ml/llms/what-the-heck-is-mcp-and-why-is-everyone-talking-about-it/ +[playwright-mcp-server]: https://github.com/microsoft/playwright-mcp +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/7-canvases.md b/docs/zh-cn/app/7-canvases.md deleted file mode 100644 index 0affd8dd..00000000 --- a/docs/zh-cn/app/7-canvases.md +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "第 7 课 - 使用画布规划" -description: "在 GitHub Copilot app 中创建智能体驱动的共享画布,与智能体共同规划和跟踪工作。" -authors: - - geektrainer -lastUpdated: 2026-07-09 ---- - -此前,你通过聊天指挥智能体。但许多工作并不只存在于对话中,而是呈现在看板、文档或检查清单上。借助**画布**,你和智能体可以直接在应用内共享一个适合此类工作的界面。本课将创建一个简单画布,用于规划和跟踪一直在处理的待办事项。 - -本课将介绍如何: - -- 了解画布是什么以及何时使用画布。 -- 创建共享的看板画布以对待办事项进行分类。 -- 将画布保存到存储库,并为团队合并更改。 -- 在新会话中打开画布,并从中开始工作。 - -## 场景 - -即使一切顺利,查看一长串议题也可能让人望而生畏。Tailspin Toys 的开发人员一直在寻找一种工具,用于快速对议题进行分类,并在 Copilot app 中着手处理。 - -## 什么是画布? - -[画布][canvas-docs]是用于工作工件的共享交互式界面,例如计划、分类看板、发布检查清单、仪表板或文档。聊天非常适合描述意图和分析模糊问题,但大多数工作发生在具体的*界面*上。画布让你可以直接在该界面上与智能体协作。 - -画布支持**双向交互**:智能体可以在工作过程中更新画布,你也可以自行编辑同一个界面。创建画布时,智能体会根据提示词和工作流进行构建;之后,可以要求它添加、删除或修改功能。画布创建后会在应用右侧面板中打开。 - -常见示例包括: - -- 用于规划当天工作以及确定议题和拉取请求优先级的 **Markdown 画布**。 -- 由人员和智能体添加卡片并在列之间移动工作的**智能体看板**。 -- 汇总存储库重要议题和重复出现主题的**议题分类看板**。 - -## 为什么使用画布? - -当任务需要结构、迭代和验证,且仅靠聊天不足以完成时,可以使用画布。画布让你能够: - -- 让智能体基于符合工作流的实际工件开展工作。 -- 直接在共享界面上引导或纠正工作,再让智能体从更改处继续。 -- 通过工件的可见更改检查进度,而不只是查看聊天回复。 - -## 创建画布来跟踪工作 - -你已经交付了许多内容:星级评分、文档标准和筛选功能都已合并。但待办事项中仍有其他工作。接下来创建画布,以便快速对这些工作进行分类。 - -1. 返回(或打开)GitHub Copilot app。 -2. 选择 **Home screen**。 -3. 确保为存储库选择了 `tailspin-toys`。 -4. 在提示框中使用以下提示词,创建满足需求的画布: - - ```plaintext - Create a basic Kanban board canvas that allows me to quickly triage work. Highlight the three issues which are most likely to need attention right now, with the remainder in a second section down below. The top three cards should include a description of the issue's content and a justification of why they're at the top of the list. Each issue should have a button that allows me to add it to the current context for the current session so I can get to work on it straightaway. - ``` - -Copilot 将开始创建画布。 - -> [!NOTE] -> 此过程需要几分钟。由于任务较复杂,第一版可能无法完全令人满意。可以继续发送提示词,逐步构建理想的工具。 - -## 保存画布并合并到存储库 - -与指令文件和技能一样,画布也可以成为存储库中的资产。接下来要求 Copilot 将画布添加到存储库并合并,让整个团队都能使用。 - -1. 在同一会话中使用以下提示词,要求 Copilot 将画布保存到存储库: - - ```plaintext - Let's save this canvas definition to the repository so I can share it with my development team - ``` - -2. Copilot 保存画布文件后,选择右上角 **Create PR** 旁的下拉菜单。 -3. 选择 **Agent merge** 以启用 agent merge。 - - ![GitHub Copilot app 中展开的 Create PR 下拉菜单,箭头指向 Agent merge 选项](../../_images/app-enable-agent-merge.png) - -4. 按钮文本现在会变为 **Agent merge**。 -5. 选择 **Agent merge** 按钮,启动 agent merge 流程。 - -Copilot app 会开始创建并管理 PR。它先探索项目以确定创建 PR 的最佳方式,然后创建 PR。 - -片刻后,Copilot 会再次开始工作并查看 PR 条件,即运行存储库全部测试的 CI 流程。它会报告其他团队成员留下的审查状态、需要运行的检查(CI 流程),以及 PR 是否可合并。 - -6. 选择 **Agent merge** 旁的下拉菜单,再选择 **Merge pull request**,允许 agent merge 合并拉取请求。 - - ![Agent merge 下拉菜单显示智能体获准执行的操作:Address reviews、Fix CI failures 和 Resolve conflicts,箭头指向 Merge pull request](../../_images/app-agent-merge-merge.png) - -7. 等待所有 CI 流程通过(变为绿色)。全部通过后,Copilot 会自动合并拉取请求。 - -现在,你已经为团队创建了新的共享画布。 - -## 在画布中工作 - -画布创建后,接下来启动新会话并开始使用。 - -1. 在 Copilot app 中,选择 **tailspin-toys** 旁的 **New session** 启动新会话。 -2. 使用以下提示词,要求 Copilot 打开分类画布: - - ```plaintext - Open the triage issues canvas - ``` - -3. 现在应会看到所构建的画布已在新会话中打开。 -4. 在最感兴趣的一个议题上选择 **Add to current context**。 -5. Copilot 将开始处理该议题。 - -现在,你已使用自己创建的画布简化了开发流程。 - -## 总结与后续步骤 - -你创建了一个可与智能体协作的共享界面。你: - -- 了解了画布是什么以及何时使用画布。 -- 与智能体共同创建了共享的看板分类画布。 -- 使用 Agent Merge 将画布保存并合并到存储库。 -- 在新会话中打开画布,并使用它开始工作。 - -待办事项现已得到跟踪。接下来回顾已构建的所有内容,并了解后续方向。继续学习[第 8 课 - 回顾与后续步骤][next-lesson]。 - -## 资源 - -- [在 GitHub Copilot app 中使用画布扩展][canvas-docs] -- [Awesome Copilot 上的画布][awesome-copilot-canvases] -- [关于 GitHub Copilot app][about-copilot-app] - -[next-lesson]: ../8-review/ -[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions -[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ -[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/7-qa-agent.md b/docs/zh-cn/app/7-qa-agent.md new file mode 100644 index 00000000..926cb069 --- /dev/null +++ b/docs/zh-cn/app/7-qa-agent.md @@ -0,0 +1,117 @@ +--- +title: "第 7 课 - 创建并使用 QA 智能体" +description: "创建以需求为先的 QA 配置,将测试覆盖、quality-checks 技能和直接浏览器验证证据结合起来。" +authors: + - geektrainer +lastUpdated: 2026-09-14 +--- + +前几课中,你创建了 quality-checks 技能,并通过 Playwright MCP 为 Copilot 提供了浏览器工具。现在使用 **QA 自定义智能体**将这些能力结合起来,对照需求审查筛选功能。 + +在本课中,你将: + +- 理解自定义智能体如何与指令、技能和 MCP 工具配合。 +- 创建并检查可复用的 QA 配置。 +- 选择 QA 智能体,并对照筛选 issue 审查其发现。 +- 为功能 PR 保存配置和有充分理由添加的测试。 + +## 场景 + +Tailspin Toys 正准备发布类别和发行商筛选功能。自动化检查和浏览器探索提供了有用的证据,但仅凭测试通过,无法判断是否覆盖了所有约定的需求。创建 PR 前,团队希望重点审查请求了什么、实现了什么,以及哪些方面仍需关注。 + +你将创建一个从 issue 和已批准的规划决策出发的 QA 智能体,让它检查覆盖情况,并使用技能和浏览器工具收集证据。它的职责是识别缺口,解释功能是否已准备好接受审查,而不是批准自己的工作或合并 PR。 + +## 什么是自定义智能体? + +自定义智能体是通过 Markdown 配置定义的可复用专业角色。其指令指导 Copilot 处理任务的方式;选择配置后,该角色会应用于当前对话。本工作坊将在 `.github/agents/qa.agent.md` 中定义角色,然后在 app 中选择它。 + +已经创建的自定义内容各有用途。存储库指令描述团队标准,quality-checks 技能封装可重复执行的检查,Playwright MCP 提供浏览器工具。QA 配置告诉 Copilot 如何使用这些能力评估需求并报告发现。它不会取代这些能力,也不要求另开智能体会话。 + +## 创建 QA 配置 + +继续使用第 6 课的筛选会话,保持同一工作树和分支。确认会话处于 **Interactive** 模式、quality-checks 技能存在且 Playwright MCP 可用。功能 PR 在第 8 课创建;本课只添加配置,并仅在需要时添加测试。 + +将以下提示发送给普通 Copilot 智能体。选择 QA 前,先检查生成的文件: + +```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,也不要创建其他智能体或技能。 +``` + +## 检查配置 + +1. 打开 **Changes**,选择 `.github/agents/qa.agent.md`。也可以通过文件审查面板找到它。 +2. 阅读 frontmatter。`description` 是必需字段,`name: QA` 便于在选择器中识别配置。本练习不指定 `model` 和 `tools`,以使用已选模型和可用工具;常规权限仍然适用。 +3. 将指令作为审查清单阅读:是否从需求出发、使用技能和浏览器工具、只为真正的缺口添加测试,并区分失败与受阻的检查? +4. 选择配置前,让 Copilot 修正不足。确认它只创建了定义,没有开始 QA 或更改应用。 + +> [!NOTE] +> 专业角色配置可以指导行为,但不保证结果正确。你仍需检查智能体的工具活动、测试更改和报告。 + +## 根据 issue 运行 QA + +运行提示应发送给选中的 **QA** 自定义智能体,而不是让默认智能体读取配置。保持同一筛选功能检出目录和分支。 + +1. 在当前会话中,打开提示框中的智能体选择器,或按 [app 自定义文档][customize-app]所述输入 `/agent`。 +2. 选择 **QA**,并在发送运行提示前确认 app 明确显示 **QA** 为当前活动智能体。 +3. 如果列表中没有 **QA**,或无法确认它已激活,暂停并向讲师求助,同时保留此工作树和分支。不要创建新的功能会话、虚构重新加载步骤,也不要改为让默认智能体读取 `qa.agent.md`。 + +文档中的选择器可在会话期间使用,但能否发现新建的存储库配置取决于 app 版本。不要把写入文件当作已激活的证明。 + +将两个占位符替换为实际筛选功能 issue 的 URL 和第 4 课中批准的澄清内容;如果 issue 已完整说明需求,则填写 `none`。不要依赖前一个智能体的记忆。 + +```plaintext +根据此 issue 验证筛选功能:。以下是我在规划期间批准的补充验收标准:<粘贴约定的澄清内容,或填写 none>。 + +使用 Playwright MCP 服务器验证行为,检查测试覆盖,仅针对覆盖缺口添加测试,并通过 quality-checks 技能运行验证。报告证据、检查结果和阻碍。未经我批准,不要修改应用代码。不要创建提交或 pull request。 +``` + +## 审查证据 + +对照筛选 issue 和已批准的澄清内容阅读报告: + +1. 检查每项标准是否对应适当的测试和可观察的行为。例如,组合类别与发行商时,需要有关返回游戏的证据,而不只是控件能否响应。 +2. 检查实际的 Playwright MCP 工具活动,确认被测服务器属于此检出目录。浏览器检查和自动化 E2E 不得复用过时的服务器或其他检出目录。 +3. 审查 lint、单元测试、E2E 测试和类型检查结果。四项检查都必须通过 quality-checks 技能的脚本运行;概述计划执行的命令不等于实际执行。 +4. 打开 **Changes** 检查新增测试,并与报告中的缺口进行比较。 + +审查新增测试:它们应填补真正的缺口,而不是弱化断言。覆盖充分时,不新增测试是正确做法。因受阻或失败而给出 **NO-GO** 是有效结果,不代表可以跳过证据。 + +如果 QA 发现应用缺陷,另行批准针对性修复,并在更改后的版本上重新执行受影响的检查和浏览器观察。缺少前提条件或工具时,需要明确的解决方案。不要将旧证据当作更改后代码的证明。 + +## 保存检查点 + +QA 的职责是验证,因此请求提交前应先返回普通智能体: + +1. 保留 QA 报告、issue URL、已批准的澄清内容和测试过的版本,以便在 PR 课程中使用。 +2. 在同一会话中,使用智能体选择器返回普通 Copilot 智能体,确认 **QA** 已不再选中。 +3. 保持同一工作树和分支。如果找不到普通智能体选项,向讲师求助,不要另开功能会话或向 QA 发送提交指令。 + +审查配置、测试更改及相应证据后,将检查点请求连同这些 QA 上下文一起发送给普通智能体: + +```plaintext +检查当前差异,为 QA 智能体定义和已批准的测试更改创建检查点提交。保留现有筛选功能分支。不要推送或创建 pull request。 +``` + +## 总结与后续步骤 + +你已为工作流添加可复用的专业角色,并审查了它的工作。本课中,你: + +- 创建并检查了从需求出发的 QA 配置。 +- 选择该配置来评估覆盖情况,通过技能和 Playwright MCP 收集证据。 +- 审查发现,并将配置和有充分理由添加的测试保存在筛选分支上。 + +现在已具备功能审查所需的实现、技能、QA 配置、测试和验证报告。继续跟踪未解决的问题;失败或受阻不代表获准合并。接下来在[第 8 课 - 创建并合并功能 PR][next-lesson]中审查完整里程碑并使用 Agent Merge。 + +## 资源 + +- [自定义 GitHub Copilot app,包括选择自定义智能体][customize-app] + +[previous-lesson]: ../6-mcp-playwright/ +[next-lesson]: ../8-create-pull-request/ +[customize-app]: https://docs.github.com/copilot/how-tos/github-copilot-app/customize-github-copilot-app diff --git a/docs/zh-cn/app/8-create-pull-request.md b/docs/zh-cn/app/8-create-pull-request.md new file mode 100644 index 00000000..50321d1d --- /dev/null +++ b/docs/zh-cn/app/8-create-pull-request.md @@ -0,0 +1,89 @@ +--- +title: "第 8 课 - 创建并合并功能 PR" +description: "一并审查筛选功能、技能、QA 配置文件和测试,创建 PR 3,并明确授权 Agent Merge。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +筛选实现、quality-checks 技能、QA 配置文件及相关测试已通过检查点提交保存在同一分支上。一并审查这些内容,并使用当前 QA 证据准备 PR 3。你已经明确合并了星级评分和指令 PR。这次将在 PR 工作流中使用 **Agent Merge**,而不是为其创建单独的功能或分支。 + +本课将介绍如何: + +- 了解 Agent Merge 及其如何自动执行合并生命周期。 +- 检查完整的功能 PR 和验证证据。 +- 审查后再授权 Agent Merge,并确认 PR 已合并。 + +## 场景 + +在前几课中,你探索了不同程度的自动化,从创建代码到让 Copilot 直接验证 UI。为了进一步加快开发速度,Tailspin Toys 希望了解是否可以自动合并经过审查和验证的拉取请求。 + +## Agent Merge 简介 + +通过 **Agent Merge**,可以使用 Copilot app 自动执行拉取请求落地前的最后阶段。启用后,应用会话会读取拉取请求并处理阻塞项,包括修复失败的 CI 检查、响应审查意见,以及在需要时变基。GitHub 允许后,它会立即合并。该功能在后台运行,应用重启后仍会继续,并在拉取请求合并后自动关闭。 + +此前,你一直自行选择 **Merge pull request**。Agent Merge 可以承担这项工作,但它编辑代码和合并的能力仍需要明确授权。授予合并权限前,先审查它允许执行的操作及工作内容。 + +## 审查完整的里程碑 + +留在第 4–7 课的筛选会话中。检查相对于 `main` 的完整分支差异,而不只是最新检查点:其中应包含筛选功能、`.github/skills/quality-checks/SKILL.md`、随附脚本、`.github/agents/qa.agent.md` 和相关测试。 + +请求提交或 PR 操作前,使用智能体选择器从 **QA** 切回通用 Copilot 智能体,并保持 **Interactive** 模式。QA 配置文件的职责是验证,而不是交付。更换所选智能体不得改变筛选会话、检出目录或分支。 + +本研讨会有意将功能工作和可复用质量基础设施放在同一个 PR 中。生产团队可能会将两者拆分;这里使用检查点提交保留便于审查的步骤,无需堆叠分支或额外创建 PR。 + +审查第 7 课的 QA 报告。只有报告涵盖待提交的最终修订版本,且已完成全部四项检查和相关浏览器观察,才能复用其中的证据。如果代码改动、冲突解决或 CI 修复改变了被测内容,应重新运行受影响的检查和浏览器观察,并更新证据。失败或受阻的 **NO-GO** 报告不代表批准合并。 + +差异和证据准备就绪后,发送: + +```plaintext +审查筛选分支相对于 main 的完整差异,包括筛选功能、quality-checks 技能及脚本、QA 智能体定义和相关测试。汇总议题标准、批准的澄清内容及当前 QA 证据。仅在验证仍适用于最终修订版本时复用;继续前报告过时、缺失或失败的证据。 + +如果已审查的更改和验证已就绪,提交剩余的已批准里程碑更改,推送当前分支,并使用存储库的 PR 模板和实际筛选议题 URL,创建一个以 main 为目标的功能 PR。保留当前分支上的检查点历史。不要使用贡献技能、创建其他分支或 PR,也不要合并。 +``` + +在 **My work** 中打开 PR,检查 **Files changed**、描述、审查和检查结果。查看 Tailspin Toys 自己的工作流文件和必需检查;不要假设每项本地检查或浏览器观察都会在 CI 中运行。研讨会发布站点的 Astro 构建和链接检查器属于另一个存储库,不能验证此功能。 + +## 使用 Agent Merge 管理 PR + +审查现有 PR 后,在同一会话中配置 Agent Merge。不要创建第二个 PR。 + +1. 返回筛选会话,确认其已关联 PR 3。 +2. 打开右上角的 PR 操作下拉菜单。PR 创建前,它位于 **Create PR** 旁;关联 PR 后,标签可能变化。 +3. 选择 **Agent merge** 以启用 agent merge。 +4. 审查可用权限,包括 **Address reviews**、**Fix CI failures**、**Resolve conflicts** 和 **Merge pull request**。发现的问题或验证尚未解决时,保持合并权限关闭。 +5. 启动前,发送以下范围和授权说明,再选择 **Agent merge**: + + ```plaintext + 使用 Agent Merge 管理此现有筛选 PR。仅在该 PR 范围内处理审查或 CI 阻塞项。不要弱化测试或需求,并在无关更改或安装前先询问。只要被测修订版本发生改动,就需要更新相关检查和浏览器证据;不要将旧 QA 结果当作更改后代码的证明。 + + 在我审查最终差异和证据并明确启用 Merge pull request 前,不要合并。不要创建其他 PR 或开始画布任务。 + ``` + +6. 审查后续更改和更新后的结果。最终差异获批、必需的 CI 和审查通过,且 QA 证据适用于该修订版本后,选择 **Agent merge** 旁的下拉菜单,再选择 **Merge pull request**,明确授权合并。 + + ![Agent merge 下拉菜单显示智能体获准执行的操作:Address reviews、Fix CI failures 和 Resolve conflicts,箭头指向 Merge pull request](../../_images/app-agent-merge-merge.png) + +7. 确认 GitHub 显示 PR 3 为 **Merged**,而不只是可合并或已排队。Agent Merge 不会绕过存储库保护或缺失的权限;解决这些阻塞项后再继续。 + +只有合并完成后,才能开始画布里程碑。第 9 课会创建新工作树,并将其会话分支快进到最新的 `origin/main`,确保画布工作从完整合并后的功能状态开始。 + +## 总结与后续步骤 + +你已自动执行开发流程中的多个环节,包括生成代码、测试和验证代码,以及拉取请求流程。你: + +- 了解了 Agent Merge 及其如何自动执行合并生命周期。 +- 将筛选功能、技能、QA 配置文件和测试的完整差异作为 PR 3 进行了审查。 +- 复用了当前 QA 证据,检查了 CI,并明确授权了 Agent Merge。 + +接下来,你将探索**画布**,这是一种与智能体共同规划和可视化工作的更丰富方式。继续学习[第 9 课 - 创建分类画布][next-lesson]。 + +## 资源 + +- [使用 GitHub Copilot app 管理议题和拉取请求][managing-issues-prs] +- [关于 GitHub Copilot app][about-copilot-app] + +[previous-lesson]: ../7-qa-agent/ +[next-lesson]: ../9-canvases/ +[managing-issues-prs]: https://docs.github.com/copilot/how-tos/github-copilot-app/managing-issues-and-pull-requests +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/9-canvases.md b/docs/zh-cn/app/9-canvases.md new file mode 100644 index 00000000..6b59aa12 --- /dev/null +++ b/docs/zh-cn/app/9-canvases.md @@ -0,0 +1,148 @@ +--- +title: "第 9 课 - 创建分类画布" +description: "创建并审查保存在存储库中的分类画布,合并 PR 4,再重新打开画布以添加议题上下文,而不开始其他功能。" +authors: + - geektrainer +lastUpdated: 2026-09-11 +--- + +此前,你通过聊天指挥智能体。但许多工作并不只存在于对话中,而是呈现在看板、文档或检查清单上。借助**画布**,你和智能体可以直接在应用内共享一个适合此类工作的界面。本课将创建一个简单画布,用于规划和跟踪一直在处理的待办事项。 + +本课将介绍如何: + +- 了解画布是什么以及何时使用画布。 +- 创建共享的看板画布以对待办事项进行分类。 +- 将画布保存到存储库,并为团队合并更改。 +- 重新打开画布并添加议题上下文,而不实现其他功能。 + +## 场景 + +查看一长串议题可能让人望而生畏。Tailspin Toys 的开发人员希望有一个工具来分类议题,并将其详情加入会话上下文。添加上下文并不代表授权实现该议题;本练习以可复用的看板结束,而不是创建第五个 PR。 + +## 什么是画布? + +[画布][canvas-docs]是用于工作工件的共享交互式界面,例如计划、分类看板、发布检查清单、仪表板或文档。聊天非常适合描述意图和分析模糊问题,但大多数工作发生在具体的*界面*上。画布让你可以直接在该界面上与智能体协作。 + +画布支持**双向交互**:智能体可以在工作过程中更新画布,你也可以自行编辑同一个界面。创建画布时,智能体会根据提示词和工作流进行构建;之后,可以要求它添加、删除或修改功能。画布创建后会在应用右侧面板中打开。 + +常见示例包括: + +- 用于规划当天工作以及确定议题和拉取请求优先级的 **Markdown 画布**。 +- 由人员和智能体添加卡片并在列之间移动工作的**智能体看板**。 +- 汇总存储库重要议题和重复出现主题的**议题分类看板**。 + +## 为什么使用画布? + +当任务需要结构、迭代和验证,且仅靠聊天不足以完成时,可以使用画布。画布让你能够: + +- 让智能体基于符合工作流的实际工件开展工作。 +- 直接在共享界面上引导或纠正工作,再让智能体从更改处继续。 +- 通过工件的可见更改检查进度,而不只是查看聊天回复。 + +## 创建画布来跟踪工作 + +确认 PR 3 已合并。开始画布工作前,星级评分、文档标准、筛选功能、质量技能和 QA 配置文件必须都已进入 `main`。为这个最终 PR 里程碑使用一个新会话和一个分支。 + +1. 返回(或打开)GitHub Copilot app。 +2. 选择 **Home screen**。 +3. 确保为存储库选择了 `tailspin-toys`。 +4. 选择 **new working tree** 和 **Interactive** 模式。创建任何文件前,发送以下基线请求: + + ```plaintext + 准备这个新的画布会话,不要实现任何内容。确认这是一个干净的新工作树,获取 origin,并将当前会话分支快进到 origin/main。报告检出目录、分支,以及相互一致的 HEAD 和 origin/main 修订版本。验证筛选 PR 已合并,且筛选功能、quality-checks 技能和 QA 配置文件均已存在。 + + 如果检出目录不干净、已发生分叉或缺少之前的合并,停止。不要重置、丢弃工作、切换分支或创建其他分支。报告基线后停止。 + ``` + +5. 检查基线报告,再请求创建保存在存储库中的画布: + + ```plaintext + 使用 App 支持的画布扩展工作流,为此存储库创建一个基本的 Kanban 分类画布,并将其保存在存储库中。将定义保存到 .github/extensions/ 下,以便团队复用。检查并保留现有扩展;不要覆盖随附的数据库浏览器。 + + 阅读当前未关闭的议题。突出显示最可能需要关注的三个,其余议题放在下方。每个突出显示的议题都应包含标题、内容摘要、URL 和优先级理由。将排序视为建议,而不是修改议题的指令。 + + 为每张卡片提供 Add to current context 操作,仅将议题详情加入当前会话。此操作不得开始实现、创建会话或分支、修改议题状态或创建 PR。保持画布范围明确,并支持键盘操作。 + + 向我展示生成的文件,并打开画布供我检查。不要更改应用代码、提交、推送或创建 PR。在安装任何内容或添加依赖项前先询问。 + ``` + +Copilot 会创建画布文件并打开共享界面。信任其操作前,先审查生成的扩展;它是可执行的存储库内容,而不只是一幅图。 + +> [!NOTE] +> 如果第一版需要改进,在分类任务范围内请求针对性调整。不要把本练习变成实现某个待办议题。 + +## 检查并操作画布 + +1. 打开 **Changes**,确认画布定义保存在存储库的 `.github/extensions/` 下,而不是仅保存到用户或会话。检查现有扩展和应用文件是否保持不变。 +2. 将看板与实际未关闭的议题进行比较,并评估排序说明。 +3. 检查卡片和控件是否清晰可读,且支持键盘操作。 +4. 为一个议题选择 **Add to current context**,确认只有议题详情进入对话,不应开始实现或更改议题状态。 +5. 审查所有修正,并让 Copilot 对更改的文件运行适用的现有验证。记录结果和阻塞项,不要仅因为交互界面能打开就假定它正确。 + +## 保存画布并合并到存储库 + +画布已经是存储库资产。仅将已审查的画布工作提交为 PR 4: + +1. 在同一会话中发送: + + ```plaintext + 审查保存在存储库中的分类画布差异及其验证证据。在当前会话分支上提交已批准的画布文件,推送分支,并使用存储库的 PR 模板创建一个以 main 为目标的 PR。描述画布行为,以及我们如何验证添加议题只会添加上下文。暂时不要合并,也不要实现待办议题。 + ``` + +2. 在 **My work** 中审查完整的 PR 差异和检查结果。确认其中包含画布,而不是无关的应用工作。 +3. 在同一画布会话中打开 PR 操作下拉菜单,选择 **Agent merge**。审查其允许执行的操作,在批准最终结果前保持 **Merge pull request** 关闭。 +4. 启动 Agent Merge 前明确范围: + + ```plaintext + 使用 Agent Merge 管理此现有画布 PR。仅处理范围内的审查和 CI 阻塞项;在无关更改或安装前先询问。如果画布发生变化,重复受影响的验证并更新证据。在我审查后明确启用 Merge pull request 前,不要合并。不要实现待办议题或创建其他 PR。 + ``` + +5. 选择 **Agent merge**,审查后续更改。检查练习存储库实际的 CI 检查并解决失败项;CI 不能替代实际操作画布进行验证。 + +6. 最终差异和当前证据获批,且必需的检查和审查通过后,选择 Agent Merge 下拉菜单,再选择 **Merge pull request**,明确允许合并。 + + ![Agent merge 下拉菜单显示智能体获准执行的操作:Address reviews、Fix CI failures 和 Resolve conflicts,箭头指向 Merge pull request](../../_images/app-agent-merge-merge.png) + +7. 确认 GitHub 显示 PR 4 为 **Merged** 后再继续。 + +现在,你已经为团队创建了新的共享画布。 + +## 重新打开画布,但不开始其他功能 + +画布 PR 合并后,在同一画布会话中重新打开保存在存储库中的画布。这是检查步骤,而不是另一个分支或 PR 里程碑。 + +1. 返回画布会话,保持 **Interactive** 模式;如果画布面板仍打开,先关闭它。 +2. 发送: + + ```plaintext + 在同一会话中重新打开存储库的分类画布。我会将一个议题加入上下文,仅用于检查其详情。不要编辑文件、实现议题、更改其状态、创建其他会话或分支、提交、推送或打开 PR。 + ``` + +3. 确认已保存的画布再次打开,而没有重新生成其定义。 +4. 在最感兴趣的一个议题上选择 **Add to current context**。 +5. 确认所选议题的详情出现在上下文中,而没有开始实现。到此停止:本研讨会有四个 PR 里程碑,而不是五个。 + +现在,你已使用自己创建的画布简化了开发流程。 + +## 总结与后续步骤 + +你创建了一个可与智能体协作的共享界面。你: + +- 了解了画布是什么以及何时使用画布。 +- 与智能体共同创建了共享的看板分类画布。 +- 使用 Agent Merge 将画布保存并合并到存储库。 +- 重新打开已合并的画布,添加议题上下文,而不启动其他功能。 + +待办事项现已得到跟踪。接下来回顾已构建的所有内容,并了解后续方向。继续学习[第 10 课 - 总结与后续步骤][next-lesson]。 + +## 资源 + +- [在 GitHub Copilot app 中使用画布扩展][canvas-docs] +- [Awesome Copilot 上的画布][awesome-copilot-canvases] +- [关于 GitHub Copilot app][about-copilot-app] + +[previous-lesson]: ../8-create-pull-request/ +[next-lesson]: ../10-review/ +[canvas-docs]: https://docs.github.com/copilot/how-tos/github-copilot-app/working-with-canvas-extensions +[awesome-copilot-canvases]: https://awesome-copilot.github.com/extensions/ +[about-copilot-app]: https://docs.github.com/copilot/concepts/agents/github-copilot-app \ No newline at end of file diff --git a/docs/zh-cn/app/README.md b/docs/zh-cn/app/README.md index 106881c3..0da89e43 100644 --- a/docs/zh-cn/app/README.md +++ b/docs/zh-cn/app/README.md @@ -3,12 +3,14 @@ slug: zh-cn/app title: "GitHub Copilot app" authors: - geektrainer -lastUpdated: 2026-06-30 +lastUpdated: 2026-09-11 --- [**GitHub Copilot app**](https://docs.github.com/copilot/concepts/agents/github-copilot-app) 是一款基于 Copilot CLI 构建的桌面应用,可将智能体驱动的开发集中到一个专注的工作区。它支持并行智能体会话、可切换的会话模式、共享画布,以及原生的 GitHub 议题和拉取请求管理功能。其中包括 **Agent Merge**,可处理拉取请求的变基、审查反馈、CI 修复与合并。 -在这些课程中,你将安装应用并设置项目,然后熟悉应用工作区和模板为你创建的待办事项。你会先完成一项小改动,即添加星级评分;再根据议题添加自定义指令标准,在隔离的智能体会话中构建筛选功能,并使用可复用技能进行验证。随后,你将添加 Playwright MCP 服务器,在真实浏览器中探索该功能,并逐步提高合并自动化程度,最终由 **Agent Merge** 合并拉取请求。最后,你将通过共享画布协作并自动执行重复性工作,完整体验从构想到功能合并的流程。 +设置课程第 0–1 课帮助你准备项目和 App 工作区。九个核心模块,即第 2–10 课,从添加星级评分快速上手,再通过真实代码展示文档约定。随后规划并构建筛选功能,创建并执行包含 shell 脚本的 quality-checks 技能,通过 Playwright MCP 观察功能,再创建 QA 自定义智能体来评估需求和覆盖情况。你将审查完整的功能 PR 并授权 Agent Merge,最后创建并合并共享分类画布。 + +本研讨会有四个 PR 里程碑:星级评分;指令及示例改动;筛选功能及技能、QA 配置文件和测试;最后是画布。每个里程碑都从更新后的 `main` 开始,每个 PR 使用一个分支,而不是每个模块一个分支。第 4–8 课沿用同一筛选会话、工作树和分支。重新打开画布只添加议题上下文,不启动其他功能或第五个 PR。自动化任务作为后续方向提供链接,而不是额外练习。 ## 课程 @@ -16,13 +18,15 @@ lastUpdated: 2026-06-30 |--------|-------|-------------| | [0. 先决条件][ex0] | 设置 | 安装 Node.js,并创建自己的 Tailspin Toys 项目副本 | | [1. 安装 Copilot app][ex1] | 设置 | 安装应用、连接项目并熟悉工作区 | -| [2. 运行第一个智能体会话][ex2] | 首次更改 | 启动会话,并通过第一个拉取请求交付一项小改动 | -| [3. 使用自定义指令引导 Copilot][ex3] | 上下文 | 根据议题添加文档标准并合并更改 | -| [4. 使用 Autopilot 构建功能][ex4] | 核心功能 | 使用 Plan 和 Autopilot 构建筛选功能,再通过技能进行验证 | -| [5. 使用 Playwright MCP 测试][ex5] | 外部工具 | 添加 Playwright MCP 服务器,并在浏览器中探索功能 | -| [6. 使用 Agent Merge 合并][ex6] | 合并 | 让 Agent Merge 修复并合并筛选功能的拉取请求 | -| [7. 使用画布规划][ex7] | 协作 | 创建共享画布来规划和跟踪工作 | -| [8. 回顾与后续步骤][ex8] | 总结 | 自动执行重复性任务,并探索后续内容 | +| [2. 添加星级评分:快速上手][ex2] | 首次更改 | 显示现有评分和空值回退状态,再合并 PR 1 | +| [3. 使用自定义指令引导 Copilot][ex3] | 上下文 | 添加文档标准和真实示例改动,再合并 PR 2 | +| [4. 使用 Plan 和 Autopilot 构建筛选功能][ex4] | 实现 | 批准计划,实现并检查筛选功能,保存检查点 | +| [5. 创建并使用 quality-checks 技能][ex5] | 可重复检查 | 创建、审查并执行随附的 shell 脚本 | +| [6. 使用 Playwright MCP 验证功能][ex6] | 浏览器观察 | 通过 Customize 配置 MCP,并检查筛选行为 | +| [7. 创建并使用 QA 智能体][ex7] | 需求与覆盖 | 选择专业配置文件,收集最终验证证据 | +| [8. 创建并合并功能 PR][ex8] | 审查与合并 | 审查筛选功能、技能、QA 配置文件和测试,再为 PR 3 授权 Agent Merge | +| [9. 创建分类画布][ex9] | 协作 | 通过 PR 4 共享保存在存储库中的画布,并添加议题上下文 | +| [10. 总结与后续步骤][ex10] | 总结 | 回顾工作流、产出及更多资源 | ## 先决条件 @@ -50,9 +54,11 @@ lastUpdated: 2026-06-30 [ex2]: 2-add-star-rating/ [ex3]: 3-custom-instructions/ [ex4]: 4-build-filtering/ -[ex5]: 5-mcp-playwright/ -[ex6]: 6-agent-merge/ -[ex7]: 7-canvases/ -[ex8]: 8-review/ +[ex5]: 5-agent-skills/ +[ex6]: 6-mcp-playwright/ +[ex7]: 7-qa-agent/ +[ex8]: 8-create-pull-request/ +[ex9]: 9-canvases/ +[ex10]: 10-review/ [install-git]: https://github.com/git-guides/install-git [callout-student-plan-education]: https://github.com/education/students \ No newline at end of file diff --git a/website/astro.config.mjs b/website/astro.config.mjs index 2abc22db..98536a81 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -86,13 +86,15 @@ export default defineConfig({ { label: 'Overview', link: '/app/' }, { label: '0. Prerequisites', link: '/app/0-prerequisites/' }, { label: '1. Install the Copilot app', link: '/app/1-install-copilot-app/' }, - { label: '2. Running your first agent session', link: '/app/2-add-star-rating/' }, + { label: '2. Add star ratings', link: '/app/2-add-star-rating/' }, { label: '3. Guiding Copilot with custom instructions', link: '/app/3-custom-instructions/' }, - { label: '4. Building a feature with Autopilot', link: '/app/4-build-filtering/' }, - { label: '5. Testing with Playwright MCP', link: '/app/5-mcp-playwright/' }, - { label: '6. Merging with Agent Merge', link: '/app/6-agent-merge/' }, - { label: '7. Planning with canvases', link: '/app/7-canvases/' }, - { label: '8. Review', link: '/app/8-review/' }, + { label: '4. Build filtering with Plan and Autopilot', link: '/app/4-build-filtering/' }, + { label: '5. Create and use a quality-checks skill', link: '/app/5-agent-skills/' }, + { label: '6. Validate with Playwright MCP', link: '/app/6-mcp-playwright/' }, + { label: '7. Create and use a QA agent', link: '/app/7-qa-agent/' }, + { label: '8. Create and merge the feature PR', link: '/app/8-create-pull-request/' }, + { label: '9. Create a canvas', link: '/app/9-canvases/' }, + { label: '10. Wrap-up and next steps', link: '/app/10-review/' }, ], }, {