Github Presence

GitHub 影响力

何时使用

当用户希望优化他们的 GitHub 个人资料、README 或项目可发现性时使用此技能。触发短语包括"GitHub README"、"README 优化"、"GitHub 个人资料"、"GitHub stars"、"GitHub 可发现性"、"awesome 列表"或"GitHub 营销"。

GitHub 是开发者在试用你的项目之前评估它的地方。本技能涵盖 README 优化、个人资料 README、通过 Topics 和 awesome 列表提升可发现性，以及利用 GitHub 功能进行营销。

开始之前

1. 若存在则阅读 .agents/developer-audience-context.md
2. 审计你当前的 GitHub 影响力（个人资料、置顶仓库、README）
3. 理解：GitHub 通常是第一次技术评估——请相应优化

README 结构

优秀 README 的结构

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>

  <!-- Badges -->
  <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);

Installation

npm

npm install project-name

yarn

yarn add project-name

pnpm

pnpm add project-name

Usage

Basic Example

// Code example with comments

Advanced Example

// More complex example

Documentation

Full documentation available at docs.example.com

• Getting Started
• API Reference
• Examples

Contributing

We welcome contributions! Please see CONTRIBUTING.md for details.

License

MIT © Your Name

---

## 真正重要的 Badges

### 信任信号类 Badges

| Badge | 含义 | 使用时机 |
|-------|--------------|-------------|
| CI/Build status | 代码质量 | 始终 |
| Version | 最新发布版本 | 包类项目始终 |
| License | 法律说明 | 始终 |
| Downloads/installs | 采用度 | 数据亮眼时 |
| Coverage | 测试质量 | 覆盖率 > 70% 时 |
| Security | 审计状态 | 有安全审计时 |

### 社区类 Badges

| Badge | 来源 | 用途 |
|-------|--------|---------|
| Discord members | shields.io | 展示活跃社区 |
| GitHub stars | shields.io | 社会认同 |
| Contributors | shields.io | 开源健康度 |
| Last commit | shields.io | 项目活跃度 |

### Badge 服务

| 服务 | URL | 最适合 |
|---------|-----|----------|
| Shields.io | shields.io | 大多数 badges |
| Badgen | badgen.net | 快速、极简 |
| GitHub badges | Native | Actions、issues |

### Badge 示例

```markdown
<!-- Build status -->
![CI](https://github.com/org/repo/workflows/CI/badge.svg)

<!-- npm version -->
[![npm](https://img.shields.io/npm/v/package-name.svg)](https://www.npmjs.com/package/package-name)

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

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

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

<!-- Stars -->
[![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](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/link) | Brief description | ![Stars](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/badge) |
| [Project 2](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/link) | Brief description | ![Stars](https://github.com/jonathimer/devmarketing-skills/tree/main/skills/github-presence/badge) |

## Recent Blog Posts

<!-- BLOG-POST-LIST:START -->
<!-- Automated with GitHub Actions -->
<!-- BLOG-POST-LIST:END -->

## 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 Topics

Topics 是别人找到你的仓库的方式。针对搜索进行优化。

添加 topics：仓库设置 → Topics（最多 20 个）

搜索优化

GitHub 搜索会考虑以下因素：

1. 仓库名称 — 包含主要关键词
2. 描述 — 350 字符，富含关键词
3. README 内容 — 全文被索引
4. Topics — 类目匹配
5. 语言 — 自动检测

Awesome 列表

进入 awesome 列表会带来流量和信誉。

面向开发者工具的热门 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 "action@github.com"
          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"]

真正有效的赞助档位

平台特定的是与非

应该做

1. 做优化 README，给用户留下良好第一印象
2. 做使用 badges 提供快速信任信号
3. 做添加相关 topics（最多 20 个）
4. 做保持个人资料 README 与时俱进
5. 做及时响应 issues 和 PR
6. 做置顶你最好的仓库
7. 做提供清晰的安装说明
8. 做向相关的 awesome 列表提交

不要做

1. 不要忽视 README——它是你的落地页
2. 不要使用过多 badges（显得杂乱）
3. 不要让 issues 堆积不回复
4. 不要忘记 license 文件
5. 不要使用低质量或失效的图片
6. 不要写没有结构的大段文字
7. 不要忽视贡献指南

衡量成功

需要跟踪的 GitHub 指标

流量洞察

访问方式：仓库 → Insights → Traffic

• 浏览量与独立访客数
• 热门内容（哪些文件）
• 引荐站点
• Clone 活动

工具

README 审计清单

• 名称和描述清晰、富含关键词
• Badges 展示 CI 状态、版本、License
• 一句话说明它是干什么的
• 快速入门让用户在 2 分钟内跑起来
• 代码示例可直接复制粘贴
• 所有链接有效且为 HTTPS
• 图片带有 alt 文本
• 在移动端可读
• 有 License 文件
• 有贡献指南
• 设置了 Topics（最多 20 个）
• 上传了社交预览图

相关技能

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

局限

• 仅当任务明确匹配其上游来源与本地项目上下文时才使用此技能。
• 在应用任何变更前，请验证命令、生成的代码、依赖、凭据以及外部服务的行为。
• 不要把示例当作环境特定测试、安全审查，或对破坏性/高成本操作的用户授权的替代。