docs: align quality-checks lessons with the Tailspin skill - #189
Merged
Merged
Conversation
Describe unit tests, lint, and type checks consistently across App and CLI lessons and App translations. Correct the report customization exercise and request only tool-reported metrics. Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The report prompt can omit required checks that never ran, so blocked outcomes are not reliably surfaced.
Review effort: Balanced
Findings: 7
Open (7)
What changed in this PR
Aligns App and CLI lessons with Tailspin Toys’ current quality-checks scope and mirrors the App updates across five locales.
Changes:
- Defines the skill scope as unit tests, lint, and type checks.
- Replaces obsolete script/E2E guidance with explicit prompts and tool-reported metrics.
- Updates recap lessons and localized content consistently.
| File | Description |
|---|---|
docs/real-world-development/app/5-agent-skills.md |
Updates the App skill exercise. |
docs/real-world-development/app/10-review.md |
Aligns the App recap. |
docs/real-world-development/cli/5-agent-skills.md |
Updates the CLI skill exercise. |
docs/real-world-development/cli/10-review.md |
Aligns the CLI recap. |
docs/es-es/real-world-development/app/5-agent-skills.md |
Mirrors the exercise in Spanish. |
docs/es-es/real-world-development/app/10-review.md |
Mirrors the recap in Spanish. |
docs/ja-jp/real-world-development/app/5-agent-skills.md |
Mirrors the exercise in Japanese. |
docs/ja-jp/real-world-development/app/10-review.md |
Mirrors the recap in Japanese. |
docs/ko-kr/real-world-development/app/5-agent-skills.md |
Mirrors the exercise in Korean. |
docs/ko-kr/real-world-development/app/10-review.md |
Mirrors the recap in Korean. |
docs/pt-br/real-world-development/app/5-agent-skills.md |
Mirrors the exercise in Portuguese. |
docs/pt-br/real-world-development/app/10-review.md |
Mirrors the recap in Portuguese. |
docs/zh-cn/real-world-development/app/5-agent-skills.md |
Mirrors the exercise in Chinese. |
docs/zh-cn/real-world-development/app/10-review.md |
Mirrors the recap in Chinese. |
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
| ## Customize the report | ||
|
|
||
| OK, we'd like a better report that tells us what ran, whether it succeeded, and what the tools actually reported. Let's update our skill to create that report for us! | ||
| OK, we'd like a better report that tells us what ran, whether it succeeded, and what the tools actually reported. Let's update our skill to create that report! |
| - Unit tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - End to end tests, total number of tests, number succeeded, number failed, a percentage thereof, and the amount of time testing took. | ||
| - Linting, number of lines scanned, number of violations, and the percentage of lines of code that meet the linting requirements. | ||
| Upon completion, report each command that ran and whether it passed, failed, or was blocked. Include test counts, durations, errors, warnings, and other metrics only when the tool reports them. Identify the next action for any failure or blocker, and never describe a skipped or incomplete check as passed. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Align the App and CLI lessons with Tailspin Toys' current
quality-checksskill: unit tests, lint, and type checks. Use explicit prompts and positive scope descriptions, and mirror the changes in the five existing App translations.Correct the App report exercise to add the missing section rather than locate an existing one, remove references to bundled scripts, and request tool-reported metrics with clear pass, fail, and blocked outcomes.
Type of change
website/Astro + Starlight wrapper).github/copilot-instructions.md, instructions, agents, skills)Verification
Verified the 14 affected output routes, titles, updated scope text, and exercise prompts against the source. Reviewed copied content alignment. Browser layout validation was not needed for these prose-only changes.
Screenshots
N/A: prose-only changes.
Notes for reviewers
Playwright MCP lessons and separate frontend E2E requirements are unchanged. Localized CLI lessons still follow an older contribution-skill exercise; rewriting them is outside this change.
Related template cleanup: github-samples/tailspin-toys#126.
Dependency installation reported existing audit findings; dependency manifests and lockfiles are unchanged.