mcpField
G
github-presence

github-presence

github.com/jonathimer营销与增长87104 次安装34 周前更新
代码仓库

关于 github-presence

面向开发者项目维护者的 GitHub 展示优化技能,聚焦 README、个人资料和仓库可发现性。还介绍如何利用 GitHub 功能、指标与工具改善项目曝光。

主要功能

  1. 01规划 README 内容结构
  2. 02设置个人资料 README
  3. 03通过 Topics 和列表提升可发现性
  4. 04使用 GitHub Actions 自动更新
  5. 05跟踪仓库流量与项目指标

适用场景

  1. 01改善仓库的初次评估体验
  2. 02让目标用户更容易搜索到项目
  3. 03整理开发者个人资料页面
  4. 04检查 README 与仓库配置

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/jonathimer/devmarketing-skills --skill github-presence

安装后在 Claude Code 中输入/github-presence确认已加载。

附带文件README.md

详细介绍

GitHub 曝光度

开发者在尝试项目之前,会先通过 GitHub 评估项目。本技能涵盖 README 优化、个人资料 README、通过主题和 awesome 列表提升可发现性,以及利用 GitHub 功能进行推广。


开始之前

  1. 如果 .agents/developer-audience-context.md 存在,请先阅读
  2. 审查你当前的 GitHub 曝光度(个人资料、置顶仓库、README)
  3. 了解:GitHub 往往是技术评估的第一站,请据此进行优化

README 结构

优秀 README 的组成部分
部分用途必需?
Logo/横幅品牌识别度、视觉吸引力建议
徽章快速传递信任信号和状态建议
一句话介绍用一句话说明项目的功能必需
主打示例立即展示“它是什么样的?”强烈建议
功能特性说明为何选择它而非其他方案必需
快速开始在 < 2 分钟内运行起来必需
安装所有安装方式必需
用法核心用法示例必需
文档完整文档链接必需
贡献如何参与贡献建议
许可证明确法律信息必需
README 模板
<div align="center">
  <img src="logo.svg" alt="Project Name" width="200">
  <h1>Project Name</h1>
  <p><strong>One compelling sentence explaining what this does.</strong></p>

  
  <a href="https://github.com/org/repo/actions"><img src="https://github.com/org/repo/workflows/CI/badge.svg" alt="CI"></a>
  <a href="https://www.npmjs.com/package/name"><img src="https://img.shields.io/npm/v/name.svg" alt="npm version"></a>
  <a href="https://github.com/org/repo/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
  <a href="https://discord.gg/invite"><img src="https://img.shields.io/discord/123456789" alt="Discord"></a>

  <br>
  <br>

  <a href="https://docs.example.com">Documentation</a> •
  <a href="https://example.com">Website</a> •
  <a href="https://discord.gg/invite">Discord</a>
</div>

---

## Why Project Name?

- **Feature 1** — Brief explanation
- **Feature 2** — Brief explanation
- **Feature 3** — Brief explanation

## Quick Start

```bash
npm install project-name
import { thing } from 'project-name';

const result = thing.doSomething();
console.log(result);

安装

npm
npm install project-name
yarn
yarn add project-name
pnpm
pnpm add project-name

用法

基本示例
// Code example with comments
高级示例
// More complex example

文档

完整文档请访问 docs.example.com

贡献

欢迎贡献!详情请参阅 CONTRIBUTING.md。

许可证

MIT © Your Name


---

## Badges That Matter

### Trust Signal Badges

| Badge | What it shows | When to use |
|-------|--------------|-------------|
| CI/Build status | Code quality | Always |
| Version | Latest release | Always for packages |
| License | Legal clarity | Always |
| Downloads/installs | Adoption | When impressive |
| Coverage | Test quality | If > 70% |
| Security | Audit status | If you have it |

### Community Badges

| Badge | Source | Purpose |
|-------|--------|---------|
| Discord members | shields.io | Show active community |
| GitHub stars | shields.io | Social proof |
| Contributors | shields.io | Open source health |
| Last commit | shields.io | Project activity |

### Badge Services

| Service | URL | Best for |
|---------|-----|----------|
| Shields.io | shields.io | Most badges |
| Badgen | badgen.net | Fast, minimal |
| GitHub badges | Native | Actions, issues |

### Badge Examples

```markdown

![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)


