Feature/update composable preview image + README - #131
Merged
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
WalkthroughThis PR adds GitHub issue templates and config, a Code of Conduct and CONTRIBUTING guide, expands and restructures README and README_DEPRECATED content (badges, intro, setup, examples wrapped in collapsible blocks), and appends community/governance footer sections. ChangesDocumentation and Community Governance Enhancement
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
760-766:⚠️ Potential issue | 🟡 MinorFix the extra closing parenthesis in the Dropshots preview example
Dropshots(is closed twice (ThresholdValidator(...)ends with))and there’s another)on the next line), so the snippet won’t compile as written.🐛 Suggested fix
- Dropshots( - resultValidator = ThresholdValidator(config.comparisonThreshold)) - ) + Dropshots( + resultValidator = ThresholdValidator(config.comparisonThreshold) + )🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 760 - 766, The example in DropshotsPreviewRule.createFor has an extra closing parenthesis when constructing Dropshots with resultValidator = ThresholdValidator(config.comparisonThreshold)), causing a compile error; remove the surplus ')' so the Dropshots(...) call is properly balanced (i.e., ensure Dropshots(resultValidator = ThresholdValidator(config.comparisonThreshold)) has only the required closing parens) in the createFor lambda that constructs Dropshots.
🧹 Nitpick comments (1)
README.md (1)
113-119: ⚡ Quick winLabel the JitPack snippet as Groovy DSL.
This example is written in Groovy syntax, but the fenced block is marked
kotlin. That makes the syntax highlighting misleading and invites copy/paste into the wrong Gradle dialect.♻️ Suggested fix
-```kotlin +```groovy🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 113 - 119, The fenced code block showing the Gradle snippet is labeled as `kotlin` but the content is Groovy DSL; update the fenced block marker to `groovy` so syntax highlighting and copy/paste are correct. Locate the Markdown block containing the snippet starting with "allprojects { repositories { maven { url = uri('https://jitpack.io') } } }" in README.md and change the opening triple-backtick language tag from `kotlin` to `groovy`.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 17-18: Update the CONTRIBUTING.md copy that currently reads
"create your branch from `main`" to use neutral wording like "create your branch
from the repository’s default branch" so contributors aren't misled when the
default branch is `master`; edit the line in the first steps list (the sentence
containing `main`) to replace the hard-coded branch name with "the repository’s
default branch" (or equivalent wording).
In `@README.md`:
- Line 13: The README's hero image tag <img
src="composable_preview_scanner_new_logo.png"> and the overview image referenced
on the other line lack alt text; update both image tags to include descriptive
alt attributes (e.g., alt="Composable Preview Scanner logo" for
composable_preview_scanner_new_logo.png and an appropriate description for the
overview image) so screen readers and markdownlint are satisfied; make sure the
alt text is concise and meaningful and update any other <img> occurrences in the
README that are missing alt attributes.
---
Outside diff comments:
In `@README.md`:
- Around line 760-766: The example in DropshotsPreviewRule.createFor has an
extra closing parenthesis when constructing Dropshots with resultValidator =
ThresholdValidator(config.comparisonThreshold)), causing a compile error; remove
the surplus ')' so the Dropshots(...) call is properly balanced (i.e., ensure
Dropshots(resultValidator = ThresholdValidator(config.comparisonThreshold)) has
only the required closing parens) in the createFor lambda that constructs
Dropshots.
---
Nitpick comments:
In `@README.md`:
- Around line 113-119: The fenced code block showing the Gradle snippet is
labeled as `kotlin` but the content is Groovy DSL; update the fenced block
marker to `groovy` so syntax highlighting and copy/paste are correct. Locate the
Markdown block containing the snippet starting with "allprojects { repositories
{ maven { url = uri('https://jitpack.io') } } }" in README.md and change the
opening triple-backtick language tag from `kotlin` to `groovy`.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 02efc945-b69b-480b-9762-7bc75e15544d
⛔ Files ignored due to path filters (3)
composable_preview_scanner_new_logo.pngis excluded by!**/*.pngcomposable_preview_scanner_overview.pngis excluded by!**/*.pngcomposable_preview_scanner_overview_deprecated.pngis excluded by!**/*.png
📒 Files selected for processing (7)
.github/ISSUE_TEMPLATE/bug_report.md.github/ISSUE_TEMPLATE/config.yml.github/ISSUE_TEMPLATE/feature_request.mdCODE_OF_CONDUCT.mdCONTRIBUTING.mdREADME.mdREADME_DEPRECATED.md
Contributor
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
README.md (2)
759-765:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix the extra closing parenthesis in the Dropshots example.
Dropshots(...)is closed twice here, so this Kotlin snippet won’t compile as written.Suggested fix
- Dropshots( - resultValidator = ThresholdValidator(config.comparisonThreshold)) - ) + Dropshots( + resultValidator = ThresholdValidator(config.comparisonThreshold) + )🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 759 - 765, In DropshotsPreviewRule.createFor, the Dropshots constructor call is closed twice causing a syntax error; edit the expression that builds Dropshots(resultValidator = ThresholdValidator(config.comparisonThreshold)) inside the let block (in the createFor function) to remove the extra closing parenthesis so the parentheses properly match for Dropshots(...) and ThresholdValidator(...), resulting in a single, well-formed Dropshots(...) return value when getAnnotation<DropshotsConfig>() yields a config.
810-814:⚠️ Potential issue | 🟠 MajorFix README snippet to use the correct
scanFileoverload
AndroidComposablePreviewScanner.scanFileexposesscanFile(targetInputStream: InputStream, customPreviewsInfoInputStream: InputStream)(andscanFile(jsonFile: File)), but the README callsscanFile(getInstrumentation().context.assets.open("scan_result.json"))with only oneInputStream. Update the example to pass both streams (or switch to theFileoverload).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 810 - 814, The README example calls AndroidComposablePreviewScanner.scanFile with a single InputStream but the API requires either scanFile(targetInputStream: InputStream, customPreviewsInfoInputStream: InputStream) or scanFile(jsonFile: File); update the snippet to use the proper overload by passing both streams to AndroidComposablePreviewScanner.scanFile (e.g., supply the additional customPreviewsInfoInputStream) or switch to the scanFile(jsonFile: File) overload, then continue chaining includeAnnotationInfoForAllOf(DropshotsConfig::class.java).
♻️ Duplicate comments (1)
README.md (1)
2-3:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winRestore descriptive alt text in the top images.
The top badges and hero logo still have empty alt text, and the overview image alt is just the filename. Line 3’s badge URL also looks typoed (
yell→yellow). Please fix these so the README stays accessible and the badge renders correctly.Also applies to: 6-8, 11-13, 23-23
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 2 - 3, Top images and badges in the README have empty or non-descriptive alt text and one badge color typo ("yell"); update the image markdown for the badges and hero/overview images (the badge markup starting with [], the Maven Central badge markup with query=https%3A%2F%2Frepo..., and any other badge/image lines referenced later) to include meaningful alt text (e.g., "JitPack badge", "Maven Central badge", "Downloads badge", and a descriptive alt for the hero/overview image instead of the filename) and fix the color value "yell" to "yellow"; apply the same alt-text and typo fixes to the other badge/image groups noted (lines referenced as 6-8, 11-13, and 23) so all badges and images are accessible and render correctly.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@README.md`:
- Around line 759-765: In DropshotsPreviewRule.createFor, the Dropshots
constructor call is closed twice causing a syntax error; edit the expression
that builds Dropshots(resultValidator =
ThresholdValidator(config.comparisonThreshold)) inside the let block (in the
createFor function) to remove the extra closing parenthesis so the parentheses
properly match for Dropshots(...) and ThresholdValidator(...), resulting in a
single, well-formed Dropshots(...) return value when
getAnnotation<DropshotsConfig>() yields a config.
- Around line 810-814: The README example calls
AndroidComposablePreviewScanner.scanFile with a single InputStream but the API
requires either scanFile(targetInputStream: InputStream,
customPreviewsInfoInputStream: InputStream) or scanFile(jsonFile: File); update
the snippet to use the proper overload by passing both streams to
AndroidComposablePreviewScanner.scanFile (e.g., supply the additional
customPreviewsInfoInputStream) or switch to the scanFile(jsonFile: File)
overload, then continue chaining
includeAnnotationInfoForAllOf(DropshotsConfig::class.java).
---
Duplicate comments:
In `@README.md`:
- Around line 2-3: Top images and badges in the README have empty or
non-descriptive alt text and one badge color typo ("yell"); update the image
markdown for the badges and hero/overview images (the badge markup starting with
[], the
Maven Central badge markup with query=https%3A%2F%2Frepo..., and any other
badge/image lines referenced later) to include meaningful alt text (e.g.,
"JitPack badge", "Maven Central badge", "Downloads badge", and a descriptive alt
for the hero/overview image instead of the filename) and fix the color value
"yell" to "yellow"; apply the same alt-text and typo fixes to the other
badge/image groups noted (lines referenced as 6-8, 11-13, and 23) so all badges
and images are accessible and render correctly.
sergio-sastre
force-pushed
the
feature/update_composable_preview_image
branch
from
June 12, 2026 10:56
b0f609a to
35c5150
Compare
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
759-763:⚠️ Potential issue | 🟡 MinorFix the extra parenthesis in the
Dropshots(...)example inREADME.md(lines 759-763).The snippet currently has one extra
)(ThresholdValidator(config.comparisonThreshold))plus the next line’s)), so it won’t compile as written.🛠️ Proposed fix
- Dropshots( - resultValidator = ThresholdValidator(config.comparisonThreshold)) - ) + Dropshots( + resultValidator = ThresholdValidator(config.comparisonThreshold) + )🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@README.md` around lines 759 - 763, The example constructing Dropshots has an extra closing parenthesis after ThresholdValidator(config.comparisonThreshold) which causes mismatched parentheses; update the snippet so the ThresholdValidator call is closed once and the Dropshots(...) invocation has the correct single closing paren—i.e. fix the parentheses around ThresholdValidator(config.comparisonThreshold) inside the Dropshots(resultValidator = ...) call (symbols: Dropshots, ThresholdValidator, preview.getAnnotation<DropshotsConfig>).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Line 10: Replace the empty-alt and placeholder-link badges so they’re
accessible and not dead links: for each badge markdown token (the
Kotlin-Multiplatform, Platform-Android, Platform-Desktop badge images) provide
concise alt text inside the square brackets (e.g. [Kotlin Multiplatform],
[Android platform], [Desktop platform]) or mark purely decorative with an
explicit alt="" if appropriate, and replace the placeholder hrefs "(#)" with the
correct target URLs (project pages, vendor docs, or the image source) or remove
the surrounding link to leave a plain image if no target exists; update all
occurrences of these badges (including the other instances referenced) so the
alt text and hrefs are fixed consistently.
---
Outside diff comments:
In `@README.md`:
- Around line 759-763: The example constructing Dropshots has an extra closing
parenthesis after ThresholdValidator(config.comparisonThreshold) which causes
mismatched parentheses; update the snippet so the ThresholdValidator call is
closed once and the Dropshots(...) invocation has the correct single closing
paren—i.e. fix the parentheses around
ThresholdValidator(config.comparisonThreshold) inside the
Dropshots(resultValidator = ...) call (symbols: Dropshots, ThresholdValidator,
preview.getAnnotation<DropshotsConfig>).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
sergio-sastre
force-pushed
the
feature/update_composable_preview_image
branch
2 times, most recently
from
June 12, 2026 13:37
acee2ec to
ab2127a
Compare
sergio-sastre
force-pushed
the
feature/update_composable_preview_image
branch
from
June 12, 2026 13:41
ab2127a to
d0a932b
Compare
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
1 participant
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 by CodeRabbit