The PIP is a “Pulsar Improvement Proposal” and it's the mechanism used to propose changes to the Apache Pulsar codebases.
The changes might be in terms of new features, large code refactoring, changes to APIs.
In practical terms, the PIP defines a process in which developers can submit a design doc, receive feedback and get the “go ahead” to execute.
There are several goals for the PIP process:
Ensure community technical discussion of major changes to the Apache Pulsar codebase.
Provide clear and thorough design documentation of the proposed changes. Make sure every Pulsar developer will have enough context to effectively perform a code review of the Pull Requests.
Use the PIP document to serve as the baseline on which to create the documentation for the new feature.
Have greater scrutiny to changes are affecting the public APIs (as defined below) to reduce chances of introducing breaking changes or APIs that are not expressing an ideal semantic.
It is not a goal for PIP to add undue process or slow-down the development.
Any person willing to contribute to the Apache Pulsar project is welcome to create a PIP.
A PIP proposal can be in these states:
DRAFT: (Optional) This might be used for contributors to collaborate and to seek feedback on an incomplete version of the proposal.
DISCUSSION: The proposal has been submitted to the community for feedback and approval.
ACCEPTED: The proposal has been accepted by the Pulsar project.
REJECTED: The proposal has not been accepted by the Pulsar project.
IMPLEMENTED: The implementation of the proposed changes have been completed and everything has been merged.
RELEASED: The proposed changes have been included in an official Apache Pulsar release.
The process works in the following way:
pip/TEMPLATE.md
and name it pip-xxx.md
. The number xxx
should be the next sequential number after the last contributed PIP. You view the list of contributed PIPs (at any status) as a list of Pull Requests having a “PIP” label. Use the link here as shortcut.[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.[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.[VOTE] PIP-xxx: {PIP TITLE}
. Make sure to include a link to the PIP PR in the body of the message. Make sure to update the PIP with a link to the vote. You can obtain it from Apache Pony Mail. Everyone is welcome to vote on the proposal, though only the vote of the PMC members will be considered binding. It is required to have a lazy majority of at least 3 binding +1s votes. The vote should stay open for at least 48 hours.All the future implementation Pull Requests that will be created, should always reference the PIP-XXX in the commit log message and the PR title. It is advised to create a master GitHub issue to formulate the execution plan and track its progress.
You can the view list of PIPs previously managed by GitHub wiki or GitHub issues here
[pip][design] PIP-
. Here is the link for it.pip
folder. Each one is an approved PIP.