Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

Commit

Permalink
[improve][doc] Clarify to check numbering when creating the PIP doc (a…
Browse files Browse the repository at this point in the history
  • Loading branch information
asafm authored Nov 27, 2023
1 parent 697c168 commit 8dac8a5
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions pip/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 8dac8a5

Please sign in to comment.