tisonkun commented on code in PR #17270: URL: https://github.com/apache/pulsar/pull/17270#discussion_r954502903
########## wiki/proposals/PIP.md: ########## @@ -0,0 +1,146 @@ +# Pulsar Improvement Proposal (PIP) + +## What is a PIP? + +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. + +## What is the goal of a PIP? + +There are several goals for the PIP process: + +1. Ensure community technical discussion of major changes to the Apache Pulsar + codebase + +2. 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. + +3. Use the PIP document to serve as the starting base on which to create the + documentation for the new feature. + +4. Have greater scrutiny to changes are affecting the public APIs 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. + +## When is a PIP required? + +* Any new feature for Pulsar brokers or client +* Any change to the public APIs (Client APIs, REST APIs, Plugin APIs) +* Any change to the wire protocol APIs +* Any change to the API of Pulsar CLI tools (eg: new options) +* Any change to the semantic of existing functionality, even when current + behavior is incorrect. +* Any large code change that will touch multiple components + +## When is a PIP *not* required? + +* Bug-fixes +* Simple enhancements that won't affect the APIs or the semantic +* Documentation changes +* Website changes +* Build scripts changes (except: a complete rewrite) + +## Who can create a PIP? + +Any person willing to contribute to the Apache Pulsar project is welcome to +create a PIP. + +## How does the PIP process work? + +A PIP proposal can be in these states: +1. **DRAFT**: (Optional) This might be used for contributors to collaborate and + to seek feedback on an incomplete version of the proposal. + +2. **DISCUSSION**: The proposal has been submitted to the community for + feedback and approval. + +3. **ACCEPTED**: The proposal has been accepted by the Pulsar project. + +4. **REJECTED**: The proposal has not been accepted by the Pulsar project. + +5. **IMPLEMENTED**: The implementation of the proposed changes have been + completed and everything has been merged. + +5. **RELEASED**: The proposed changes have been included in an official + Apache Pulsar release. + +The process works in the following way: + +1. The author(s) of the proposal will create a GitHub issue ticket choosing the + template for PIP proposals. +2. The author(s) will send a note to the [email protected] mailing list + to start the discussion, using subject prefix `[PIP] xxx`. +3. Based on the discussion and feedback, some changes might be applied by + authors to the text of the proposal. +4. Once some consensus is reached, there will be a vote to formally approve + the proposal. + The vote will be held on the [email protected] mailing list. Everyone + is welcome to vote on the proposal, though it will considered to be binding + only the vote of PMC members. + I would be required to have a lazy majority of at least 3 binding +1s votes. + The vote should stay open for at least 48 hours. +5. When the vote is closed, if the outcome is positive, the state of the + proposal is updated and the Pull Requests associated with this proposal can + start to get merged into the master branch. Review Comment: You may try to list the proposed process here and we start to practice the process discussing on a pull request. Anyway, this content doesn't reflect what was discussed on the mailing list. -- 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]
