GitHub 开源项目从零到一完整教程 | Complete GitHub Open Source Guide

GitHub 开源项目完整教程 Complete GitHub Open Source Guide

从注册账户到维护贡献项目的 Step-by-Step 完整指南，涵盖 Git 基础、仓库管理、协作开发与社区生态 A step-by-step complete guide from creating an account to maintaining and contributing to projects, covering Git basics, repository management, collaborative development, and community ecology

注册与配置 GitHub 账户 Register & Configure Your GitHub Account 从零开始创建你的 GitHub 身份Start from scratch and create your GitHub identity

1.1 注册 GitHub 账户1.1 Sign Up for GitHub

访问 github.com，点击右上角 “Sign up” 按钮。按照提示填写邮箱、用户名、密码完成注册。用户名将作为你的唯一标识出现在所有提交和仓库中，建议选择专业、易记的名称。 Visit github.com and click the “Sign up” button in the top-right corner. Follow the prompts to enter your email, username, and password. Your username serves as your unique identifier across all commits and repositories — choose a professional, memorable one.

建议Tip

推荐使用小写字母、数字和连字符（-），避免使用下划线或特殊字符。例如 zhang-san-dev 比 zhang_san_dev_2024 更专业。 Use lowercase letters, numbers, and hyphens (-). Avoid underscores or special characters. For example, john-dev looks more professional than john_dev_2024.

1.2 验证邮箱与启用双重认证（2FA）1.2 Verify Email & Enable 2FA

注册后，GitHub 会向你邮箱发送验证邮件，点击链接完成验证。验证邮箱后，强烈建议立即启用双重认证（2FA）来保护账户安全。 After signing up, GitHub sends a verification email. Click the link to verify. Once verified, it’s strongly recommended to enable Two-Factor Authentication (2FA) immediately to secure your account.

启用 2FA 的步骤： Steps to enable 2FA:

点击右上角头像 → Settings Click your avatar (top-right) → Settings
左侧菜单选择 Account → Password and authentication Select Account in the left sidebar → Password and authentication
点击 “Enable two-factor authentication”，推荐使用认证器应用（如 Google Authenticator、Authy） Click “Enable two-factor authentication” — recommend using an authenticator app (Google Authenticator, Authy, etc.)
扫描二维码并输入验证码完成设置，务必保存好恢复码 Scan the QR code, enter the verification code, and make sure to save your recovery codes

重要Important

恢复码是唯一在丢失认证器后恢复账户的途径，请妥善保存到安全的地方（如密码管理器）。 Recovery codes are your only way back in if you lose your authenticator. Store them securely, e.g., in a password manager.

1.3 完善个人资料1.3 Complete Your Profile

一个完善的个人资料能显著提升你的专业形象。点击头像 → Profile，编辑以下信息： A complete profile significantly boosts your professional image. Click your avatar → Profile and edit the following:

头像与名字Avatar & Name

上传清晰头像，填写真实姓名，提升可信度Upload a clear avatar and add your real name for credibility

Bio 简介Bio

用一两句话描述你的技术栈和兴趣方向Describe your tech stack and interests in one or two sentences

位置与链接Location & Links

填写所在城市，添加个人博客或社交媒体链接Add your city and link your blog or social media profiles

Pinned 仓库Pinned Repos

置顶你最自豪的项目，让访客快速了解你的实力Pin your best projects so visitors can quickly see your work

1.4 设置 SSH 密钥1.4 Set Up SSH Keys

SSH 密钥让你无需每次输入密码即可与 GitHub 通信。首先检查本地是否已有密钥： SSH keys let you communicate with GitHub without entering your password each time. First, check if you already have one:

bash

# 检查是否已有 SSH 密钥 / Check for existing SSH keys
ls ~/.ssh/id_*.pub

# 如果没有，生成新密钥 / If none, generate a new one
ssh-keygen -t ed25519 -C "your_email@example.com"

# 启动 ssh-agent 并添加密钥 / Start ssh-agent and add the key
eval "$(ssh-agent -s)"
ssh-add ~/.ssh/id_ed25519

