Skip to main content

如何使用邮件列表

介绍邮件列表的使用规范和参考示例

邮件列表的订阅请参考此订阅指引

Linkis的存档邮件可以在此处查看存档邮件

1. 主题种类#

邮件的主题可以大体分为以下几种类型

  • [DISCUSS] 针对某一特性/功能/逻辑修改/CI/CD的讨论，可以是实现方式/设计/优化建议等等
  • [PROPOSAL] 提案，如新增/移除某些功能，和[DISCUSS]区别并不大
  • [VOTE] 对变更的投票/推选Committer/推选新的PPMC成员等，比如版本的发布，每个版本都会在社区dev邮件列表进行投票；也可以进行多种方案的选择时，发起投票。
  • [ANNOUNCE] 宣布新版本完成发布，宣布推选出的新Committer/PPMC等
  • [NOTICE] 主要用来通知一些临时公告等，如社区沙箱环境停服维修/升级，web官网出现服务异常不可用等；以及线上线下周会/交流会以及各种活动信息公告等
  • [HELP] 寻求帮助, 因为git的代码通知比较多，有时无法及时查阅到；另外github网络访问受限，可能有些同学无法顺利的通过github提交issue。通过邮件发起，更容易辨别和被感知到。
  • [VOTE][RESULT] 宣布版本发布投票的结果

2. 邮件规范#

通用规范
  • 尽可能不要发送纯 HTML 消息，而是发送纯文本。如果使用QQ邮箱，其邮件内容默认使用的是html格式，编写时请先切换至纯文本格式，详细切换指引见本文附录
  • 开发者/社区用户/PPMC成员针对以上场景的内容，发起邮件讨论/需求帮助/通知事宜等，请发送至dev@linkis.apache.org邮箱
  • 邮件标题前请带上对应的类型前缀：如[HELP] XXXXXXX,[DISCUSS] XXXXXXX

更多可以参阅官方邮件规范 https://infra.apache.org/contrib-email-tips

[DISCUSS/Proposal] 邮件

  • 标题[DISCUSS][模块名] XXXX(如果是某个具体模块的话，建议带上模块名)
  • 一般先在Github 的issues栏上创建对应的issue，再发起邮件讨论
  • 简要描述清楚讨论/提议的内容（如:背景/希望解决什么问题/怎么解决）
  • 涉及到的模块（如果是涉及到某一两个具体的模块）
  • 相关的设计说明等图文信息可以放在对应的issue中，方便修改，邮件中引用链接即可。
  • 可以附上对应的中文翻译

[HELP] 邮件

  • 请先确认QA文档/issues以及存档邮件中是否未收录此问题
  • 详细描述清楚遇到的问题
  • 如何复现此问题
  • 可以在git上创建对应的issue
  • 可以附上对应的中文翻译

3. 示例参考#

[DISCUSS/Proposal] 示例

[VOTE] 示例

[ANNOUNCE] 示例

[NOTICE] 示例

[HELP] 示例

4. PPMC的邮件使用#

从一个版本的确定到发布，可能会涉及具体的使用邮件的常见场景

  1. 新版本需要组织PMC和开发者进行讨论，需要记录会议纪要，确定此版本功能点，计划的大体发布时间，以及本次的release manager等，并发送会议纪要private@linkis.apache.org 邮件列表。
  2. 对于新版本的特性列表范围，需要发送投票邮件至dev@linkis.apache.org邮箱中，并需要3+ PMC同意且同意票大于反对票。
  3. 主持的周例会，会议前需要发布会议邀约提醒邮件/会议后要发送会议纪要邮件至dev@linkis.apache.org邮箱中
  4. 新的committer/ppmc投票需要发送投票邮件至private@linkis.apache.org邮箱中。新的committer/ppmc推选流程见 https://community.apache.org/newcommitter.html

5. 版本发布投票邮件的回复#

如果发起了发布投票，验证后(详细验证流程见如何验证)，可以参照此回复示例进行邮件回复

回复的邮件一定要带上自己检查了那些项信息，仅仅回复`+1 approve`，是无效的。

PPMC/IPMC成员，投票时请带上 binding后缀，表示具有约束性投票，方便统计投票结果

非PPMC/IPMC成员

+1 (non-binding)I  checked:    1. All download links are valid    2. Checksum and signature are OK    3. LICENSE and NOTICE are exist    4. Build successfully on macOS(Big Sur)     5. ....

PPMC/IPMC成员

+1 (binding)I  checked:    1. All download links are valid    2. Checksum and signature are OK    3. LICENSE and NOTICE are exist    4. Build successfully on macOS(Big Sur)     5. ....

6. 附录#

QQ邮箱切换纯文本格式

image