Add copilot instructions for auto-review#2447
Merged
lmolkova merged 5 commits intoopen-telemetry:mainfrom Jul 1, 2025
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
Adds a repository-level document defining GitHub Copilot custom instructions for reviewing OpenTelemetry Semantic Conventions pull requests.
- Introduces critical criteria and prerequisites for new convention areas
- Outlines general review principles, naming, attribute/event/error guidelines, and common issues to flag
- Provides response guidelines and resource links
Comments suppressed due to low confidence (3)
.github/copilot-instructions.md:19
- The schema link currently points to the
weaverrepository; updating it to reference the localmodel/semconv.schema.jsonin this repository will ensure accuracy and easier maintenance.
- Validate against [schema](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv.schema.json)
.github/copilot-instructions.md:19
- [nitpick] Nested list items use two-space indentation, but standard Markdown rendering recommends four spaces for sublists; consider adjusting indentation for consistent formatting.
- Validate against [schema](https://github.com/open-telemetry/weaver/blob/main/schemas/semconv.schema.json)
.github/copilot-instructions.md:1
- GitHub Copilot custom instructions must be defined in a YAML file named
.github/copilot.yml(or.github/copilot-settings.yml) rather than a Markdown file; consider renaming and converting this document into the supported YAML format.
# Copilot Instructions for OpenTelemetry Semantic Conventions
trask
approved these changes
Jun 28, 2025
Member
trask
left a comment
trask
left a comment
There was a problem hiding this comment.
Good idea! Looking forward to seeing how it works / iterating on it.
jsuereth
approved these changes
Jun 29, 2025
Contributor
jsuereth
left a comment
jsuereth
left a comment
There was a problem hiding this comment.
Should we add the (now merged) Entity Modeling guide?
github-project-automation
Bot
moved this from Untriaged
to Needs More Approval
in Semantic Conventions Triage
joaopgrassi
approved these changes
Jun 30, 2025
Member
joaopgrassi
left a comment
joaopgrassi
left a comment
There was a problem hiding this comment.
Let's see how good this is!
lmolkova
moved this from Needs More Approval
to Ready to be Merged
in Semantic Conventions Triage
jherbage
pushed a commit
to jherbage/semantic-conventions
that referenced
this pull request
Jul 1, 2025
spurplewang
pushed a commit
to spurplewang/semantic-conventions
that referenced
this pull request
Jul 10, 2025
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.
Adds instructions for review/coding agent based on contributing.md and general guidance.
Tried on a few PRs, it seems to produce some reasonable advice, but definitely can be tuned further.