然后将公钥添加到 GitHub：复制 cat ~/.ssh/id_ed25519.pub 的输出，前往 GitHub → Settings → SSH and GPG keys → New SSH key，粘贴公钥并保存。 Then add the public key to GitHub: copy the output of cat ~/.ssh/id_ed25519.pub, go to GitHub → Settings → SSH and GPG keys → New SSH key, paste it, and save.

验证连接Verify

运行 ssh -T git@github.com，如果看到 “Hi username!” 的回复说明配置成功。 Run ssh -T git@github.com. If you see “Hi username!”, your SSH setup is working.

安装与配置 Git Install & Configure Git 在本地搭建版本控制环境Set up version control on your machine

2.1 安装 Git2.1 Install Git

操作系统OS	安装方式Method
WindowsWindows	从 git-scm.com 下载安装包，按默认选项安装即可Download installer from git-scm.com and install with defaults
macOSmacOS	`brew install git` 或安装 Xcode Command Line Tools：`xcode-select --install`
Linux (Debian/Ubuntu)Linux (Debian/Ubuntu)	`sudo apt install git`
Linux (Fedora)Linux (Fedora)	`sudo dnf install git`

验证安装：Verify installation:

bash

git --version
# 应输出类似: git version 2.45.0
# Should output something like: git version 2.45.0

2.2 全局配置2.2 Global Configuration

安装完成后，必须配置你的用户名和邮箱，这些信息会记录在每次提交中： After installing, configure your name and email — these are recorded in every commit:

bash

# 设置用户名 / Set your name
git config --global user.name "Your Name"

# 设置邮箱（必须与 GitHub 注册邮箱一致）/ Set email (must match GitHub email)
git config --global user.email "your_email@example.com"

# 设置默认分支名为 main / Set default branch to main
git config --global init.defaultBranch main

# 设置默认编辑器（可选）/ Set default editor (optional)
git config --global core.editor "code --wait"

# 查看配置 / View config
git config --list

编辑器选择Editor Choice

Git 提交信息默认使用系统编辑器。你也可以安装 gh CLI 工具（brew install gh 或从 cli.github.com 下载），它提供了更友好的 GitHub 命令行体验。 By default, Git uses your system editor for commit messages. You can also install the gh CLI tool (brew install gh or from cli.github.com) for a friendlier GitHub command-line experience.

Git 核心概念速览 Git Core Concepts Overview 理解版本控制的基本原理Understand the fundamentals of version control

git pull ←

Working Directory工作区

git add

Staging Area暂存区

git commit

Local Repository本地仓库

git push

Remote Repository远程仓库

图 1：Git 四大区域与数据流转Figure 1: Git’s four areas and data flow

3.1 仓库（Repository）3.1 Repository

仓库是项目的”容器”，包含所有文件及其完整的历史记录。每个仓库可以是本地目录（通过 git init 创建）或远程仓库（托管在 GitHub 上）。 A repository is the “container” for your project, containing all files and their full history. Each repo can be local (created with git init) or remote (hosted on GitHub).

3.2 提交（Commit）3.2 Commit

提交是 Git 的核心单元，代表项目在某一时刻的快照。每次提交都有一个唯一的 SHA-1 哈希值。好的提交信息应清晰描述本次修改的内容。 A commit is Git’s core unit, representing a snapshot of your project at a point in time. Each commit has a unique SHA-1 hash. Good commit messages clearly describe what was changed.

3.3 分支（Branch）3.3 Branch

分支允许你在不影响主线的情况下开发新功能或修复 Bug。main（或 master）是默认的主分支。创建分支：git branch feature-name；切换分支：git checkout feature-name。 Branches let you develop features or fix bugs without affecting the main code. main (or master) is the default branch. Create: git branch feature-name; Switch: git checkout feature-name.

3.4 常用命令速查3.4 Command Cheat Sheet

