以下是 GitHub 基础用法 的详细指南,涵盖注册、仓库管理、代码提交、协作开发等核心功能:

一、注册与账号设置

  1. 注册账号

    • 访问 GitHub 官网,点击右上角 Sign up,使用邮箱、Google 或 GitHub Desktop 注册。
    • 选择账号类型:个人(免费,支持公开仓库,私有仓库需付费)或组织(团队协作)。
  2. 个人资料设置

    • 点击右上角头像进入 Settings,完善个人信息(头像、简介、网站等)。
    • Email 中验证邮箱,开启 Two-Factor Authentication (2FA) 提升安全性。

二、创建与管理仓库(Repository)

1. 新建仓库
  • 点击右上角 New repository,填写:
    • Repository name:仓库名称(如 my-project)。
    • Description:简要描述(可选)。
    • Visibility:公开(Public,免费)或私有(Private,需付费)。
    • 初始化选项(可选)
      • 勾选 Add a README file:自动生成 README.md(项目说明文件)。
      • 添加 .gitignore:忽略指定文件(如 IDE 缓存、日志),可选语言模板(如 Python、Java)。
      • 添加 License:选择开源协议(如 MIT、Apache),明确项目版权。
2. 仓库基本操作
  • 克隆仓库到本地(将远程仓库复制到电脑):
    git clone https://github.com/你的用户名/仓库名.git  
    
  • 上传本地代码到仓库(首次提交):
    cd 仓库名          # 进入仓库目录  
    git add .         # 添加所有文件到暂存区  
    git commit -m "首次提交"  # 提交到本地仓库,-m 后跟提交说明  
    git push origin main  # 将本地代码推送到远程仓库的 main 分支(旧版为 master)  
    
  • 分支管理(协作必备):
    • 创建并切换分支:git checkout -b new-branch
    • 推送分支到远程:git push origin new-branch
    • 合并分支(在 GitHub 网页端或本地):
      1. 进入仓库 → Pull RequestsNew Pull Request,选择源分支和目标分支(如 new-branchmain)。
      2. 点击 Merge pull request 合并,删除已合并分支(可选)。
3. 文件操作
  • 在线编辑文件:点击文件 → 点击右上角铅笔图标,修改后提交到当前分支或新建分支。
  • 上传文件:在仓库主页点击 Add fileUpload files,拖放文件或选择文件上传,填写提交信息。
  • 删除文件:找到文件 → 点击垃圾桶图标,确认提交。

三、协作开发核心功能

1. Fork(派生)与 Pull Request(PR)
  • Fork 仓库:对他人仓库点击右上角 Fork,将其复制到自己的账号下(用于贡献代码)。
  • 提交 PR(以贡献代码到原仓库为例):
    1. 在自己的 Fork 仓库中修改代码,提交到分支(如 fix-bug)。
    2. 进入原仓库 → Pull RequestsNew pull request,选择自己的分支作为源,原仓库的目标分支(如 main)。
    3. 描述修改内容,点击 Create pull request,等待维护者审核合并。
2. Issue(问题追踪)
  • 创建 Issue:用于反馈 bug、建议功能或讨论需求。
    • 在仓库主页点击 IssuesNew issue,填写标题和描述(支持 Markdown 格式)。
    • 添加标签(Labels,如 bugenhancement)、里程碑(Milestones)、分配负责人。
  • 评论与关闭 Issue:在 Issue 下方评论交流,问题解决后点击 Close issue
3. 项目管理(Projects)
  • 使用 Projects 看板管理任务(如敏捷开发中的待办事项、进行中、已完成):
    1. 进入仓库 → ProjectsNew project,选择模板(如 Basic kanban board)。
    2. 添加卡片(通常关联 Issue 或 PR),拖动卡片到不同列(如 To Do → In Progress → Done)。

四、其他常用功能

1. GitHub Pages(静态网站托管)
  • 免费托管个人博客、项目文档等静态页面(HTML/CSS/JS):
    1. 在仓库 SettingsPages 中,选择分支(如 maingh-pages)和根目录。
    2. 保存后,等待几分钟,访问 https://你的用户名.github.io/仓库名/ 查看站点。
2. Wikis(项目文档)
  • 在仓库侧边栏点击 Wiki,创建文档页面(支持 Markdown),用于编写项目说明、API 文档等。
3. Gist(代码片段分享)
  • 用于分享零散代码或文件,不绑定特定仓库:
    • 访问 Gist 官网,点击 New gist,粘贴代码,设置公开/私有,生成链接。
4. Watch/Star/Follow
  • Watch:关注仓库,接收更新通知。
  • Star:收藏仓库,方便后续查找。
  • Follow:关注其他用户,获取其动态。

五、命令行常用 Git 命令

操作命令说明
查看状态git status查看文件变更状态
撤销暂存区修改git restore -- 文件名取消暂存区的文件修改
回退提交git reset --hard 提交哈希回退到指定提交版本(危险操作)
拉取远程更新git pull origin main获取远程仓库最新代码
重命名分支git branch -m 旧名 新名本地重命名分支
关联远程分支git branch --set-upstream-to=origin/新名 新名建立本地与远程分支的关联

六、最佳实践

  1. 提交信息规范:使用清晰的描述(如 fix: 修复登录按钮颜色错误,参考 Conventional Commits)。
  2. 分支策略:多人协作时,避免直接提交到 main 分支,通过分支开发并提交 PR。
  3. 忽略敏感文件:在 .gitignore 中添加日志、配置文件(如 *.logconfig.json),避免泄露隐私。

通过以上步骤,你可以掌握 GitHub 的基础使用,包括仓库管理、代码协作、问题追踪等。进阶功能(如 Actions 自动化、Packages 包管理)可根据需求进一步学习。

更多推荐