[pulsar] branch master updated: [Workflow] add guidelines for merging a PR (#12988)

[li...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new bce8a2e  [Workflow] add guidelines for merging a PR (#12988)
bce8a2e is described below

commit bce8a2ea960ca380f3ae4439c2677f2424b0a208
Author: Anonymitaet <50...@users.noreply.github.com>
AuthorDate: Mon Nov 29 15:19:21 2021 +0800

    [Workflow] add guidelines for merging a PR (#12988)
    
    * [Workflow] add guidelines for merging a PR
    
    * add image
---
 site2/website/contributing.md               |  15 +++++++++++----
 site2/website/static/img/commit-message.png | Bin 0 -> 234213 bytes
 2 files changed, 11 insertions(+), 4 deletions(-)

diff --git a/site2/website/contributing.md b/site2/website/contributing.md
index b84d9c9..f63a332 100644
--- a/site2/website/contributing.md
+++ b/site2/website/contributing.md
@@ -15,11 +15,12 @@ We use a review-then-commit workflow in Pulsar for all contributions.
 
 **For all contributions:**
 
-1. **Code:** The best part ;-)
-1. **Review:** Submit a pull request with your contribution to our
+1. **Code:** code changes are always welcomed. 
+2. **Doc**: it is worth taking the time to make users know your code changes. Pulsar's long-term success rests on its ease of use, maintainability, etc. 
+3. **Review:** Submit a pull request with your contribution to our
    [GitHub Repo](https://github.com/apache/pulsar). Work with a committer to review and
    iterate on the code, if needed.
-1. **Commit:** Once at least 2 Pulsar committers have approved the pull request, a Pulsar committer
+4. **Commit:** Once at least 2 Pulsar committers have approved the pull request, a Pulsar committer
     will merge it into the master branch (and potentially backport to stable branches in case of
     bug fixes).
 
@@ -201,7 +202,7 @@ In the pull request description, please include:
  * Changes: Summary of what this pull request is changing, to help reviewers at better understanding
    the changes.
 
-Please include a descriptive pull request message to help make the comitter’s job easier when reviewing.
+Please include a descriptive pull request message to help make the committer’s job easier when reviewing.
 It’s fine to refer to existing design docs or the contents of the associated issue as appropriate.
 
 If the pull request is fixing an issue, include a mention to in the description, like:
@@ -247,6 +248,12 @@ Once the code has been peer reviewed by a committer, the next step is for the co
 
 Pull requests should not be merged before the review has approved from at least 2 committers.
 
+> **Tip**
+> 
+> Git commit message is not only the best way to communicate context about code changes, but also shows whether a developer is a good collaborator. If the first commit message of a PR is not clear but the PR description is clear and concise, when merging a PR, consider copying the PR description to the commit message box or writing a proper one rather than using the default (first) commit message (see image below). In this way, others know the changes clearly, which is beneficial to cut  [...]
+ 
+![Submit clear commit message](../img/commit-message.png)
+
 ### Contributor License Agreement
 
 If you are merging a larger contribution, please make sure that the contributor has an ICLA on file with the Apache Secretary. You can view the list of committers [here](http://home.apache.org/phonebook.html?unix=committers), as well as [ICLA-signers who aren’t yet committers](http://home.apache.org/unlistedclas.html).
diff --git a/site2/website/static/img/commit-message.png b/site2/website/static/img/commit-message.png
new file mode 100644
index 0000000..9895d58
Binary files /dev/null and b/site2/website/static/img/commit-message.png differ