[![Downloads](https://img.shields.io/npm/dm/package-name.svg)](https://www.npmjs.com/package/package-name)


[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)


[![Discord](https://img.shields.io/discord/SERVER_ID?color=7289da&logo=discord&logoColor=white)](https://discord.gg/invite)


[![GitHub stars](https://img.shields.io/github/stars/org/repo?style=social)](https://github.com/org/repo)

个人资料 README

设置个人资料 README
  1. 创建一个以你的用户名命名的仓库(例如,github.com/yourname/yourname)
  2. 添加一个 README.md 文件
  3. 该文件会显示在你的个人资料页面上
个人资料 README 结构
# Hi, I'm [Name] 👋

[One sentence about what you do]

## What I'm Working On

- 🔭 Building [project] — [brief description]
- 🌱 Learning [technology]
- 💬 Ask me about [expertise areas]

## Projects

| Project | Description | Stars |
|---------|-------------|-------|
| [Project 1](link) | Brief description | ![Stars](badge) |
| [Project 2](link) | Brief description | ![Stars](badge) |

## Recent Blog Posts





## Connect

[![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 Stats

![Your GitHub stats](https://github-readme-stats.vercel.app/api?username=yourusername&show_icons=true)
个人资料 README 最佳实践
建议避免
保持内容便于快速浏览写成长段落
展示你最好的项目列出所有项目
包含当前在做的工作让内容过时
添加联系方式让别人难以联系你
展现个性内容千篇一律

可发现性

GitHub 主题

主题是人们发现仓库的途径。请针对搜索进行优化。

主题策略示例
技术javascript、rust、python
框架react、nextjs、django
用例cli、api、testing
类别developer-tools、devops
问题authentication、caching

添加主题:仓库设置 → 主题(最多 20 个)

搜索优化

GitHub 搜索会考虑:

  1. 仓库名称 — 包含主要关键词
  2. 描述 — 350 个字符,包含丰富的关键词
  3. README 内容 — 会对全文编制索引
  4. 主题 — 类别匹配
  5. 语言 — 自动检测
Awesome 列表

加入 awesome 列表可以带来流量和信誉。

步骤操作
1查找相关的 awesome 列表(搜索“awesome + [topic]”)
2查看列表要求(质量、活跃度、文档)
3确保你的项目符合标准
4按照列表的指南提交 PR
5耐心等待 — 筛选需要时间

适用于开发工具的热门 awesome 列表:

  • awesome-cli-apps
  • awesome-selfhosted
  • awesome-nodejs
  • awesome-python
  • awesome-go
  • awesome-rust
  • awesome-devops

用于推广的 GitHub Actions

自动更新 README
# .github/workflows/readme-update.yml
name: Update README

on:
  schedule:
    - cron: '0 0 * * *'  # Daily
  workflow_dispatch:

jobs:
  update:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      # Example: Update blog post list
      - uses: gautamkrishnar/blog-post-workflow@master
        with:
          feed_list: "https://yourblog.com/feed"

      - name: Commit changes
        run: |
          git config --local user.email "[email protected]"
          git config --local user.name "GitHub Action"
          git add -A
          git diff --quiet && git diff --staged --quiet || git commit -m "Update README"
          git push
指标和统计数据
# Auto-update GitHub stats image
- uses: lowlighter/metrics@latest
  with:
    token: ${{ secrets.METRICS_TOKEN }}
    filename: github-metrics.svg
发布公告
# Tweet on new release
name: Release Announcement
on:
  release:
    types: [published]

jobs:
  announce:
    runs-on: ubuntu-latest
    steps:
      - name: Tweet
        uses: ethomson/send-tweet-action@v1
        with:
          status: "🚀 ${{ github.repository }} ${{ github.event.release.tag_name }} released! ${{ github.event.release.html_url }}"
          consumer-key: ${{ secrets.TWITTER_CONSUMER_KEY }}
          # ... other secrets

GitHub Sponsors

设置 Sponsors
  1. 加入 GitHub Sponsors(github.com/sponsors)
  2. 编写有吸引力的赞助层级说明
  3. 在仓库中设置 funding.yml

funding.yml 示例:

github: [yourusername]
patreon: yourpatreon
open_collective: yourproject
ko_fi: yourkofi
custom: ["https://buymeacoffee.com/you"]
行之有效的赞助档位
档位价格权益
支持者$5/月致谢 + 在 README 中列出姓名
赞助者$15/月在 README 中展示徽标 + Discord 身份组
赞助商$50/月优先支持 + 功能投票
企业$200+/月专属支持 + 咨询

平台专属注意事项

建议
  1. 建议 优化 README,留下良好的第一印象
  2. 建议 使用徽章,快速建立信任
  3. 建议 添加相关主题(最多 20 个)
  4. 建议 保持个人资料 README 内容最新
  5. 建议 及时回复 Issue 和 PR
  6. 建议 置顶你最出色的仓库
  7. 建议 提供清晰的安装说明
  8. 建议 将项目提交到相关的 awesome 列表
不建议
  1. 不建议 忽视 README——它是你的着陆页
  2. 不建议 使用过多徽章(会显得杂乱)
  3. 不建议 放任 Issue 堆积而不回复
  4. 不建议 忘记添加许可证文件
  5. 不建议 使用低质量或失效的图片
  6. 不建议 写大段没有结构的文字
  7. 不建议 忽视贡献指南

衡量成效

要跟踪的 GitHub 指标
指标说明目标
Stars兴趣/收藏情况随时间增长
Forks活跃使用情况质量 > 数量
克隆次数尝试使用项目的人数安装前的兴趣
流量个人资料/仓库浏览量知名度
引荐来源流量来源渠道效果
贡献者社区健康状况项目可持续发展
流量洞察

通过以下路径查看:仓库 → Insights → Traffic

  • 浏览量和独立访客数
  • 热门内容(哪些文件)
  • 引荐网站
  • 克隆活动

工具

工具用途
Octolens监控 GitHub 上对你的项目、竞争对手和相关讨论的提及。当有人谈论你能解决的问题时接收提醒。
Shields.io生成状态徽章
GitHub Readme Stats个人资料动态统计数据
Carbon制作精美的代码截图
readme.soREADME 生成器
Metrics高级个人资料统计数据

README 审核清单

  • 名称和描述清晰且包含丰富的关键词
  • 徽章展示 CI 状态、版本和许可证
  • 用一句话说明项目的作用
  • 快速入门步骤可让用户在 < 2 分钟内开始使用
  • 代码示例可直接复制粘贴
  • 所有链接均有效且使用 HTTPS
  • 图片包含替代文本
  • 格式适合在移动设备上阅读
  • 已添加许可证文件
  • 已提供贡献指南
  • 已设置主题(最多 20 个)
  • 已上传社交预览图片

相关技能

  • developer-audience-context — 了解谁会评估你的仓库
  • hacker-news-strategy — HN 用户在投赞成票前会查看 GitHub
  • reddit-engagement — Reddit 用户会通过 GitHub 评估项目
  • dev-to-hashnode — 在 README 中链接到内容

评论

支持 Markdown