momo-jun commented on code in PR #18071: URL: https://github.com/apache/pulsar/pull/18071#discussion_r997641989
########## site2/doc-guides/naming.md: ########## @@ -0,0 +1,216 @@ +# Pulsar Pull Request Naming Convention Guide + +> π©π»βπ« **Summary** +> +> This guide explains why you need good PR titles and how you do that with various selfβ-explanatory examples. + +**TOC** + +<!-- TOC --> + +- [Pulsar Pull Request Naming Convention Guide](#pulsar-pull-request-naming-convention-guide) + - [Why do PR titles matter?](#why-do-pr-titles-matter) + - [How to write good PR titles?](#how-to-write-good-pr-titles) + - [π‘Quick examples](#π‘quick-examples) + - [`type`](#type) + - [`scope`](#scope) + - [Pulsar](#pulsar) + - [Client](#client) + - [`Summary`](#summary) + - [Full examples](#full-examples) + - [References](#references) + +<!-- /TOC --> + +## Why do PR titles matter? + +Engineers and writers submit or review PRs almost every day. + +A PR title is a summary of your changes. + +* Vague, boring, and unclear PR titles decrease team efficiency and productivity. + +* PR titles should be engaging, easy to understand and readable. Review Comment: ```suggestion * PR titles should be engaging, easy to understand, and readable. ``` ########## site2/doc-guides/label.md: ########## @@ -0,0 +1,19 @@ +# Pulsar Documentation Label Guide + +> π©π»βπ« **Summary** +> +> This guide instructs you on how to label your doc PR. + +When submitting an issue or PR, you must [provide doc label information](https://github.com/apache/pulsar/blob/master/.github/PULL_REQUEST_TEMPLATE.md#documentation) by **selecting the checkbox**, so that the Bot can label the PR correctly. + +Label name|Usage +|---|--- +`doc-required`|Use this label to indicate this issue or PR impacts documentation.<br><br> **You have not updated the docs yet**. The docs will be submitted later. +`doc-not-needed`| The code changes in this PR do not impact documentation. +`doc`|This PR contains changes that impact documentation, **no matter whether the changes are in markdown or code files**. +`doc-complete`|Use this label to indicate the documentation updates are complete. +`doc-label-missing`|The Bot applies this label when there is no doc label information in the PR if one of the following conditions is met:. <br><br> - You do not provide a doc label. <br><br> - You provide multiple doc labels. <br><br> - You delete backticks (``) in doc labels. <br>For example,<br> [x] `doc-required` β <br> [x] doc-required β <br><br> - You add blanks in square brackets. <br>For example, <br> [x] `doc-required` β <br>[ x ] `doc-required` β Review Comment: ```suggestion `doc-label-missing`|The Bot applies this label when there is no doc label information in the PR if one of the following conditions is met: <br><br> - You do not provide a doc label. <br><br> - You provide multiple doc labels. <br><br> - You delete backticks (``) in doc labels. <br>For example,<br> [x] `doc-required` β <br> [x] doc-required β <br><br> - You add blanks in square brackets. <br>For example, <br> [x] `doc-required` β <br>[ x ] `doc-required` β ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
