已合并
fix: 增加GitCode默认noreply邮箱警告和个人邮箱配置引导 #71
whjnbm创建于 6月16日
fix: 增加GitCode默认noreply邮箱警告和个人邮箱配置引导 #71
已合并
共 1 个文件变更+102-56
| @@ -11,29 +11,31 @@ | |||
| 11 |  | 11 |  |
| 12 | 12 | ||
| 13 | --- | 13 | --- |
| 14 | -根据你的身份，选择对应的操作流程，这是最快完成签署的方法。 | 14 | +根据你的身份，选择对应的操作流程，这是最快完成签署的方法。 |
| 15 | - | 15 | + |
| 16 | -<a id="personal-contributor"></a> | 16 | +> ⚠️ **在签署 CLA 之前，请先配置你的 Git 提交邮箱**，详见下方「🔧 Git 提交邮箱配置」章节。 |
| 17 | -## 🤔 我是个人开发者，为自己做贡献 | 17 | + |
| 18 | - | 18 | +<a id="personal-contributor"></a> |
| 19 | -### [👉 签署个人CLA](https://clasign.osinfra.cn/sign-cla/690ca9ddf91c03dee6082ab1/individual) | 19 | +## 🤔 我是个人开发者，为自己做贡献 |
| 20 | - | 20 | + |
| 21 | - | 21 | +### [👉 签署个人CLA](https://clasign.osinfra.cn/sign-cla/690ca9ddf91c03dee6082ab1/individual) |
| 22 | - | 22 | + |
| 23 | -**这是最快捷的路径，无需等待，立即生效。** | 23 | + |
| 24 | - | 24 | + |
| 25 | -### 操作步骤： | 25 | +**这是最快捷的路径，无需等待，立即生效。** |
| 26 | - | 26 | + |
| 27 | -1. **选择「签署个人CLA」** | 27 | +### 操作步骤： |
| 28 | -2. **输入你的邮箱** | 28 | + |
| 29 | - - ✅ **推荐使用个人邮箱**（例如 Gmail、Outlook、QQ 邮箱等） | 29 | +1. **选择「签署个人CLA」** |
| 30 | - - ⚠️ **关于企业邮箱的重要说明**： | 30 | +2. **输入你的邮箱** |
| 31 | - - 如果你的公司**尚未**签署企业 CLA，你可以使用公司邮箱进行个人签署 | 31 | + - ✅ **推荐使用个人邮箱**（例如 Gmail、Outlook、QQ 邮箱等） |
| 32 | - - 但如果你的公司**后续签署**了企业 CLA，你之前用公司邮箱签署的个人 CLA **将自动失效** | 32 | + - ⚠️ **关于企业邮箱的重要说明**： |
| 33 | - - 为避免后续麻烦，强烈建议直接使用个人邮箱 | 33 | + - 如果你的公司**尚未**签署企业 CLA，你可以使用公司邮箱进行个人签署 |
| 34 | - | 34 | + - 但如果你的公司**后续签署**了企业 CLA，你之前用公司邮箱签署的个人 CLA **将自动失效** |
| 35 | -3. **查收邮件验证码**并回到页面填写、提交 | 35 | + - 为避免后续麻烦，强烈建议直接使用个人邮箱 |
| 36 | -4. **完成！** 系统会立即提示你签署成功 | 36 | + |
| 37 | +3. **查收邮件验证码**并回到页面填写、提交 | ||
| 38 | +4. **完成！** 系统会立即提示你签署成功 | ||
| 37 | 39 | ||
| 38 | ### 邮箱选择建议： | 40 | ### 邮箱选择建议： |
| 39 | 41 | ||
| @@ -43,7 +45,18 @@ | |||
| 43 | | 公司邮箱（公司未签CLA） | ⭐⭐ | 临时可用，但有未来失效风险 | | 45 | | 公司邮箱（公司未签CLA） | ⭐⭐ | 临时可用，但有未来失效风险 | |
| 44 | | 公司邮箱（公司已签CLA） | ❌ 不可用 | 必须走企业员工流程 | | 46 | | 公司邮箱（公司已签CLA） | ❌ 不可用 | 必须走企业员工流程 | |
| 45 | 47 | ||
| 46 | -**最佳实践**：无论公司当前是否签署 CLA，都建议使用个人邮箱进行个人贡献者签署，一劳永逸。 | 48 | +**最佳实践**：无论公司当前是否签署 CLA，都建议使用个人邮箱进行个人贡献者签署，一劳永逸。 |
| 49 | + | ||
| 50 | +### 配置个人提交邮箱 | ||
| 51 | +签署个人 CLA 时使用个人邮箱，提交代码时也必须使用**相同的个人邮箱**。请根据以下指引配置： | ||
| 52 | +1. 在 [GitCode](https://gitcode.com) **设置 → 邮箱管理** 中添加你的个人邮箱并设为提交邮箱 | ||
| 53 | +2. 使用 `git config --global user.email "你的个人邮箱"` 配置本地 Git 邮箱 | ||
| 54 | +3. ⚠️ 以下场景会导致提交代码时自动使用 `****@noreply.gitcode.com` 匿名邮箱，此邮箱无法通过 CLA 验证： | ||
| 55 | + - 未在 GitCode 平台将个人邮箱设为提交邮箱，通过网页端直接编辑文件并提交 PR | ||
| 56 | + - 本地未配置 `git config user.email`，直接执行 `git commit` | ||
| 57 | + - 使用 AI 辅助工具（如 Copilot 等）生成代码并提交时，未指定使用个人邮箱 | ||
| 58 | + | ||
| 59 | +> 更多详细配置步骤，请参阅本文档「🔧 Git 邮箱配置」章节。 | ||
| 47 | 60 | ||
| 48 | ### 重要提示： | 61 | ### 重要提示： |
| 49 | 62 | ||
| @@ -82,7 +95,18 @@ | |||
| 82 | - 请他登录系统，在管理后台**批准你的申请** | 95 | - 请他登录系统，在管理后台**批准你的申请** |
| 83 | - **只有在他审批通过后，你的签署才会正式生效** | 96 | - **只有在他审批通过后，你的签署才会正式生效** |
| 84 | 97 | ||
| 85 | - | 98 | + |
| 99 | + | ||
| 100 | +### 配置企业提交邮箱 | ||
| 101 | +签署企业员工 CLA 时使用公司邮箱，提交代码时也必须使用**相同的公司邮箱**。请根据以下指引配置： | ||
| 102 | +1. 在 [GitCode](https://gitcode.com) **设置 → 邮箱管理** 中添加你的公司邮箱并设为提交邮箱 | ||
| 103 | +2. 使用 `git config user.email "your-name@your-company.com"` 配置本地 Git 邮箱（建议使用 --local 仅对当前仓库生效） | ||
| 104 | +3. ⚠️ 以下场景会导致提交代码时自动使用 `****@noreply.gitcode.com` 匿名邮箱，此邮箱无法通过 CLA 验证： | ||
| 105 | + - 未在 GitCode 平台将公司邮箱设为提交邮箱，通过网页端直接编辑文件并提交 PR | ||
| 106 | + - 本地未配置 `git config user.email`，直接执行 `git commit` | ||
| 107 | + - 使用 AI 辅助工具（如 Copilot 等）生成代码并提交时，未指定使用公司邮箱 | ||
| 108 | + | ||
| 109 | +> 更多详细配置步骤，请参阅本文档「🔧 Git 邮箱配置」章节。 | ||
| 86 | 110 | ||
| 87 | --- | 111 | --- |
| 88 | 112 | ||
| @@ -176,16 +200,28 @@ https://clasign.osinfra.cn/api/v1/individual-signing/690ca9ddf91c03dee6082ab1?em | |||
| 176 | 200 | ||
| 177 | - 机器人通过**提交代码时的 Commit 邮箱**来验证 CLA 状态 | 201 | - 机器人通过**提交代码时的 Commit 邮箱**来验证 CLA 状态 |
| 178 | - 如果 Git 配置的邮箱与签署 CLA 时使用的邮箱不一致，检查会失败 | 202 | - 如果 Git 配置的邮箱与签署 CLA 时使用的邮箱不一致，检查会失败 |
| 179 | -- 错误提示示例：`ascend-cla/no` | 203 | +- 错误提示示例：`ascend-cla/no` |
| 180 | - | 204 | + |
| 181 | -<a id="git-email-configuration"></a> | 205 | +<a id="git-email-configuration"></a> |
| 182 | -## 🔧 Git 邮箱配置 | 206 | +## 🔧 Git 邮箱配置 |
| 183 | - | 207 | + |
| 184 | -### 基本原则 | 208 | +> ⚠️ **以下场景会导致提交代码时自动使用 `****@noreply.gitcode.com` 匿名邮箱，此邮箱无法通过 CLA 验证，会导致 CLA 检查始终失败：** |
| 185 | - | 209 | +> - 未在 GitCode 平台将个人邮箱设为提交邮箱，通过网页端直接编辑文件并提交 PR |
| 186 | -**签署 CLA 时使用什么邮箱，提交代码时也必须使用相同的邮箱** | 210 | +> - 本地未配置 `git config user.email`，直接执行 `git commit` |
| 187 | - | 211 | +> - 使用 AI 辅助工具（如 Copilot 等）生成代码并提交时，未指定使用个人邮箱 |
| 188 | -### 提交前检查与配置 | 212 | + |
| 213 | +### 基本原则 | ||
| 214 | + | ||
| 215 | +**签署 CLA 时使用什么邮箱，提交代码时也必须使用相同的邮箱** | ||
| 216 | + | ||
| 217 | +### GitCode 邮箱设置 | ||
| 218 | + | ||
| 219 | +1. 登录 [GitCode](https://gitcode.com)，进入 **设置 → 邮箱管理** | ||
| 220 | +2. 点击 **添加邮箱**，输入你签署 CLA 时使用的邮箱（如 Gmail、Outlook、QQ 邮箱等） | ||
| 221 | +3. 查收验证邮件并完成验证 | ||
| 222 | +4. 将已验证的邮箱**设为提交邮箱**（取代默认的 `****@noreply.gitcode.com`） | ||
| 223 | + | ||
| 224 | +### 提交前检查与配置 | ||
| 189 | 225 | ||
| 190 | 在提交代码前，建议先检查并正确配置 Git 邮箱： | 226 | 在提交代码前，建议先检查并正确配置 Git 邮箱： |
| 191 | 227 | ||
| @@ -212,13 +248,15 @@ git config --system user.name | |||
| 212 | git config --system user.email | 248 | git config --system user.email |
| 213 | ``` | 249 | ``` |
| 214 | 250 | ||
| 215 | -#### 检查结果说明： | 251 | +#### 检查结果说明： |
| 216 | - | 252 | + |
| 217 | - - 如果命令有输出，显示当前配置的用户名和邮箱 | 253 | + - 如果命令有输出，显示当前配置的用户名和邮箱 |
| 218 | - | 254 | + |
| 219 | - - 如果命令没有输出，表示该级别未设置对应配置 | 255 | + - 如果命令没有输出，表示该级别未设置对应配置 |
| 220 | - | 256 | + |
| 221 | - - Git 会按优先级使用第一个找到的配置 | 257 | + - Git 会按优先级使用第一个找到的配置 |
| 258 | + | ||
| 259 | + - ⚠️ 如果邮箱包含 `@noreply.gitcode.com`，说明使用了 GitCode 默认匿名邮箱，必须修改为签署 CLA 时使用的真实邮箱 | ||
| 222 | 260 | ||
| 223 | #### 配置 Git 邮箱信息 | 261 | #### 配置 Git 邮箱信息 |
| 224 | 262 | ||
| @@ -234,13 +272,12 @@ git config --global user.name "你的姓名" | |||
| 234 | git config --global user.email "签署CLA的邮箱" | 272 | git config --global user.email "签署CLA的邮箱" |
| 235 | ``` | 273 | ``` |
| 236 | 274 | ||
| 237 | -#### 配置建议 | 275 | +#### 配置建议 |
| 238 | - | 276 | + |
| 239 | - - 如果你主要在个人项目贡献，使用 --global 配置 | 277 | + - 如果你主要在个人项目贡献，使用 --global 配置 |
| 240 | - | 278 | + - 如果你在公司项目贡献，建议在项目目录中使用 --local 配置 |
| 241 | - - 如果你在公司项目贡献，建议在项目目录中使用 --local 配置 | 279 | + - 使用 git config --list --show-origin 验证配置是否生效 |
| 242 | - | 280 | + - ⚠️ 确保配置的邮箱与签署 CLA 时使用的邮箱完全一致，且不是 `****@noreply.gitcode.com` 格式（GitCode 平台会自动分配此匿名邮箱，请务必在设置中替换为真实邮箱） |
| 243 | - - 使用 git config --list --show-origin 验证配置是否生效 | ||
| 244 | 281 | ||
| 245 | <a id="faq"></a> | 282 | <a id="faq"></a> |
| 246 | ## ❓ FAQ | 283 | ## ❓ FAQ |
| @@ -279,13 +316,22 @@ git log --pretty=fuller | |||
| 279 | 316 | ||
| 280 | **2. 根据检查结果处理** | 317 | **2. 根据检查结果处理** |
| 281 | 318 | ||
| 282 | -子情况B1：commit邮箱与CLA邮箱不一致 | 319 | +子情况B1：commit邮箱与CLA邮箱不一致 |
| 283 | - | 320 | + |
| 284 | -| 场景 | 选择方案 | 操作步骤 | | 321 | +**常见触发 `****@noreply.gitcode.com` 邮箱的场景：** |
| 285 | -|------|----------|----------| | 322 | + |
| 286 | -| commit邮箱与Gitcode提交邮箱一致 | 使用该邮箱重新签署 | 用commit邮箱重新签署CLA | | 323 | +**以下场景会导致提交代码时自动使用 `****@noreply.gitcode.com` 匿名邮箱，导致 CLA 检查失败：** |
| 287 | -| 希望使用commit邮箱签署 | 调整Gitcode设置 | 在Gitcode设置中添加commit邮箱并设为提交邮箱 | | 324 | + |
| 288 | -| 希望使用Gitcode提交邮箱签署 | 调整本地git配置 | 使用`git config --global user.email "邮箱"`修改配置 | | 325 | +- 未在 GitCode 平台将个人邮箱设为提交邮箱，通过网页端直接编辑文件并提交 PR |
| 326 | +- 本地未配置 `git config user.email`，直接执行 `git commit` | ||
| 327 | +- 使用 AI 辅助工具（如 Copilot 等）生成代码并提交时，未指定使用个人邮箱 | ||
| 328 | + | ||
| 329 | +| 场景 | 选择方案 | 操作步骤 | | ||
| 330 | +|------|----------|----------| | ||
| 331 | +| commit邮箱为`****@noreply.gitcode.com`默认匿名邮箱 | 修改GitCode和本地Git邮箱 | 1. 在GitCode设置中添加个人邮箱并设为提交邮箱<br>2. 使用`git config user.email "签署CLA的邮箱"`修改本地配置<br>3. 修正已有commit邮箱后重新推送 | | ||
| 332 | +| commit邮箱与Gitcode提交邮箱一致 | 使用该邮箱重新签署 | 用commit邮箱重新签署CLA | | ||
| 333 | +| 希望使用commit邮箱签署 | 调整Gitcode设置 | 在Gitcode设置中添加commit邮箱并设为提交邮箱 | | ||
| 334 | +| 希望使用Gitcode提交邮箱签署 | 调整本地git配置 | 使用`git config --global user.email "邮箱"`修改配置 | | ||
| 289 | 335 | ||
| 290 | **修正commit邮箱命令：** | 336 | **修正commit邮箱命令：** |
| 291 | 337 | ||