GitHub基础使用

bug君2025/7/17...大约 4 分钟

GitHub基础使用

账号注册与设置

注册账号

访问 GitHub官网
点击"Sign up"按钮
填写用户名、邮箱和密码
完成验证步骤
选择计划（免费或付费）
完成问卷（可跳过）

个人资料设置

点击右上角头像，选择"Settings"
上传头像
填写个人信息（姓名、简介、位置等）
设置个人主页URL
添加社交媒体链接

安全设置

启用双因素认证（2FA）
- 点击"Settings" > "Password and authentication"
- 选择认证方式（应用程序或短信）
- 按照向导完成设置

添加SSH密钥

# 生成SSH密钥
ssh-keygen -t ed25519 -C "your_email@example.com"

# 复制公钥
cat ~/.ssh/id_ed25519.pub

在GitHub中，点击"Settings" > "SSH and GPG keys" > "New SSH key"
粘贴公钥并保存

创建个人访问令牌（Personal Access Token）
- 点击"Settings" > "Developer settings" > "Personal access tokens" > "Generate new token"
- 选择权限范围并生成令牌
- 保存令牌（它只会显示一次）

仓库创建与管理

创建新仓库

点击右上角"+"图标，选择"New repository"
填写仓库名称
添加描述（可选）
选择公开或私有
选择是否初始化仓库（添加README、.gitignore和许可证）
点击"Create repository"

仓库设置

基本设置
- 点击仓库页面的"Settings"选项卡
- 修改仓库名称、描述、可见性等
分支保护
- 点击"Branches"选项
- 添加分支保护规则
- 设置合并前的要求（如代码审查、状态检查等）
协作者管理
- 点击"Collaborators"选项
- 添加协作者并设置权限级别

仓库操作

克隆仓库

# 使用HTTPS克隆
git clone https://github.com/用户名/仓库名.git

# 使用SSH克隆
git clone git@github.com:用户名/仓库名.git

添加远程仓库

# 添加GitHub仓库作为远程仓库
git remote add origin https://github.com/用户名/仓库名.git

# 查看远程仓库
git remote -v

推送到GitHub

# 推送到主分支
git push -u origin main

# 推送到其他分支
git push origin 分支名

从GitHub拉取

# 拉取并合并更改
git pull origin 分支名

# 仅拉取更改，不合并
git fetch origin

删除仓库
- 进入仓库设置页面
- 滚动到底部的"Danger Zone"
- 点击"Delete this repository"
- 确认删除操作

README.md编写规范

README是仓库的门面，一个好的README可以让其他人更容易理解和使用你的项目。

基本结构

# 项目名称

简短的项目描述

## 功能特点

- 特点1
- 特点2
- 特点3

## 安装

```bash
npm install 项目名

使用方法

const package = require('项目名');
package.doSomething();

贡献指南

请阅读 CONTRIBUTING.md 了解如何向本项目贡献代码

许可证

本项目采用 MIT 许可证 - 详情请参阅 LICENSE 文件


### 必备要素

1. **项目标题和描述**：清晰说明项目是什么
2. **安装指南**：如何安装和设置项目
3. **使用示例**：如何使用项目的基本功能
4. **功能列表**：项目的主要功能
5. **依赖项**：项目依赖的其他软件或库
6. **贡献指南**：如何参与项目开发
7. **许可证信息**：项目的开源许可证

### 增强要素

1. **徽章**：显示项目状态、版本、构建状态等
   ```markdown
   ![版本](https://img.shields.io/npm/v/项目名.svg)
   ![构建状态](https://travis-ci.org/用户名/项目名.svg?branch=master)
   ![许可证](https://img.shields.io/github/license/用户名/项目名.svg)

## 目录
1. [安装](#安装)
2. [使用方法](#使用方法)
3. [API参考](#api参考)

屏幕截图或演示：展示项目的外观或功能
```
## 截图
![截图描述](images/screenshot.png)
```

常见问题：解答常见问题

## 常见问题

### 问题1？
回答1

### 问题2？
回答2

编写技巧

使用Markdown格式化：善用标题、列表、代码块等
保持简洁：README应该简明扼要，详细文档可以放在其他文件中
包含示例代码：展示如何使用项目的主要功能
保持更新：随着项目的发展，及时更新README
使用图片和动画：适当使用图片和GIF动画展示项目功能
提供联系方式：如何联系项目维护者

组织与团队

GitHub组织是一种管理多个相关项目和多人协作的方式。

创建组织

点击右上角"+"图标，选择"New organization"
选择计划（免费或付费）
填写组织名称和联系邮箱
邀请成员加入组织

组织设置

基本设置
- 上传组织头像
- 添加组织描述和网站
- 设置组织地址
成员管理
- 添加新成员
- 创建团队
- 设置成员权限
仓库默认设置
- 设置默认仓库权限
- 配置仓库模板

团队管理

创建团队
- 在组织页面点击"Teams"选项卡
- 点击"New team"
- 填写团队名称和描述
- 设置团队可见性
团队权限
- 为团队分配仓库
- 设置团队对仓库的权限级别（读取、写入、管理）
团队协作
- 使用团队讨论功能
- 提及团队（@团队名）
- 团队代码审查分配