Add skills for PR content review#109
Merged
Merged
Conversation
KittyChiu
requested review from
a team and
bot-digital-customer-success
as code owners
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces new GitHub Copilot skill definitions intended to standardize how WAF content/ documentation is reviewed (editorially and for technical substance), and adds a repository PR template to guide contributors when opening pull requests.
Changes:
- Added an
editorial-reviewskill that defines an Editor-in-Chief style review process with scoring, criteria, and a structured output format. - Added a
technical-writing-reviewskill focused on architectural correctness, decision quality, trade-offs, and actionability for WAF content. - Added a
.github/pull_request_template.mdto standardize PR author inputs and contributor checklists.
Show a summary per file
| File | Description |
|---|---|
| .github/skills/technical-writing-review/SKILL.md | Adds a technical substance review skill for WAF content under content/. |
| .github/skills/editorial-review/SKILL.md | Adds an editorial/scoring-based review skill for WAF content under content/. |
| .github/pull_request_template.md | Adds a PR template to guide contributors and reviewers. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 3/3 changed files
- Comments generated: 4
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.
This pull request introduces two major improvements to the project: a new editorial review skill for WAF content and a standardized pull request template. The editorial review skill provides comprehensive guidance for reviewing documentation to ensure clarity, consistency, and publication readiness, while the PR template helps contributors provide essential context and maintainers to review changes efficiently.
Editorial review skill for WAF content:
.github/skills/editorial-review/SKILL.md, which defines an "editorial-review" skill for reviewing and refining GitHub Well-Architected Framework (WAF) documentation. This skill outlines goals, evaluation criteria, review procedure, scoring, and guardrails to ensure all content meets high editorial standards for clarity, precision, and audience relevance.Pull request process improvements:
.github/pull_request_template.md, introducing a standardized template for pull requests. The template prompts contributors to describe what changed and why, select the type of change, complete a checklist, and provide reviewer notes, improving PR quality and review efficiency.