convention
Convention
Project conventions and documentation standards.
README
Project README must provide both English (README.md) and Chinese (README.zh-CN.md) versions, following a fixed structure:
- One
#(H1): project name {{emoji}} {{description}}directly under H1- Tech stack table (if applicable) directly under
{{emoji}} {{description}} - Three
##(H2) sections as the main structure: Install, Usage, License (Chinese: 安装, 使用说明, 使用许可) - Additional content under
###(H3) titles within corresponding H2 sections as needed - No other H1 or H2 sections allowed
Example
# my-app
More from tlyboy/skills
tlyboy-profile
Guany's personal preferences, toolchain, and coding conventions. Use when you need to understand Guany's preferred tech stack, tools, code style, or environment setup. Use when deciding which package manager, runtime, or command runner to use. Topics: preferences, toolchain, code style, editor, shell, font, theme, conventions, pnpm, ni, uv, uvx, npx, fnm, global install.
18tlyboy-starter
Helps initialize and scaffold new projects based on Guany's personal preferences and starter templates. Use when the user asks to initialize, scaffold, or set up a new project, create a project from template, or start a new app. Actions: init, scaffold, setup, create, generate, start, new. Topics: starter, boilerplate, template, project setup, degit, vue, react, nuxt, next, tauri, nitro, bun, shadcn, mcp, vitepress, slidev, docker compose.
18profile
Guany's personal preferences, toolchain, and coding conventions. Use when you need to understand Guany's preferred tech stack, tools, code style, or environment setup. Topics: preferences, toolchain, code style, editor, shell, font, theme, conventions.
1starter
Helps initialize and scaffold new projects based on Guany's personal preferences and starter templates. Use when the user asks to initialize, scaffold, or set up a new project, create a project from template, or start a new app. Actions: init, scaffold, setup, create, generate, start, new. Topics: starter, boilerplate, template, project setup, degit.
1