openlark-code-standards

Audit OpenLark repository crates for API and style consistency with file:line evidence.

103|27|Updated Apr 9, 2024
One-click install
npx skills add https://github.com/foxzool/open-lark --skill openlark-code-standards
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openlark-code-standards
Source: https://github.com/foxzool/open-lark/tree/main/.agents/skills/openlark-code-standards
Command: npx skills add https://github.com/foxzool/open-lark --skill openlark-code-standards

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a rapid, evidence-based code standards audit for the OpenLark repository to detect inconsistencies in API implementations, parameter validation, naming, exports, and endpoint definitions, enabling reviewers and maintainers to produce actionable remediation lists.

Core Features & Use Cases

  • Rule-evidence mapping: locate file:line evidence for each rule (for example Request/Response + Builder patterns, execute()/execute_with_options, Transport::request usage).
  • Risk classification: assign P0/P1/P2 severity and provide prioritized remediation suggestions.
  • PR-ready minimal checks: generate a compact checklist for new API additions to guide reviewers.
  • Use Cases: run during PR review, before adding new APIs, or for periodic repository health checks focusing on crates/openlark-core, crates/openlark-client, crates/openlark-docs, and crates/openlark-communication.

Quick Start

Run the openlark-code-standards skill against crates/openlark-client to produce a rules-evidence checklist with prioritized fixes and a PR-ready minimal review list.

Frequently Asked Questions about openlark-code-standards

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

FAQPage Schema
How do I audit API consistency across OpenLark crates during a PR review?

To audit API consistency across OpenLark crates, run this skill during PR reviews to map rule-to-evidence pairs with file:line references. It checks crates like openlark-core and openlark-client, classifies risks as P0/P1/P2, and outputs a remediation checklist.

What is the best way to validate new API additions in an OpenLark repository?

Validating new API additions in an OpenLark repository involves checking Request/Response Builder patterns and execute_with_options usage. This skill generates a PR-ready minimal checklist to guide reviewers and ensure parameter validation and endpoint definitions meet standards.

How does rule-to-evidence mapping work for OpenLark style guide checks?

Rule-to-evidence mapping for OpenLark style checks locates exact file:line evidence for each rule, such as Transport::request usage and naming conventions. It links style guide violations directly to code locations, enabling precise remediation suggestions.

Can I use this code review tool for repository-wide health checks on OpenLark projects?

Yes, you can use this code review tool for periodic repository-wide health checks on OpenLark projects. It audits style and API consistency across openlark-docs and openlark-communication crates, identifying risks and providing prioritized fixes for maintainers.

What risk classification levels are assigned when checking OpenLark code standards?

When checking OpenLark code standards, risks are classified as P0, P1, or P2 severity levels. This classification prioritizes remediation suggestions so maintainers can address critical API inconsistencies and parameter validation issues first.