skills.rest
foxzool
foxzoolCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

openlark-design-review

Audit OpenLark crate public APIs and produce prioritized P0–P3 remediation TODOs.

103|27|Updated Apr 9, 2024
Search Tags:#api design#rust#design review#code audit#public api#feature gating#crate review
One-click install
npx skills add https://github.com/foxzool/open-lark --skill openlark-design-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: openlark-design-review
Source: https://github.com/foxzool/open-lark/tree/main/.agents/skills/openlark-design-review
Command: npx skills add https://github.com/foxzool/open-lark --skill openlark-design-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill turns ad-hoc, opinionated design feedback into a repeatable, evidence-backed design and public API audit for OpenLark crates and modules, reducing ambiguity around entry points, feature gating, execution patterns, and compatibility risk.

Core Features & Use Cases

  • Checklist-driven audit for public API entry design, re-exports, Builder/Request/Service consistency, endpoint scheme, config lifecycle, error handling, and testing/warning control.
  • Quantified API completion metrics that exclude deprecated meta.Version=old entries and produce per-bizTag and per-crate completion tables.
  • Prioritized remediation output with P0–P3 issues, precise path:line evidence, a single selected convergence pattern (A or B), migration steps and <=10 executable TODOs.
  • Use cases: crate-level design review, cross-crate convergence before release, strategic breaking-change planning, and sprintable refactor planning.

Quick Start

Run a design review on the target crate (for example crates/openlark-docs) and return a conclusion overview, API completion table, prioritized issue list with path:line evidence, a chosen convergence scheme, and an executable P0–P3 TODO list.

Frequently Asked Questions about openlark-design-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I perform a public API design review for a Rust crate?▼

A Rust crate public API design review systematically analyzes entry points, feature gating, and Builder/Service consistency to produce prioritized remediation actions. It checks endpoint schemes, config lifecycle, error handling, and documentation synchronization to ensure API stability.

What is feature gating consistency in a crate code audit?▼

Feature gating consistency in a crate code audit ensures conditional compilation flags align with public API entry points and module exports. It verifies that enabled or disabled features do not break Request/Service/Builder patterns or expose incomplete endpoint schemes.

How do I quantify API completion metrics for a Rust module?▼

API completion metrics for a Rust module are quantified by evaluating public API entry points against a checklist, excluding deprecated meta.Version=old entries. This produces per-bizTag and per-crate completion tables measuring design and implementation readiness.

How do I plan breaking changes and refactor a Rust crate before release?▼

Planning breaking changes for a Rust crate release involves selecting a convergence pattern, either A or B, and generating executable P0-P3 TODOs. This provides migration steps with precise path:line evidence to prioritize and sprint refactor tasks.

Can I audit Request, Service, and Builder execution patterns across multiple crates?▼

Yes, you can audit Request, Service, and Builder execution patterns across multiple crates for cross-crate convergence. The review checks pattern consistency, endpoint schemes, and error handling, producing evidence-coded findings with path:line references.

What limitations exist when reviewing deprecated Rust API entries?▼

When reviewing deprecated Rust API entries, limitations involve excluding meta.Version=old entries from quantified API completion metrics. The audit focuses on active public API surfaces, ensuring deprecated paths do not skew the completion tables or convergence pattern selection.

Related Skills

Explore More Software Engineering Skills→
luongldptitluongldptit

rust-patterns

Apply idiomatic Rust patterns for ownership, error handling, and concurrency.

Community
Intermediate
Lin-0096Lin-0096

audit

Audit codebases for accessibility, performance, theming, responsive design, and anti-patterns.

Community
Advanced
trystan2ktrystan2k

biome

Configure Biome as a unified linter and formatter for JavaScript/TypeScript projects.

Community
Advanced
GoldziherGoldziher
115

Rust Module Organization & Public API Design

Guide Rust library module organization and public API design with cargo-public-api.

Community
Intermediate