AuroraTwinkle commented on code in PR #10: URL: https://github.com/apache/pulsar-java-contrib/pull/10#discussion_r1827138403
########## pcip/README.md: ########## @@ -0,0 +1,90 @@ +# Pulsar Java Contrib Improvement Proposal (PCIP) + +## What is a PCIP? + +The PCIP is a "Pulsar Java Contrib Improvement Proposal" and it's the mechanism used to propose changes to the Apache Pulsar Java Contrib codebases. + +The changes might be in terms of new features, large code refactoring, changes to APIs. + +In practical terms, the PCIP 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 PCIP? + +There are several goals for the PCIP 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 PCIP document to serve as the baseline on which to create the documentation for the new feature. + +4. 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 PCIP to add undue process or slow-down the development. + +### When is a PCIP 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 +* Any changes to the metrics (metrics endpoint, topic stats, topics internal stats, broker stats, etc.) +* Any change to the configuration + +### When is a PCIP *not* required? + +* Bug-fixes +* Simple enhancements that won't affect the APIs or the semantic +* Small documentation changes +* Small website changes +* Build scripts changes (except: a complete rewrite) + +### Who can create a PCIP? + +Any person willing to contribute to the Apache Pulsar project is welcome to create a PCIP. Review Comment: This should be Apache Pulsar Java Contrib project. ########## pcip/TEMPLATE.md: ########## @@ -0,0 +1,174 @@ +<!-- +RULES +* Never place a link to an external site like Google Doc. The proposal should be in this issue entirely. +* Use a spelling and grammar checker tools if available for you (there are plenty of free ones). + +PROPOSAL HEALTH CHECK +I can read the design document and understand the problem statement and what you plan to change *without* resorting to a couple of hours of code reading just to start having a high level understanding of the change. + +IMAGES +If you need the diagrams, please create a folder named pcip-XXX under the [pcip/static/img](https://github.com/apache/pulsar-java-contrib/tree/master/pcip/static/img) path and put the images in. + +THIS COMMENTS +Please remove them when done. +--> + +# PCIP-XXX: Proposal title + +# Background knowledge + +<!-- +Describes all the knowledge you need to know in order to understand all the other sections in this PCIP + +* Give a high level explanation on all concepts you will be using throughout this document. For example, if you want to talk about Persistent Subscriptions, explain briefly (1 paragraph) what this is. If you're going to talk about Transaction Buffer, explain briefly what this is. + If you're going to change something specific, then go into more detail about it and how it works. +* Provide links where possible if a person wants to dig deeper into the background information. + +DON'T +* Do not include links *instead* explanation. Do provide links for further explanation. + +EXAMPLES +* See [PCIP-248](https://github.com/apache/pulsar/issues/19601), Background section to get an understanding on how you add the background knowledge needed. Review Comment: This is a example from pulsar? Maybe we need one from Pulsar Java Contrib ########## pcip/README.md: ########## @@ -0,0 +1,90 @@ +# Pulsar Java Contrib Improvement Proposal (PCIP) + +## What is a PCIP? + +The PCIP is a "Pulsar Java Contrib Improvement Proposal" and it's the mechanism used to propose changes to the Apache Pulsar Java Contrib codebases. + +The changes might be in terms of new features, large code refactoring, changes to APIs. + +In practical terms, the PCIP 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 PCIP? + +There are several goals for the PCIP 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 PCIP document to serve as the baseline on which to create the documentation for the new feature. + +4. 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 PCIP to add undue process or slow-down the development. + +### When is a PCIP 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 +* Any changes to the metrics (metrics endpoint, topic stats, topics internal stats, broker stats, etc.) +* Any change to the configuration + +### When is a PCIP *not* required? + +* Bug-fixes +* Simple enhancements that won't affect the APIs or the semantic +* Small documentation changes +* Small website changes +* Build scripts changes (except: a complete rewrite) + +### Who can create a PCIP? + +Any person willing to contribute to the Apache Pulsar project is welcome to create a PCIP. + +## How does the PCIP process work? Review Comment: Since we do'nt need DISCUSSION and VOTE as **Development Process** mentioned, is the PCIP workflow here still necessary? -- 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]
