github入门

🐙 GitHub 使用超详细教程笔记 🚀

🌟 一、什么是 GitHub & 为什么用它？

1. 定义：全球最大的开源代码托管平台和最大的同性交友社区（误）😂。

2. 重要性：
• 🌍 拥有超过 1 亿用户和数百万个开源项目。
• 🏢 顶级科技公司 (如 Google, Meta, 阿里, 英伟达等) 都在此托管其开源项目。
• 🛠️ 无论是开发者还是普通用户，都能找到所需代码和工具 (如 AI 声音克隆、AI 换脸、免费 Office 办公软件、自动化爬虫、企业级数据库、VSCode 等)。

3. 资源特点：
• 🔓 开源 (Open Source)
• 🆓 免费 (Free)
• 🛡️ 安全可靠 (Secure & Reliable)
• 🚫 几乎无广告 (Ad-Free)

4. 本教程主要内容：
• 🤔 认识 GitHub
• 🔍 资源探索 (流行项目)
• 🔎 资源查找 (高级技巧)
• ⚙️ 运行开源项目
• 🤝 参与开源项目

🔑 二、注册与登录

1. 注册流程：
• 访问 github.com。
• 📧 输入邮箱。
• 🔒 设置密码。
• 👤 设置用户名。
• ✅ 通过邮箱接收的验证码进行验证。

2. 网络问题：
• ❗ 如果国内访问 GitHub 遇到网络问题，可以参考视频中提到的另一期教程解决。

🗺️ 三、GitHub 主页 (Dashboard) 布局概览

1. 顶部导航栏 (Top Navigation Bar)：
• 🍔 左上角汉堡菜单 (Dropdown Menu)：
• 🏠 Home (主页)
• 🐛 Issues (问题)
• 🔀 Pull requests (拉取请求)
• 🚀 Projects (项目管理)
• 💬 Discussions (讨论区)
• 🧭 Explore (探索)
• 🛒 Marketplace (应用市场)
• 🔍 搜索栏 (Search Bar)：全局搜索用户、仓库、代码等。
• 🤖 Copilot AI 助手：点击可打开对话框，针对特定仓库或代码提问。
• ➕ 加号按钮 (Create New)：
• 🆕 New repository (新建仓库)
• 📥 Import repository (导入仓库)
• 等等...
• 🐛 Issues 图标：查看与你相关的 Issues。
• 🔀 Pull Request 图标：查看与你相关的 Pull Requests。
• 🔔 铃铛图标 (Notifications)：查看通知消息。
• 🧑‍💻 右上角个人头像 (Profile and more)：
• 👤 Your profile (个人资料)
• 📦 Your repositories (你的仓库)
• 🤖 Your Copilot (你的 Copilot)
• ⭐ Your stars (你收藏的项目)
• 等等...
• ⚙️ Settings (设置)

2. 页面三栏布局：
• ⬅️ 左侧栏 (Left Sidebar)：
• Top repositories：你创建或参与的仓库列表。
• Recent activity：最近活动。
• ↔️ 中间栏 (Main Content Area)：
• Home：关注的开发者动态、仓库更新和公告。
• ➡️ 右侧栏 (Right Sidebar)：
• 上部：GitHub 功能特性更新时间表。
• 下部 (Explore repositories)：基于你的行为推荐的可能感兴趣的开源项目。

🔥 四、资源探索 (流行项目)

1. Explore 标签页：✨ 基于你的兴趣和活动推荐项目。

2. Topics 标签页：🏷️ 按特定主题/技术分类的项目 (如 3d, android)。

3. Trending 标签页：📈 查看当前热门趋势项目。
• 可以按 Repositories (仓库) 或 Developers (开发者) 查看。
• 筛选条件：
• 🗣️ Spoken Language: 按口语筛选 (如中文)。
• 💻 Language: 按编程语言筛选 (如 Python)。
• 📅 Date range: 按时间范围筛选 (Today, This week, This month - 相当于日/周/月榜)。

4. Collections 标签页：📚 由 GitHub 官方或社区精选的项目合集。

5. Events 标签页：🗓️ GitHub 相关的线上线下活动、新闻资讯。

6. GitHub Sponsors 标签页：💰 发现并赞助你喜爱的开源项目和开发者。

7. 第三方网站推荐：
• 🌐 HelloGitHub (hellogithub.com)：定期整理和推荐 GitHub 上的热门、有趣的开源项目（月刊、特刊形式）。

🔎 五、资源查找 (高级搜索)

1. 简单搜索：直接在顶部搜索栏输入关键词，如 "AI声音克隆"、"PDF翻译"。

2. 结果排序：搜索结果页面右上角可选择排序方式，如 Best match (最佳匹配)、Most stars (最多 Star)。

