Jest项目实战（4）：将工具库顺利迁移到GitHub的完整指南

开源代码：将工具库迁移到GitHub

随着项目的成熟和完善，将其开源不仅可以获得更多的用户和贡献者，还能促进项目本身的发展。GitHub作为全球最大的开源协作平台，自然成为了大多数开发者的首选。本文将引导您完成将工具库迁移至GitHub的所有步骤，确保过程顺利无阻。

前置条件

在开始之前，请确认您已经掌握了Git的基本操作，并拥有一个GitHub账户。如果您尚未注册，可以访问GitHub官网进行免费注册。

创建GitHub仓库

1. 登录GitHub账号，点击顶部导航栏的【Your repositories】进入仓库列表页面。

2. 点击右上角的【New】按钮，创建一个新的仓库。

3. 填写仓库名称、描述等信息，选择是否公开仓库，然后点击【Create repository】按钮完成创建。
   
   创建好远端仓库仓库之后，可以通过两种方式来推拉代码：

   • HTTPS
   • SSH

生成SSH密钥对

为了安全地推送代码，推荐使用SSH方式连接GitHub。首先，您需要在本地计算机上生成一个SSH密钥对。公钥上传到 github 上面，私钥自己保留在本地。

1. 打开终端或命令提示符，输入以下命令：

   ssh-keygen -t rsa -C "your_email@example.com"
   

2. 按照提示操作，可以在默认位置保存密钥对，也可以指定其他路径。输入密码（可选）以增加安全性。
3. 完成后，您会在指定的目录下找到两个文件：id_rsa（私钥）和id_rsa.pub（公钥）。请勿泄露私钥文件。

添加SSH公钥至GitHub

1. 登录GitHub，点击右上角的头像，选择【Settings】。
2. 在左侧菜单中选择【SSH and GPG keys】。
   
3. 点击【New SSH key】，输入标题（如“Work Laptop”），并将id_rsa.pub文件的内容粘贴到密钥框内。
   
4. 点击【Add SSH key】完成添加。

至此，我们就成功的新生成了一对 SSH 密钥对，并且将公钥上传到了 github 上面，这意味着之后我们在推拉代码的时候可以通过 SSH 的方式来进行代码的推拉。

推送代码

现在，您可以开始将本地代码推送到GitHub了。

1. 首先，确保您的项目还没有被Git管理。如果是新的项目，直接跳到下一步。如果是现有项目，先检查是否已经初始化过Git仓库：

   cd /path/to/your/project
   git status
   

   如果显示“fatal: Not a git repository”，则需要初始化仓库：

   git init
   

   初始化完成后，就会看到在 jstoolpack 根目录下面有一个 .git 目录，说明现在的 jstoolpack 已经成功的被初始化为了一个代码仓库。

2. 创建.gitignore文件，排除不需要上传的文件和目录。例如：

   node_modules
   coverage
   # dist 目录下存放构建代码
   dist
   

3. 将代码添加到暂存区，并提交：

   git add .
   git commit -m "Initial commit"
   

4. 关联远程仓库，并推送代码：

   git remote add origin git@github.com:YourUsername/YourRepoName.git
   git branch -M main
   git push -u origin main
   

   注意事项：在进行远端仓库推送之前，要保证本地的代码仓库的工作区是干净的。

5. 刷新GitHub仓库页面，确认代码已成功上传。

通过上述步骤，您的工具库现在已经成功托管到了GitHub上，开启了它的开源旅程。接下来，您可以邀请更多的开发者加入，共同推动项目的进步和发展。