命令Command	说明Description
`git init`	在当前目录初始化新仓库Initialize a new repo in the current directory
`git clone <url>`	克隆远程仓库到本地Clone a remote repo locally
`git status`	查看当前文件状态Check current file status
`git add .`	暂存所有更改Stage all changes
`git commit -m "msg"`	提交暂存的更改Commit staged changes
`git push origin main`	推送到远程 main 分支Push to remote main branch
`git pull`	拉取并合并远程更改Pull and merge remote changes
`git log --oneline`	查看简洁的提交历史View compact commit history
`git branch -a`	列出所有分支List all branches
`git merge <branch>`	合并指定分支Merge specified branch
`git stash`	暂存未提交的更改Temporarily shelve uncommitted changes
`git remote -v`	查看远程仓库地址View remote repository URLs

创建第一个仓库 Create Your First Repository 在 GitHub 上建立你的项目Establish your project on GitHub

4.1 通过 GitHub 网页创建4.1 Create via GitHub Web UI

点击 GitHub 首页右上角的 “+” → “New repository” Click the “+” icon (top-right) → “New repository”
填写仓库名称（如 my-first-project），选择 Public 或 Private Enter a repository name (e.g., my-first-project), choose Public or Private
勾选 “Add a README file”、“Add .gitignore”、“Choose a license” Check “Add a README file”, “Add .gitignore”, “Choose a license”
点击 “Create repository” 完成创建 Click “Create repository” to finish

4.2 通过命令行创建并推送4.2 Create via CLI & Push

bash

# 创建项目目录 / Create project directory
mkdir my-first-project
cd my-first-project

# 初始化 Git 仓库 / Initialize Git repo
git init

# 创建并写入 README / Create and write README
echo "# My First Project" > README.md

# 暂存并提交 / Stage and commit
git add .
git commit -m "Initial commit: add README"

# 关联远程仓库（替换为你的仓库地址）/ Link remote repo (replace with your repo URL)
git remote add origin git@github.com:your-username/my-first-project.git

# 推送到 GitHub / Push to GitHub
git branch -M main
git push -u origin main

4.3 克隆已有仓库4.3 Clone an Existing Repository

如果要下载别人的项目到本地： To download someone else’s project locally:

bash

# 使用 SSH（推荐）/ Using SSH (recommended)
git clone git@github.com:username/repo.git

# 或使用 HTTPS / Or using HTTPS
git clone https://github.com/username/repo.git

SSH vs HTTPSSSH vs HTTPS

SSH：配置一次密钥后无需输入密码，更安全便捷。HTTPS：无需密钥配置，但每次推送需要输入用户名和 Token。 SSH: One-time key setup, no password needed after — more secure and convenient. HTTPS: No key config, but requires username + token on every push.

编写 README 与项目文档 Write README & Project Documentation 让世界了解你的项目Let the world understand your project

5.1 README.md 的结构5.1 README.md Structure

README 是项目的”门面”，是访客看到的第一个文件。一个优秀的 README 应包含以下部分： The README is the “face” of your project — the first file visitors see. A great README should include:

markdown

# 项目名称 / Project Name

简短描述项目功能 / A short description of what this project does.

## 功能特性 / Features
- 功能 1 / Feature 1
- 功能 2 / Feature 2

## 安装 / Installation
```bash
npm install my-project
```

## 快速开始 / Quick Start
```bash
# 基本使用示例 / Basic usage example
my-project --init
```

## 使用文档 / Documentation
详细文档链接 / Link to detailed docs

## 贡献指南 / Contributing
欢迎贡献！请阅读 [CONTRIBUTING.md](CONTRIBUTING.md)
Contributions welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md)

## 许可证 / License
[MIT](LICENSE)

5.2 其他重要文件5.2 Other Important Files

文件File	用途Purpose
`.gitignore`	指定哪些文件不需要被 Git 跟踪（如 `node_modules/`、`.env`）Specifies files Git should ignore (e.g., `node_modules/`, `.env`)
`LICENSE`	定义项目的开源许可证类型（MIT、Apache 2.0、GPL 等）Defines the open-source license type (MIT, Apache 2.0, GPL, etc.)
`CONTRIBUTING.md`	告诉其他开发者如何参与贡献Tells other developers how to contribute
`CHANGELOG.md`	记录每个版本的重要变更Records important changes in each version
`CODE_OF_CONDUCT.md`	定义社区行为准则Defines community code of conduct

.gitignore 模板.gitignore Templates

