Repository navigation
docs: add linter PR review guidelines - #5785
Merged
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Yuchao Yan (msyyc)
requested review from
Mark Cowlishaw (markcowl),
Timothee Guerin (timotheeguerin) and
Jeff Fisher (xirzec)
as code owners
October 21, 2026 06:26
Contributor
|
No changes needing a change description found. |
Contributor
|
You can try these changes here
|
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
This documentation-only change has no blocking issues; the retained feedback is a minor clarification of changelog exclusions.
No open issues 🎉
What changed in this PR
Adds TypeSpec linter implementation and review guidance based on recurring migration feedback.
Changes:
- Clarifies rule scope, reuse, and focused regression testing.
- Defines author-facing documentation and example validation expectations.
- Documents changelog placement, coverage, and validation reporting.
| File | Description |
|---|---|
.github/copilot-instructions.md |
Adds linter implementation, testing, documentation, and changelog guidelines. |
Review effort: Balanced
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Timothee Guerin <tiguerin@microsoft.com>
Co-authored-by: Timothee Guerin <tiguerin@microsoft.com>
Make lean, rule-scoped test coverage explicit while preserving distinct regression coverage. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Yuchao Yan (msyyc)
enabled auto-merge
October 22, 2026 06:24
Timothee Guerin (timotheeguerin)
approved these changes
Oct 22, 2026
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
Add concise review guidance for all linter PRs to the existing
.github/skills/code-review/SKILL.md:The guidance applies to all linter PRs. Changelog guidance is directed at reviewing agents; general entry-creation instructions are not repeated. The existing review skill is preserved, and
.github/copilot-instructions.mdis restored to its pre-PR content.Review evidence
Representative feedback: test ownership, representative coverage, author-facing docs, focused examples, and changelog noise.
Validation
Formatting, final-file Prettier check, root lint, and whitespace checks passed. Unrelated formatter-only output was excluded. Verified that the existing review skill is preserved, the moved authoring-guide link resolves, and general Copilot instructions are restored to their pre-PR content. Documentation-only; no package release entry required.
Source branch:
Azure/typespec-azure:docs/linter-review-instructions; target:main.