What problem does it solve?
OpenLark naming conventions provide a standardized approach for public API types (Client/Service/Resource/Request/Builder) to improve readability, maintainability, and onboarding when designing or refactoring APIs. It helps manage meta call chains and module exports/preludes to avoid semantic clashes like DocsService in related crates.
Core Features & Use Cases
- Establishes explicit naming rules for Client, Service, Resource, Request, and Builder types to improve readability and maintainability.
- Guides versioned naming to avoid collisions and clarifies meta call chains (e.g., client.xxx.v1.yyy) to maintain a clean API surface.
- Helps detect and resolve naming conflicts across modules and prelude exports, improving API discoverability and consistency across the SDK.
Quick Start
Review a target module and propose naming changes that align with the OpenLark naming conventions.