chore: add agent review instructions #407
Conversation
marcoscaceres
changed the title
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive review guidelines for GitHub Copilot when reviewing pull requests to the Digital Credentials W3C specification. The instructions document establishes clear standards for editorial quality, ReSpec syntax, normative references, algorithm design, and various quality attributes (security, accessibility, i18n).
Key Changes:
- Added detailed Copilot review instructions covering editorial quality, ReSpec linking conventions, and W3C standards compliance
- Documented normative dependencies and browser interoperability requirements
- Established guidelines for accessibility, internationalization, security, and RFC 2119 keyword usage
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
marcoscaceres
changed the title
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
.github/copilot-instructions.md
Outdated
| - `BREAKING CHANGE:` | ||
|
|
||
| For normative changes, **do not use any prefix**. |
There was a problem hiding this comment.
Contradiction in commit message conventions: BREAKING CHANGE: is listed under "Allowed prefixes (non-normative changes only)" but breaking changes are inherently normative (they affect WebIDL, algorithms, observable behavior, etc. as described in lines 320-324).
Consider either:
- Removing
BREAKING CHANGE:from the non-normative prefixes list and treating it as a special case, OR - Clarifying that
BREAKING CHANGE:is an exception to the "non-normative changes only" rule
The <BreakingChange> section (lines 316-325) makes it clear that breaking changes are normative, so the categorization here is misleading.
| - `BREAKING CHANGE:` | |
| For normative changes, **do not use any prefix**. | |
| For normative changes, **do not use any prefix**. | |
| Exception: For breaking normative changes, the commit message MUST begin with `BREAKING CHANGE:` (see <BreakingChange> below). |
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 10 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Add instructions for co-pilot for what to check for when doing reviews.
marcoscaceres
force-pushed
the
marcoscaceres-patch-1
branch
from
0c46218 to
c917efd
Compare
marcoscaceres
changed the title
| --- | ||
|
|
||
| <LanguageAndEditorial> | ||
| - Check spelling, grammar, punctuation, and clarity. |
There was a problem hiding this comment.
Need to specify which English, i.e., UK vs US, for spelling.
There was a problem hiding this comment.
I think we should be ok here. As we discussed on the call, that was because the ISO document's title used the UK spelling, so we had no option but to also use it.
Add instructions for copilot for what to check for when doing reviews.
This pull request adds a comprehensive set of review instructions for Copilot to use when reviewing pull requests to the Digital Credentials Specification. The new
.github/copilot-instructions.mdfile establishes clear editorial, technical, and procedural guidelines to ensure high-quality, standards-compliant contributions. The instructions cover editorial quality, ReSpec conventions, normative references, algorithm requirements, accessibility, internationalization, security, conformance, and more.