(pulsar) branch master updated: [improve][doc] Clarify to check numbering when creating the PIP doc (#21623)

[te...@apache.org]

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

technoboy 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 8dac8a5dbfb [improve][doc] Clarify to check numbering when creating the PIP doc (#21623)
8dac8a5dbfb is described below

commit 8dac8a5dbfb9fb6d3338310de13080d4816c477f
Author: Asaf Mesika <as...@gmail.com>
AuthorDate: Mon Nov 27 12:23:32 2023 +0200

    [improve][doc] Clarify to check numbering when creating the PIP doc (#21623)
---
 pip/README.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/pip/README.md b/pip/README.md
index 1ea4bf28992..7b0f4c6c57a 100644
--- a/pip/README.md
+++ b/pip/README.md
@@ -69,6 +69,7 @@ The process works in the following way:
 3. Write the proposal following the section outlined by the template and the explanation for each section in the comment it contains (you can delete the comment once done).
    * If you need diagrams, avoid attaching large files. You can use [MermaidJS](https://mermaid.js.org/) as simple language to describe many types of diagrams. 
 4. Create GitHub Pull request (PR). The PR title should be `[improve][pip] PIP-xxx: {title}`, where the `xxx` match the number given in previous step (file-name). Replace `{title}` with a short title to your proposal.
+   *Validate* again that your number does not collide, by step (2) numbering check. 
 5. The author(s) will email the dev@pulsar.apache.org mailing list to kick off a discussion, using subject prefix `[DISCUSS] PIP-xxx: {PIP TITLE}`. The discussion will happen in broader context either on the mailing list or as general comments on the PR. Many of the discussion items will be on particular aspect of the proposal, hence they should be as comments in the PR to specific lines in the proposal file.
 6. Update file with a link to the discussion on the mailing. You can obtain it from [Apache Pony Mail](https://lists.apache.org/list.html?dev@pulsar.apache.org).
 7. Based on the discussion and feedback, some changes might be applied by authors to the text of the proposal. They will be applied as extra commits, making it easier to track the changes.