Skip to content

ComposeA11yScanner 15-minute testing checklist #31

Description

@mohdaquib

Thanks for helping test ComposeA11yScanner! This is designed to take about 15 minutes. No ongoing commitment or accessibility expertise is required.

Goal

Try ComposeA11yScanner on one screen in a real Jetpack Compose app and report whether setup and the resulting findings are useful.

Please use a debug build only. The scanner is intended to complement—not replace—testing with TalkBack, font scaling, keyboard or switch access, and human accessibility review.

Testing checklist

1. Add the scanner (~5 minutes)

  • Use a Jetpack Compose app with a minimum SDK of 24 or newer.
  • Add JitPack to dependency resolution if it is not already configured:
// settings.gradle.kts
dependencyResolutionManagement {
    repositories {
        google()
        mavenCentral()
        maven("https://jitpack.io")
    }
}
  • Add the scanner to the debug variant only:
// app/build.gradle.kts
dependencies {
    debugImplementation("com.github.mohdaquib.ComposeA11yScanner:scanner-ui:2.1.0")
}
  • Build and launch the debug app.
  • Note whether setup worked as documented or required any additional steps.

AndroidX Startup should attach the scanner and run an initial scan automatically. Please do not add the dependency with implementation or reference it from release source sets.

2. Try one screen (~5 minutes)

  • Open one representative Compose screen.
  • Review the issue summary and highlighted elements.
  • Open at least one issue detail and read its suggested fix.
  • If practical, try a second UI state, theme, or destination.
  • Note any finding that appears incorrect or any issue you expected but did not see.

Optional: trigger another scan from a debug source set:

import com.composea11yscanner.ComposeA11yScanner

ComposeA11yScanner.triggerScan()

3. Share feedback (~5 minutes)

Reply to this issue using the template below. Partial feedback is welcome—please omit anything you cannot share, and remove sensitive app information from screenshots or exported results.

Feedback template

### Environment

- ComposeA11yScanner version: 2.1.0
- Android version/API level:
- Compose version (if known):
- App structure: Navigation Compose / Fragments / ComposeView / other
- Device or emulator:

### Installation

- [ ] Worked exactly as documented
- [ ] Worked after additional steps
- [ ] Did not work

Additional steps or error messages:

### Scan results

- Screen or UI state tested:
- Number/types of findings (approximate is fine):
- Were the highlighted elements easy to identify? Yes / Partly / No
- Were the messages and suggested fixes understandable? Yes / Partly / No
- Which finding was most useful?

### Problems noticed

- False positives (reported issue appears invalid):
- False negatives (expected issue was not reported):
- Crash, performance, navigation, or overlay problems:
- Anything confusing about setup or the UI:

### Overall

- Would you use this during Compose development? Yes / Maybe / No
- What is the single most important improvement?
- Other comments:

For incorrect scan results, a screenshot, reproduction steps, and exported scan-result JSON are especially useful. Please remove sensitive information before attaching anything.

Project documentation: https://github.com/mohdaquib/ComposeA11yScanner#quick-start

Thank you for lending a few minutes and helping improve accessibility tooling for Compose.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions