6.10 Elasticsearch-提 PR 规范：CLA 签署、issue 关联、Backport 流程、release note
向 Elasticsearch 官方仓库提 PR 时，代码质量只是“入场券”，真正决定合并速度的是你对社区流程的熟悉度。本节把四个最容易被 maintainers 打回票的环节——CLA、issue 关联、Backport、release note——拆成 checklist，照做可显著降低 review 往返次数。
1. CLA 签署：一次性永久生效，但容易踩坑
打开 https://www.elastic.co/contributor-agreement
选“Individual”或“Corporate”：- 个人贡献者直接选 Individual，用 GitHub 账号授权登录。
- 公司贡献者选 Corporate，需法务先签 PDF，再由公司 CLA Manager 把你在 https://cla-assistant.io 里加入白名单。
签署成功后，elastic/cla-check 机器人会在你 PR 里 comment “CLA check passed”。
常见失败原因：- commit email 跟 GitHub 主邮箱不一致 →
git config user.email改完再git rebase --reset-author。 - 公司账号未加入白名单 → 让 CLA Manager 在 https://cla-assistant.io/elastic/elasticsearch 把你的 GitHub id 加进去。
- commit email 跟 GitHub 主邮箱不一致 →
一次签署，全 Elastic 项目终身有效；换电脑、换邮箱只需在 GitHub 设置里把旧邮箱加回来即可。
2. Issue 关联：让机器人替你打工
Elasticsearch 使用 “Fixes #12345” 关键字关闭 issue，格式错误会被 elasticmachine 机器人无视。
PR 描述模板里必须包含：
- Relates #12345 // 只是关联，不关闭 - Closes #12345 // 合并后自动关闭 - Supersedes #12345 // 替代旧 PR多 issue 用换行分隔，勿写 “Fixes #12345, #67890”，机器人只认第一个。
如果 issue 跨仓库，写全名：
Closes elastic/elasticsearch-hadoop#8903. Backport 流程：标签驱动，机器人 cherry-pick
Elasticsearch 采用“main-only”开发模型，所有代码先合进 main，再由机器人挑拣到旧分支。
步骤：
- PR 被合并后，立即在原始 PR 页面加标签
>backport-8.x（x 为目标 minor）。 - elasticmachine 会在 5 分钟内发起 backport PR，标题形如
[8.13] <原始标题> (#原始编号)。 - 若出现冲突，机器人 @ 你，需在本地执行：
gitfetch origingitcheckout origin/8.13gitcheckout -b backport-pr-98765-8.13gitcherry-pick -x<main 上的 merge commit># 解决冲突后继续gitadd.gitcherry-pick --continuegitpush fork backport-pr-98765-8.13然后在机器人评论里贴新 PR 链接，maintainer 会手动关闭旧 backport 任务。
注意：
- 只有带有“v8.13.0”里程碑的 issue 才需要 backport；标签打错版本会被机器人忽略。
- 文档类 PR 无需 backport，除非明确影响旧版本文档。
4. Release Note：一句话决定用户是否升级
Elasticsearch 的 release note 源数据在/docs/reference/release-notes/*.asciidoc，但不用你手写，全靠 PR 标签自动生成。
规则：
- 标签
release-note→ 出现在 “Enhancement” 或 “Bug fixes” 区。 - 标签
release-note-highlight→ 出现在 “Highlights” 区，附带 2-3 行营销文案。 - 标签
non-issue或>test→ 不出现在 release note。
PR 描述里加Release note:段落，供发布经理二次润色：
Release note: The vector search API now supports `byte` element type, reducing memory footprint by 75% for normalized embeddings.若遗漏标签，可在合并后补评论/release-note (enhancement)，机器人会同步更新草稿。
5. 提 PR 前的 30 秒自检清单
git config user.email与 GitHub 一致- commit message 含 “Closes #xxxx”
- 本地
./gradlew precommit通过 - 已加
release-note或non-issue标签 - 若 target 8.x，已 plan 好 backport 标签
把上述四项流程固化到日常习惯，你的 PR 从打开到合并的平均时间能从 10 天缩短到 3 天以内。```
推荐阅读：
PyCharm 2018–2024使用指南
更多技术文章见公众号: 大城市小农民
