Aafff623/readme-deployment
.cursor/skills/readme-deployment/SKILL.md
专业处理 README 与部署文档。Use when writing README, deployment guides, environment variable docs, or project structure documentation. 约定：README 必须包含环境变量表、获取 API Key 的链接、部署步骤、项目结构。
development
Updated Apr 17, 2026
$ install --global
skillsauthnpx skillsauth add Aafff623/pet-adoption-app readme-deploymentInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 17, 2026, 6:19 AM233.4s1 file scanned
SKILL.md
- name:
- readme-deployment
- description:
- 专业处理 README 与部署文档。Use when writing README, deployment guides, environment variable docs, or project structure documentation. 约定：README 必须包含环境变量表、获取 API Key 的链接、部署步骤、项目结构。
README 与部署文档规范
README 必备章节
- 项目简介：一句话说明 + 技术栈表
- 项目结构：目录树，说明核心文件职责
- 本地开发：
npm install、npm run dev、访问地址 - 环境变量：表格形式，含变量名、说明、获取链接
- 数据库/后端初始化：建表、种子数据、认证配置
- 部署：Vercel/Netlify 步骤，含环境变量配置
- 项目瘦身：
.gitignore要点、不提交内容
环境变量表格式
| 变量 | 说明 | 获取方式 |
|------|------|----------|
| `VITE_SUPABASE_URL` | 项目 URL | [Supabase](https://supabase.com/dashboard/project/_/settings/api) → Project URL |
| `VITE_SUPABASE_ANON_KEY` | 匿名公钥 | 同上 → anon public |
必须提供可点击的获取链接，不要只写「在控制台获取」。
部署步骤格式
- 构建命令、输出目录
- 环境变量在平台中的配置路径
- SPA 需说明路由重写（如 vercel.json）
项目瘦身要点
node_modules、dist、.env.local必须忽略- 说明避免提交大文件、构建产物
Related Skills
Aafff623/supabase-calls
tools
VerifiedTrustedCommunity
Guides Supabase usage in petconnect-app including MCP tool calls, migrations, RLS, and API layer conventions. Use when working with Supabase, executing SQL, applying migrations, list_tables, execute_sql, RLS policies, or database schema changes.
SKILL.mdUpdated Apr 17, 2026
Aafff623/repo-slimming
tools
VerifiedTrustedCommunity
项目仓库瘦身与规范。Use when cleaning repo, optimizing .gitignore, removing large files, or organizing project structure. 约定：脚本仅用 PowerShell / npm 跨平台命令，不生成 .sh 文件。
SKILL.mdUpdated Apr 17, 2026
Aafff623/readme-generator
development
VerifiedTrustedCommunity
Generates professional README files by synthesizing standard-readme, Best-README-Template, Google styleguide, and GitHub best practices. Use when creating or redesigning README.md, documenting projects, or when the user asks for README templates or best practices.
SKILL.mdUpdated Apr 17, 2026
Aafff623/project-slimming
testing
VerifiedTrustedCommunity
Safely slim down projects by removing redundant files and dependencies while ensuring delivery readiness and functionality. Use when the user asks for project slimming, cleanup, reducing project size, or preparing for delivery after testing.
SKILL.mdUpdated Apr 17, 2026