Skip to main content

How to Use Email

Introduces mailing list usage guidelines and reference examples

To subscribe to the mailing list, please refer to this Subscription Guidelines

Linkis' archived mail can be viewed here archived mail

1. Themes#

The subject of the email can be roughly divided into the following types

  • [DISCUSS] Discussion on a feature/function/logic modification/CI/CD, which can be implementation/design/optimization suggestion, etc.
  • [PROPOSAL] Proposals, such as adding/removing certain features, are not much different from [DISCUSS]
  • [VOTE] Vote for changes/elect Committer/elect new PPMC members, etc., such as version release, each version will be voted on in the community dev mailing list; you can also choose multiple options ,Poll.
  • [ANNOUNCE] Announce the completion of the release of the new version, announcing the new Committer/PPMC elected, etc.
  • [NOTICE] Mainly used to notify some temporary announcements, etc., such as the community sandbox environment is suspended for maintenance/upgrade, the web official website is abnormally unavailable, etc.; as well as online and offline weekly meetings/exchange meetings and various Event information announcements, etc.
  • [HELP] Ask for help, because there are many git code notifications, and sometimes it is impossible to check them in time; in addition, github network access is limited, and some students may not be able to submit issues through github smoothly. Initiated by email, it is easier to identify and be perceived.
  • [VOTE][RESULT] Announce the results of the release vote

2. Mail specifications#

general specification
  • Whenever possible do not send plain HTML messages, but plain text. If you use QQ mailbox, its email content is in html format by default. Please switch to plain text text format when writing. For detailed switching instructions, see the appendix of this article.
  • Developers/community users/PPMC members initiate email discussions/needs for help/notifications for the content of the above scenarios, please send them to dev@linkis.apache.org
  • Please put the corresponding type prefix before the email subject: such as [HELP] XXXXXXX, [DISCUSS] XXXXXXX

For more information, please refer to the official Mail Etiquette https://infra.apache.org/contrib-email-tips

[DISCUSS/Proposal] Mail

  • Title [DISCUSS][module name] XXXX (if it is a specific module, it is recommended to bring the module name)
  • Generally, create a corresponding issue on Github's issues column, and then initiate an email discussion
  • Briefly describe clearly the content of the discussion/proposal (eg: background/what problem you want to solve/how to solve it)
  • Modules involved (if one or two specific modules are involved)
  • Graphical and textual information such as relevant design instructions can be placed in the corresponding issue for easy modification, and the link can be quoted in the email.
  • The corresponding Chinese translation can be attached

[HELP] Mail

3. Sample reference#

[DISCUSS/Proposal] Example

[VOTE] Example

[ANNOUNCE] Example

[NOTICE] Example

[HELP] Example

4. Mail usage of PPMC#

From the determination of a version to the release, it may involve specific common scenarios of using email

  1. The new version needs to organize PMC and developers to discuss, record the minutes of the meeting, determine the function points of this version, the general release time of the plan, and the release manager of this time, etc., and send the meeting minutes private@linkis.apache.org Email list.
  2. For the scope of the feature list of the new version, you need to send a voting email to dev@linkis.apache.org, and 3+ PMCs are required to agree and the yes votes are greater than the negative votes.
  3. For the weekly regular meeting hosted, the meeting invitation reminder email needs to be released before the meeting / the meeting minutes email should be sent to the dev@linkis.apache.org mailbox after the meeting
  4. New committer/ppmc votes need to be sent to private@linkis.apache.org. See https://community.apache.org/newcommitter.html for the new committee/ppmc selection process

5. How to reply to version release voting emails#

If a release vote is initiated, after verification (see How to verify for the detailed verification process), you can refer to this reply example for email reply

If you initiate a posting vote, you can refer to this response example to reply to the email after verification

When replying to the email, you must bring the information that you have checked by yourself. Simply replying to `+1 approve` is invalid.

PPMC/IPMC member voting is best with the binding suffix, indicating a binding vote, which is convenient for counting voting results

Non-PPMC/Non-IPMC member

+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 member

+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. Appendix#

QQ mailbox switch to plain text format

image