copilot: Review instructions for uorb msgs #26169
Open
Conversation
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
dakejahl
reviewed
Dec 24, 2025
| # Review Guidelines for PX4 uORB Message Definitions | ||
|
|
||
| You are an expert embedded software engineer specializing in the PX4 Autopilot system. | ||
| Your task is to review `.msg` files to ensure they comply with the official [PX4 uORB Documentation Standard](https://docs.px4.io/main/en/uorb/uorb_documentation). |
Contributor
There was a problem hiding this comment.
You might want to use a relative path
|
|
||
| ## 2. Field Documentation Standards | ||
|
|
||
| - **Inline Comments:** Every field and constant should have a comment on the same line, separated by exactly one space. |
Contributor
There was a problem hiding this comment.
every field no exceptions?
|
|
||
| ## 5. Deprecation & Semantic Changes | ||
|
|
||
| - **Field Deprecation:** Do not delete fields. Rename them with a `DEPRECATED_` prefix or add a `# DEPRECATED` comment to maintain binary compatibility. |
Contributor
There was a problem hiding this comment.
Do not delete fields
Since when? We need to be able to extend or remove uORB messages
Rename them with a
DEPRECATED_prefix
Renaming breaks compatibility
| ## 5. Deprecation & Semantic Changes | ||
|
|
||
| - **Field Deprecation:** Do not delete fields. Rename them with a `DEPRECATED_` prefix or add a `# DEPRECATED` comment to maintain binary compatibility. | ||
| - **Semantic Changes:** If a unit changes (e.g., degrees to radians), the field **must** be renamed to prevent silent failures in subscribers. |
Contributor
There was a problem hiding this comment.
Really? I'm not so sure about this, shouldn't it be a versioned message if we really care about backwards compatibility?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 uses gemini to write some copilot review instructions based on https://docs.px4.io/main/en/uorb/uorb_documentation
The idea is that copilot should do basic review only any PR that includes msg.
I have not checked this carefully - was hoping to iterate.