# GitHub 存在 GitHub 是开发人员在尝试之前评估您的项目的地方。该技能涵盖 README 优化、配置文件 README、通过主题和精彩列表的可发现性，以及使用 GitHub 功能进行营销。 ** ** ## 开始之前 1. 读取`.agents/developer-audience-context.md`（如果存在） 2. 审核您当前的 GitHub 状态（个人资料、固定存储库、自述文件） 3.理解：GitHub往往是第一个技术评估——相应优化 ** ** ## 自述文件结构 ### 优秀自述文件的剖析部分|目的|必需的？ ---|---|--- **标志/横幅** |品牌认知度、视觉吸引力|推荐 **徽章** |快速信任信号、状态 |推荐 **单行** |用一句话来形容它的作用 |必填 **英雄榜样** |立即“它看起来像什么？” |强烈推荐 **特点** |为什么使用这个而不是替代品？必填 **快速启动** | 2 分钟内开始跑步 |必填 **安装** |所有安装方法 |必填 **使用** |核心使用示例 |必填 **文档** |完整文档链接 |必填 **贡献** |如何贡献 |推荐 **许可证** |法律明确性|必填 ### 自述文件模板

项目名称

用一个引人注目的句子解释其作用。

文档 • 网站 • 不和谐 --- ## 为什么项目名称？ - **功能 1** — 简要说明 - **功能 2** — 简要说明 - **功能 3** — 简要说明 ## 快速入门 ````bash npm install 项目名称从“项目名称”导入 { thing } ； const 结果 = thing.doSomething(); 控制台.log(结果); ## 安装 ### npm npm install 项目名称 ### 纱线纱线添加项目名称 ### PNPM pnpm 添加项目名称 ## 用法 ### 基本示例 // 带注释的代码示例 ### 高级示例 // 更复杂的例子 ## 文档完整文档可在 [docs.example.com]() 获取 * [入门]() * [API 参考]() * [示例]() ## 贡献我们欢迎贡献！有关详细信息，请参阅 [CONTRIBUTING.md]()。＃＃执照麻省理工学院 © [您的名字]() --- ## 重要的徽章 ### 信任信号徽章 |徽章|它显示了什么 |何时使用 | |--------|--------------|-------------| | CI/构建状态 |代码质量 |永远 | |版本 |最新发布 |始终适用于包裹 | |许可证|法律明确性|永远 | |下载/安装 |领养|当令人印象深刻| |覆盖范围|测试品质 |如果 > 70% | |安全|审核状态 |如果你有的话| ### 社区徽章 |徽章|来源 |目的| |--------|--------|---------| |不和谐成员 |盾牌.io |显示活跃社区 | | GitHub 星星 |盾牌.io |社会证明| |贡献者 |盾牌.io |开源健康 | |最后一次提交 |盾牌.io |项目活动| ### 徽章服务 |服务 |网址 |最适合 | |---------|-----|----------| | Shields.io |盾牌.io |大多数徽章 | |巴德根 | badgen.net |快速、最小化 | | GitHub 徽章 |本地 |行动、问题 | ### 徽章示例 ``降价 ![CI](https://github.com/org/repo/workflows/CI/badge.svg) [![npm](https://img.shields.io/npm/v/package-name.svg)](https://www.npmjs.com/package/package-name) [![下载](https://img.shields.io/npm/dm/package-name.svg)](https://www.npmjs.com/package/package-name) [![许可证](https://img.shields.io/badge/license-MIT-blue.svg)](许可证) [![Discord](https://img.shields.io/discord/SERVER_ID?color=7289da&logo=discord&logoColor=white)](https://discord.gg/invite) [![GitHub 星星](https://img.shields.io/github/stars/org/repo?style=social)](https://github.com/org/repo) ** ** ## 配置文件自述文件 ### 设置配置文件自述文件 1. 使用您的用户名创建一个存储库（例如`github.com/yourname/yourname`） 2.添加`README.md`文件 3. 这会显示在您的个人资料页面上 ### 配置文件自述文件结构 # 嗨，我是[名字]👋 【一句话说明你所做的事情】 ## 我正在做什么 - 🔭 建设[项目] — [简要描述] - 🌱学习【技术】 - 💬 向我询问[专业领域] ## 项目 |项目|描述 |明星| |--------|-------------|--------| | [项目1]（链接）|简要说明| ！[星星]（徽章）| | [项目2]（链接）|简要说明| ！[星星]（徽章）| ## 最近的博客文章 ## 连接 [![Twitter](https://img.shields.io/badge/-Twitter-1DA1F2?style=flat&logo=twitter&logoColor=white)](https://twitter.com/handle) [![LinkedIn](https://img.shields.io/badge/-LinkedIn-0077B5?style=flat&logo=linkedin&logoColor=white)](https://linkedin.com/in/handle) ## GitHub 统计 ![您的 GitHub 统计信息](https://github-readme-stats.vercel.app/api?username=yourusername&show_icons=true) ### 配置文件自述文件最佳实践做|不要 ---|--- 保持可扫描性 |写段落展示您最好的项目 |列出所有内容包括目前的工作 |让它变得陈旧添加联系方式 |让联系你变得困难彰显个性|通用 ** ** ## 可发现性 ### GitHub 主题主题是人们如何查找存储库。优化搜索。话题策略|示例 ---|--- 技术 | `javascript`、`rust`、`python` 框架| `react`、`nextjs`、`django` 使用案例 | `cli`、`api`、`测试` 类别 | `开发人员工具`、`devops` 问题 | “身份验证”、“缓存” **添加主题** ：存储库设置 → 主题（最多 20 个） ### 搜索优化 GitHub 搜索考虑： 1. **存储库名称** — 包含主关键字 2. **描述** — 350 个字符，关键字丰富 3. **自述文件内容** — 全文索引 4. **主题**——类别匹配 5. **语言** — 自动检测 ### 很棒的列表进入精彩的名单会增加流量和可信度。步骤|行动 ---|--- 1 |查找相关的很棒列表（搜索“很棒+[主题]”） 2 |检查清单要求（质量、活动、文档） 3 |确保您的项目符合标准 4 |按照列表指南提交 PR 5 |要有耐心——管理需要时间 **流行的开发工具很棒的列表**： * `很棒的 cli 应用程序` * `很棒的自托管` * `真棒-nodejs` * `真棒蟒蛇` * `太棒了` * `很棒的铁锈` * `真棒-devops` ** ** ## 用于营销的 GitHub Actions ### 自动自述文件更新 # .github/workflows/readme-update.yml 名称：更新自述文件于：时间表： - cron: '0 0 * * *' # 每日工作流程_调度：职位：更新：运行：ubuntu-latest 步骤： - 使用：actions/checkout@v4 # 示例：更新博客文章列表 - 使用：gautamkrishnar/blog-post-workflow@master 与： feed_list：“https://yourblog.com/feed” - 名称：提交更改运行： | git config --local user.email“action@github.com” git config --local user.name“GitHub 操作” git添加-A git diff --quiet && git diff --staged --quiet || git commit -m“更新自述文件” git 推送 ### 指标和统计数据 # 自动更新 GitHub 统计图像 - 使用：lowlighter/metrics@latest 与：令牌：${{secrets.METRICS_TOKEN}} 文件名：github-metrics.svg ### 发布公告 # 关于新版本的推文名称：发布公告于：发布：类型：[已发布] 职位：宣布：运行：ubuntu-latest 步骤： - 名称：推文使用：ethomson/send-tweet-action@v1 与：状态：“🚀 ${{ github.repository }} ${{ github.event.release.tag_name }} 已发布！${{ github.event.release.html_url }}” 消费者密钥：${{secrets.TWITTER_CONSUMER_KEY }} # ...其他秘密 ** ** ## GitHub 赞助商 ### 设置赞助商 1. 加入 GitHub 赞助商 (github.com/sponsors) 2. 创建引人注目的层级描述 3. 在repos中设置funding.yml **funding.yml 示例**： github: [你的用户名] patreon: 你的patreon open_collective：你的项目 ko_fi：你的科菲自定义：[“https://buymeacoffee.com/you”] ### 有效的赞助商级别等级 |价格|优惠 ---|---|--- **支持者** | $5/月 |谢谢+自述文件中的名字 **支持者** | $15/月 | README + Discord 角色中的徽标 **赞助** | $50/月 |优先支持+功能投票 **企业** | $200+/月 |专注支持+咨询 ** ** ## 平台特定的注意事项 ### 要做的事 1. **做**优化你的自述文件以获得第一印象 2. **一定**使用徽章来快速发出信任信号 3. **一定**添加相关主题（最多 20 个） 4. **务必**保持您的个人资料自述文件最新 5. **务必** 及时回复问题和 PR 6. **一定**固定你最好的存储库 7. **务必**包含明确的安装说明 8. **一定**提交到相关的很棒的列表 ### 不该做的事 1. **不要**忽视自述文件——它是你的登陆页面 2. **不要**使用太多徽章（杂乱） 3. **不要**让问题堆积如山而得不到解决 4. **不要**忘记许可证文件 5. **不要**使用低质量或损坏的图像 6. **不要**写出没有结构的文字墙 7. **不要**忽视贡献指南 ** ** ## 衡量成功 ### 要跟踪的 GitHub 指标公制|它告诉你什么 |目标 ---|---|--- 明星|兴趣/书签|随着时间的推移而增长叉子|积极使用|质量 > 数量克隆|人们正在尝试|预装利息交通 |个人资料/回购视图 |意识推荐人 |流量从哪里来 |渠道有效性贡献者 |社区卫生 |可持续项目 ### 流量洞察访问方式：存储库→见解→流量 * 浏览量和独特访客数 * 热门内容（哪些文件） * 参考网站 * 克隆活动 ** ** ## 工具工具|使用案例 ---|--- **[Octolens]()** |监控 GitHub 以获取有关您的项目、竞争对手和相关讨论的提及。当人们谈论您解决的问题时收到提醒。 **Shields.io** |生成状态徽章 **GitHub 自述文件统计** |个人资料的动态统计 **碳** |漂亮的代码截图 **自述文件** |自述文件生成器 **指标** |高级个人资料统计 ** ** ## 自述文件审核清单 * 清晰、关键字丰富的名称和描述 * 徽章显示 CI 状态、版本、许可证 * 一行文字解释了它的作用 * 快速启动让用户在 2 分钟内运行 * 代码示例可复制粘贴 * 所有链接均有效且均为 HTTPS * 图片有替代文字 * 移动设备可读的格式 * 存在许可证文件 * 存在贡献指南 * 设定主题（最多20个） * 上传社交预览图片 ** ** ## 相关技能 * `developer-audience-context` — 了解谁评估您的存储库 * `hacker-news-strategy` — HN 用户在投票前检查 GitHub * `reddit-engagement` — Reddit 用户通过 GitHub 进行评估 * `dev-to-hashnode` — 从 README 到内容的链接

Github 存在

包含技能