GitHub 提供了丰富的 .gitignore 模板，创建仓库时可以直接选择对应语言的模板。 GitHub offers a rich collection of .gitignore templates. You can select one when creating a repo.

5.3 选择合适的开源许可证5.3 Choosing an Open Source License

MIT

最宽松的许可证，几乎无限制，允许任何人自由使用、修改、分发。适合大多数项目。Most permissive license with almost no restrictions. Anyone can freely use, modify, and distribute. Ideal for most projects.

Apache 2.0

类似 MIT，但额外提供专利授权保护。适合企业级项目。Similar to MIT but adds patent grant protection. Good for enterprise projects.

GPL 3.0

“传染性”许可证：任何修改后的衍生作品也必须以相同许可证开源。适合希望代码始终开源的项目。“Copyleft” license: derivative works must also be open-sourced under the same license. For projects that want code to remain open.

分支管理与协作工作流 Branching & Collaboration Workflow 高效团队协作的核心模式Core patterns for efficient team collaboration

6.1 Git Flow 工作流6.1 Git Flow Workflow

紧急修复Hotfixhotfix/*

生产环境Productionmain

预发布Pre-releaserelease/*

← merge (Bug)

← merge (Tests)

Prod Bug →

开发主线Developmentdevelop

↕

↓ create branch

新功能New Featuresfeature/*

PR / MR ↑

merge → develop & main

图 2：Git Flow 分支模型Figure 2: Git Flow branching model

6.2 GitHub Flow（简化版）6.2 GitHub Flow (Simplified)

对于大多数项目，GitHub Flow 是更简洁的选择： For most projects, GitHub Flow is the simpler choice:

从 main 创建新的功能分支 Create a feature branch from main
在该分支上进行开发、提交 Develop and commit on that branch
推送分支到 GitHub Push the branch to GitHub
创建 Pull Request，邀请团队审查 Create a Pull Request and invite team review
审查通过后合并到 main After approval, merge into main

6.3 分支操作命令6.3 Branch Commands

bash

# 查看所有分支 / List all branches
git branch -a

# 创建并切换到新分支 / Create and switch to new branch
git checkout -b feature/login-page
# 或使用新语法（推荐）/ Or using new syntax (recommended)
git switch -c feature/login-page

# 推送新分支到远程 / Push new branch to remote
git push -u origin feature/login-page

# 切换回 main 分支 / Switch back to main
git checkout main

# 删除已合并的分支 / Delete merged branch
git branch -d feature/login-page

# 同步远程分支信息 / Sync remote branch info
git fetch --all

分支命名规范Branch Naming

建议使用语义化前缀：feature/（新功能）、bugfix/（修复）、docs/（文档）、refactor/（重构）。例如 feature/user-dashboard。 Use semantic prefixes: feature/ (new features), bugfix/ (fixes), docs/ (documentation), refactor/ (refactoring). E.g., feature/user-dashboard.

Pull Request 与代码审查 Pull Requests & Code Review 代码质量与协作的核心机制Core mechanism for code quality and collaboration

7.1 创建 Pull Request (PR)7.1 Creating a Pull Request (PR)

Pull Request（PR）是 GitHub 上最核心的协作机制。当你完成功能开发后，通过 PR 请求将你的代码合并到目标分支。 A Pull Request (PR) is GitHub’s core collaboration mechanism. After completing feature development, use a PR to request merging your code into the target branch.

推送你的功能分支到 GitHub Push your feature branch to GitHub
访问仓库页面，点击 “Compare & pull request” 按钮（或手动创建） Visit the repo page, click “Compare & pull request” (or create manually)
填写 PR 标题和描述，清楚说明修改内容 Fill in the PR title and description, clearly explaining the changes
选择目标分支（通常是 main），指定审查者 Select the target branch (usually main), assign reviewers
提交 PR，等待审查和 CI 检查通过 Submit the PR, wait for review and CI checks to pass

7.2 PR 描述模板7.2 PR Description Template

markdown

## 变更描述 / Description
简要说明本次 PR 的目的和改动 / Briefly explain the purpose and changes

## 变更类型 / Type of Change
- [ ] 新功能 / New feature
- [ ] Bug 修复 / Bug fix
- [ ] 重构 / Refactoring
- [ ] 文档更新 / Documentation update

## 测试 / Testing
- [ ] 已添加单元测试 / Unit tests added
- [ ] 所有现有测试通过 / All existing tests pass

## 截图（如适用）/ Screenshots (if applicable)
在此添加截图 / Add screenshots here

## 关联 Issue / Related Issues
Closes #123

7.3 代码审查最佳实践7.3 Code Review Best Practices

提交者Submitter

保持 PR 小而聚焦，一个 PR 只做一件事。添加清晰的描述和相关 Issue 链接。Keep PRs small and focused — one PR, one purpose. Add clear descriptions and link related issues.

审查者Reviewer

在 24-48 小时内完成审查。用建设性的语气提出建议，区分”必须修改”和”建议优化”。Review within 24-48 hours. Use constructive tone, distinguish “must fix” from “nice to have”.

响应反馈Responding

礼貌回复每条评论，对修改进行追加提交而非修改已有提交（保持历史清晰）。Reply to every comment politely. Make additional commits for fixes rather than amending existing ones.

7.4 解决合并冲突7.4 Resolving Merge Conflicts

当两个分支修改了同一文件的同一部分时，Git 无法自动合并，需要手动解决冲突： When two branches modify the same part of a file, Git can’t auto-merge — you must resolve manually:

bash

# 1. 更新目标分支 / Update target branch
git checkout main
git pull origin main

# 2. 切换回功能分支并合并 main / Switch to feature branch and merge main
git checkout feature/my-feature
git merge main

# 3. 手动编辑冲突文件 / Manually edit conflicted files
# Git 会在冲突处标记：
# <<<<<<< HEAD
# (main 分支的内容)
# =======
# (feature 分支的内容)
# >>>>>>> feature/my-feature

# 4. 解决冲突后提交 / Commit after resolving
git add .
git commit -m "resolve merge conflicts"

参与开源项目贡献 Contributing to Open Source Projects 融入全球开发者社区Join the global developer community

8.1 找到适合的项目8.1 Finding the Right Project

作为新手，选择标记了 “good first issue” 或 “help wanted” 的项目来起步。GitHub Explore 页面也能帮你发现热门项目。 As a beginner, start with projects labeled “good first issue” or “help wanted”. GitHub Explore can also help you discover trending projects.

搜索技巧Search Tips

在 GitHub 搜索栏输入：label:"good first issue" language:python 可以找到标记为新手友好的 Python 项目。 In GitHub search, type: label:"good first issue" language:python to find beginner-friendly Python projects.

8.2 Fork & Pull 工作流8.2 Fork & Pull Workflow

Upstream原项目Original

⟶ Fork

Your Fork你的副本Your Copy

Local本地仓库Local Repo

← git clone

Develop开发修改Development

↑ branch

push → Fork

Pull Request → Upstream

图 3：Fork & Pull 工作流Figure 3: Fork & Pull workflow

具体步骤：Detailed steps:

bash

# 1. Fork 项目（在 GitHub 网页上点击 Fork 按钮）
# 2. 克隆你的 Fork 到本地 / Clone your fork locally
git clone git@github.com:your-username/project.git
cd project

# 3. 添加上游仓库（原项目）作为远程源 / Add upstream remote
git remote add upstream git@github.com:original-owner/project.git

# 4. 创建功能分支 / Create a feature branch
git checkout -b fix/issue-123

# 5. 进行修改、提交 / Make changes, commit
git add .
git commit -m "fix: resolve issue #123 - description"

# 6. 推送到你的 Fork / Push to your fork
git push -u origin fix/issue-123

# 7. 在 GitHub 网页上创建 Pull Request

# 8. 如果上游有更新，同步到本地 / If upstream updates, sync locally
git fetch upstream
git checkout main
git merge upstream/main

8.3 编写有意义的提交信息8.3 Writing Meaningful Commit Messages

遵循 Conventional Commits 规范，让你的提交历史清晰专业： Follow the Conventional Commits specification for a clear, professional commit history:

前缀Prefix	含义Meaning	示例Example
`feat:`	新功能New feature	`feat: add user login page`
`fix:`	Bug 修复Bug fix	`fix: resolve memory leak in parser`
`docs:`	文档更新Documentation	`docs: update API reference`
`refactor:`	代码重构Refactoring	`refactor: simplify auth module`
`test:`	测试相关Testing	`test: add unit tests for utils`
`chore:`	构建/工具变更Build/tooling	`chore: update dependencies`

8.4 Issue 管理规范8.4 Issue Management

在参与项目前，务必先阅读项目的 CONTRIBUTING.md。报告 Bug 时，请提供： Before contributing, read the project’s CONTRIBUTING.md. When reporting a bug, provide:

清晰的问题描述和复现步骤Clear problem description and reproduction steps
你的环境信息（操作系统、版本号）Your environment info (OS, version numbers)
期望行为 vs 实际行为Expected vs. actual behavior
相关的日志或截图Relevant logs or screenshots
（如果能提供）修复建议(If possible) Suggested fix

发布与版本管理 Release & Version Management 让你的项目触达更多用户Reach more users with your project

9.1 语义化版本（SemVer）9.1 Semantic Versioning (SemVer)

版本号格式：主版本号.次版本号.修订号（如 2.1.3） Version format: MAJOR.MINOR.PATCH (e.g., 2.1.3)

主版本号 ↑MAJOR ↑

包含不兼容的 API 变更时递增Increment for breaking API changes

次版本号 ↑MINOR ↑

添加向下兼容的新功能时递增Increment for backward-compatible new features

修订号 ↑PATCH ↑

修复向下兼容的 Bug 时递增Increment for backward-compatible bug fixes

9.2 创建 GitHub Release9.2 Creating a GitHub Release

在仓库页面点击 “Releases” → “Draft a new release” On the repo page, click “Releases” → “Draft a new release”
选择一个标签（tag），如 v1.0.0（也可以让 GitHub 自动创建新标签） Choose a tag (e.g., v1.0.0) or let GitHub create a new one automatically
填写版本标题和发布说明（变更内容） Fill in the release title and description (what changed)
上传编译好的文件（二进制包、安装程序等） Upload compiled artifacts (binaries, installers, etc.)
点击 “Publish release” Click “Publish release”

9.3 标签（Tags）管理9.3 Tag Management

bash

# 创建带注释的标签 / Create annotated tag
git tag -a v1.0.0 -m "Release v1.0.0: first stable version"

# 推送标签到远程 / Push tag to remote
git push origin v1.0.0

# 推送所有标签 / Push all tags
git push origin --tags

# 查看所有标签 / View all tags
git tag -l

# 删除标签 / Delete a tag
git tag -d v1.0.0
git push origin :refs/tags/v1.0.0

9.4 自动化发布：GitHub Actions9.4 Automated Releases with GitHub Actions

你可以配置 GitHub Actions 实现持续集成/持续部署（CI/CD），例如在每次推送标签时自动构建和发布： You can configure GitHub Actions for CI/CD, e.g., auto-build and publish on tag push:

yaml

# .github/workflows/release.yml
name: Release
on:
  push:
    tags:
      - 'v*'
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm ci
      - run: npm test
      - run: npm run build
      - uses: softprops/action-gh-release@v2
        with:
          files: dist/*

持续维护与社区运营 Ongoing Maintenance & Community Building 让项目健康成长Keep your project healthy and growing

10.1 项目管理工具10.1 Project Management Tools

GitHub 提供了内置的 Projects 面板，支持看板（Kanban）视图来管理任务。结合 Issues、Milestones 和 Labels，你可以高效追踪项目进度。 GitHub provides built-in Projects boards with Kanban views for task management. Combined with Issues, Milestones, and Labels, you can efficiently track progress.

IssuesIssues

Bug 报告和功能请求的追踪工具，支持关联 PR、指定负责人、设置优先级Tracker for bug reports and feature requests — link to PRs, assign people, set priority

LabelsLabels

为 Issue 和 PR 添加标签分类：bug、enhancement、good first issue、help wantedCategorize Issues and PRs: bug, enhancement, good first issue, help wanted

MilestonesMilestones

将相关 Issue 和 PR 组合到里程碑中，追踪版本发布进度Group related Issues and PRs into milestones to track release progress

DiscussionsDiscussions

社区讨论区，适合提问、分享想法、发布公告，区别于 Issue 的任务追踪属性Community forum for Q&A, idea sharing, announcements — separate from task-oriented Issues

10.2 保护主分支10.2 Protecting the Main Branch

前往 Settings → Branches → Add branch protection rule，推荐配置： Go to Settings → Branches → Add branch protection rule. Recommended settings:

要求 PR 审查通过后才能合并（Require PR approval before merging）Require PR approval before merging
要求 CI 状态检查通过（Require status checks to pass）Require status checks to pass
禁止直接推送（Disable direct push to main）Disable direct push to main
要求提交历史线性（Require linear history / squash merge）Require linear history (squash merge)

10.3 维护健康项目清单10.3 Healthy Project Checklist

及时回复 Issue 和 PR（24-72 小时内）Respond to Issues and PRs promptly (within 24-72 hours)
保持依赖库更新（使用 Dependabot 自动检测）Keep dependencies up to date (use Dependabot for auto-detection)
定期更新 README 和文档Regularly update README and documentation
维护 CHANGELOG.md 记录每个版本的变更Maintain CHANGELOG.md to record changes per version
添加 CI 确保每次提交都能通过基本测试Add CI to ensure every commit passes basic tests
使用 CODEOWNERS 文件自动指定代码审查者Use a CODEOWNERS file to auto-assign reviewers
定期清理过时的分支和 IssueRegularly clean up stale branches and Issues
关注社区反馈，积极培养贡献者Listen to community feedback, actively nurture contributors

10.4 常用 GitHub Actions 推荐10.4 Recommended GitHub Actions

用途Purpose	推荐 ActionRecommended Action
CI 测试CI Testing	`actions/checkout` + `actions/setup-node`
代码检查Linting	`github/super-linter`
依赖安全Dependency Security	Dependabot（内置）
自动发布Auto Release	`softprops/action-gh-release`
自动关闭 IssueAuto Close Issues	`actions/stale`
部署到 PagesDeploy to Pages	`actions/deploy-pages`

10.5 社区互动与推广10.5 Community Engagement & Promotion

开源不只是写代码。要让项目被更多人发现和使用： Open source isn’t just about code. To get your project discovered and used:

添加 topics 标签（如 python、cli-tool）增加被搜索到的概率Add topics (e.g., python, cli-tool) to improve discoverability
启用 GitHub Discussions 建立社区讨论空间Enable GitHub Discussions to build a community space
在技术博客或社交媒体分享你的项目和使用教程Share your project and tutorials on tech blogs or social media
Star 和关注你使用的项目，建立 GitHub 社交网络Star and follow projects you use — build your GitHub social network
参与其他项目贡献，在个人资料中展示你的贡献热力图Contribute to other projects — your contribution heatmap builds your profile

✓

总结与进阶路径 Summary & Next Steps

恭喜！你已经掌握了从注册 GitHub 账户到维护开源项目的完整流程。回顾一下你的学习路径： Congratulations! You’ve mastered the complete workflow from creating a GitHub account to maintaining open-source projects. Here’s your learning path:

入门阶段Beginner

注册账户 → 安装 Git → 创建仓库 → 基本 Git 操作Register → Install Git → Create repo → Basic Git commands

进阶阶段Intermediate

分支管理 → PR 审查 → Fork 贡献 → 语义化版本Branching → PR review → Fork & contribute → SemVer

高级阶段Advanced

GitHub Actions CI/CD → 社区运营 → 项目治理 → 开源领导力GitHub Actions CI/CD → Community building → Project governance → Open-source leadership

持续学习资源Keep Learning

– GitHub 官方文档 — 最权威的参考资料
– Pro Git 中文版 — 免费的 Git 进阶书籍
– GitHub 快速入门 — 官方互动教程 – GitHub Docs — The most authoritative reference
– Pro Git — Free advanced Git book
– GitHub Quickstart — Official interactive tutorial