with one click
api-review
A skill to review pending work for API design compliance in the
Menu
A skill to review pending work for API design compliance in the
| name | api_review |
| description | A skill to review pending work for API design compliance in the |
This skill provides instructions for evaluating pending work (e.g., a local git branch or CL) to ensure that any new or modified Public APIs comply with AndroidX/Jetpack API guidelines.
When the user asks for their pending work to be reviewed for API design, follow these steps:
updateApi)First, run the updateApi task to ensure all recent changes are accurately
reflected in the API tracking files (e.g., current.txt or
restricted_current.txt). This catches any new modifications that haven't been
tracked yet.
./gradlew updateApi
appcompat-resources in the appcompat
group)
./gradlew :appcompat:appcompat-resources:updateApi
./gradlew :compose:module:updateAbiNative
Note: Use the single module command if the user's changes are scoped to a specific module to save time.
After running the command, you will perform the API review over all pending
changes in the API .txt files. This includes changes that updateApi just
added, as well as any changes that were already pending in those files.
Once the changed API signatures are identified in the .txt files (or from
pending changes to those .txt files in the current work), you must apply
the corresponding API design guidelines to evaluate them:
docs/api_guidelines/compose/
directory), you must also evaluate against:
docs/api_guidelines/compose_api_guidelines/Produce an explanation for the user on how their pending APIs comply with the relevant guidelines.
Benchmarking and improving the performance of Jetpack Compose. Use this skill when requested to run, analyze, or create microbenchmarks and macrobenchmarks for Compose components or features.
Ensure KDocs are high quality, concise, active, and explicitly linked to API components.
Use this skill to find Compose feature flags introduced by a specific git user or email and map them to the library version in which they were added.
A skill for building instrumented tests in Remote Compose using GridScreenshotUI.
A skill for building instrumented screenshot tests in Remote Compose using RemoteScreenshotTestRule.
A skill for creating, amending, formatting, and uploading commits in the AndroidX frameworks/support project