3. 高级搜索语法 (在搜索框中输入)：
• in:name <keyword>：在项目名称中搜索。
• in:description <keyword>：在项目描述中搜索。
• in:readme <keyword>：在 README 文件中搜索。
• stars:><number>：Star 数大于指定数量 (如 stars:>1000)。
• forks:><number>：Fork 数大于指定数量。
• language:<language_name>：指定编程语言 (如 language:Python)。
• pushed:><YYYY-MM-DD>：在指定日期之后有更新/推送。
• 组合使用：例如 in:name PDF in:description PDF 翻译 stars:>1000 pushed:>2025-01-01。

4. 项目内搜索：
• 进入某个项目页面后，再使用项目内的搜索框（或按键盘 t 键激活）。
• 搜索框会自动带上 repo:<owner>/<repo_name> 前缀，表示仅在此仓库内搜索。

5. 第三方网站推荐：
• 🌐 OpenAlternative (openalternative.co)：查找付费软件的开源/免费替代品。

⚙️ 六、运行/使用开源项目

1. 查看 README.md：📄 这是了解项目的首要途径，通常包含项目介绍、功能、安装和使用方法。

2. 安装/使用方式：
• 命令行安装 (如 Python 项目)：
• 通常使用 pip install <package_name>。
• 具体命令见项目的 README。
• 示例 (pdf2zh 项目)：
1. pip install pdf2zh (或 pip3 install pdf2zh)
2. pdf2zh <input_document.pdf>
• 下载预编译安装包：
• 在项目主页右侧栏找到 Releases。
• 下载对应操作系统的预编译文件 (如 .exe, .dmg, .AppImage) 直接运行。
• 并非所有项目都提供预编译包。

🤝 七、参与开源项目开发

1. Issues (问题/议题)：🐛
• 目的：反馈 Bug、提出功能建议、讨论问题。
• 操作：
• 先搜索是否已有类似 Issue，避免重复。
• 点击 New issue 创建新议题，提供详细描述、复现步骤、截图等。
• Issue 可以打标签 (Labels)，如 bug, enhancement, documentation。
• Issue 状态：Open (待处理), Closed (已关闭)。

2. Fork (复刻)：🔱
• 点击项目右上角的 Fork 按钮。
• 将原项目完整复制一份到你自己的 GitHub 账户下，你将拥有此副本的完全控制权。

3. 代码修改与提交 (本地)：💻
• git clone <your_forked_repo_url>：将你 Fork 的仓库克隆到本地。
• git switch -c <new_branch_name>：创建并切换到一个新的开发分支 (如 fix-encode)。不要直接在 master 或 main 分支修改！
• 进行代码修改 (如修复 README.md 中的一个错别字)。
• git status：查看修改状态。
• git add . (或 git add <specific_file>)：将修改添加到暂存区。
• git commit -m "修复xxx bug"：提交修改到本地仓库，写清楚提交信息。
• git push -u origin <new_branch_name>：将本地分支的修改推送到你 Fork 的远程仓库。

4. Pull Request (PR / 拉取请求)：📬
• 回到你 Fork 的 GitHub 仓库页面，会看到一个提示，表明你的新分支有新的提交。
• 点击 Compare & pull request 按钮。
• Base repository (基础仓库)：选择原项目。
• Base branch (基础分支)：通常是原项目的 master 或 main 分支。
• Head repository (头部仓库)：你的 Fork 仓库。
• Compare branch (比较分支)：你刚才推送的开发分支 (如 fix-encode)。
• 填写 PR 的标题和详细描述，说明你的修改内容和原因。
• 点击 Create pull request。

5. 原项目作者的操作：👨‍🔬
• 作者会收到 PR 通知。
• 可以 Review (审查) 代码，进行评论、讨论。
• 如果代码符合要求，作者会 Merge pull request (合并拉取请求)，你的贡献就正式进入原项目了！🎉

6. Sync fork (同步复刻)：🔄
• 在你 Fork 的仓库页面，如果原项目有更新，会出现 Sync fork 按钮。
• 点击 Update branch，可以将原项目的最新更改同步到你 Fork 的仓库的 master/main 分支。
• 本地操作：也可以通过 git remote add upstream <original_repo_url> 添加原项目为上游远程仓库，然后 git fetch upstream 和 git merge upstream/master 来同步。

📜 八、开源协议 (License)

1. 重要性：使用任何开源项目前，务必查看其 LICENSE 文件，了解其授权范围和限制。

2. 不理解怎么办？
• 可以将协议内容复制给 AI 助手 (如 GitHub Copilot, ChatGPT) 提问。
• 例如：“请用中文解释一下 AGPLv3 开源协议。我能否用声明了该协议的项目来部署自己的商业服务？如果可以，有什么限制要求？”

3. 常见协议：MIT, Apache License 2.0, GNU General Public License (GPL), GNU Affero General Public License (AGPLv3) 等。每种协议的开放程度和要求都不同。