Repository navigation
[No QA] Add CONSISTENCY-19 - prop comment must add information rule - #99906
roryabraham merged 12 commits into
Conversation
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: add6daf045
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. Chef's kiss. Reviewed commit: ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
|
@MelvinBot review |
ReviewThe direction is right and the ESLint change is safe. One real gap in the rule wording, plus two nits. 1. A name-echoing
|
|
@MelvinBot review again please, addressed your concerns |
Re-review — all three addressed 👍
1. The The four rules now partition the space with no gap and no double-flag:
2. 3. One optional nit (non-blocking)
What I checked
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ee5740dc85
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 38fcf40262
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
Reviewer Checklist
Screenshots/VideosAndroid: HybridAppN/A Android: mWeb ChromeN/A iOS: HybridAppN/A iOS: mWeb SafariN/A MacOS: Chrome / SafariN/A |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 689303413d
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c94c4670e6
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c94c4670e6
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
@codex review |
|
Codex Review: Didn't find any major issues. 👍 Reviewed commit: ℹ️ About Codex in GitHubCodex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback". |
|
@MelvinBot review |
Re-review of the six new commitsThe per-nesting-level and diff-scoping work is solid, and the four-rule partition I mapped last time still holds for the cases it covered. But three of the newer commits opened seams. One is a concrete double-flag that this PR widens; the other two are in CONSISTENCY-19. 1. CONSISTENCY-13 double-flags the
|
|
@MelvinBot points addressed, please re-review |
Re-review — all six addressed 👍
The negative example is the one I'd have pushed hardest for. It's the central behavioral change of the whole PR and now it's shown explicitly, matching STYLE.md's undocumented One optional leftover (non-blocking)The Search Patterns at What I checked
|
|
@brunovjk all yours now |
|
@JakubKorytko thanks for the work on this PR! One question before approving: with |
that is still a thing for the all consistency- rules, did not want to change it since it would impact the whole AI reviewer. IMO it is out of scope, so posted as a separate proposal in #expert-contributors but I don't think we should block this PR on that - if the proposal is approved, all is good. If it is rejected then well, nothing more to do here either 😄 |
brunovjk
left a comment
There was a problem hiding this comment.
Thanks for clarifying! Since the gap is already known and being discussed separately, I’m fine treating it as out of scope for this PR. Approving 👍
|
✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release. |
|
🚧 roryabraham has triggered a test Expensify/App build. You can view the workflow run here. |
|
🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
|
|
🚀 Deployed to staging by https://github.com/roryabraham in version: 9.4.74-0 🚀
|
|
🚀 Deployed to production by https://github.com/mountiny in version: 9.4.74-2 🚀
|
Explanation of Change
Adds reviewer rule CONSISTENCY-19 "Prop comment must add information", flagging prop comments that only restate the prop's name/type. Amends CONSISTENCY-10 and CONSISTENCY-13's examples (which taught the now-flagged pattern) and the "Code Documentation" section of STYLE.md to require prop comments only where they add a unit, default, constraint, or sibling distinction. Also drops
TSPropertySignaturefromjsdoc/require-jsdoc's contexts forsrc/types/onyx/**, moving per-property documentation enforcement there from ESLint to CONSISTENCY-13/19, since ESLint can't tell whether a property has anything non-obvious to say.Out of scope for this PR, left as deliberate follow-ups:
src/types/onyx/BillingReceiptDetails.ts:1andsrc/types/onyx/OriginalMessage.ts:1739carry file-wide/* eslint-disable jsdoc/require-jsdoc */that predates this change. WithTSPropertySignaturedropped, those disables may now be partially redundant (only the type-level requirement remains), but narrowing/removing them risks surfacing other lint issues those blanket disables were suppressing, so that's left for a separate PR.Fixed Issues
$ #99453
PROPOSAL: Slack
Tests
N/A
Offline tests
N/A
QA Steps
N/A
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari