liangyepianzhou commented on code in PR #10: URL: https://github.com/apache/pulsar-java-contrib/pull/10#discussion_r1827162984
########## pcip/README.md: ########## @@ -0,0 +1,65 @@ +# 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. + +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. As a user manual, add instructions when introducing new features or modifying existing features. +2. Explain the functional design ideas to facilitate review and later maintenance. + +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 Java Contrib +* Any change to the semantic of existing functionality, even when current behavior is incorrect. Review Comment: ```suggestion * Any change to the semantic of existing functionality ``` ########## pcip/README.md: ########## @@ -0,0 +1,65 @@ +# 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. + +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. As a user manual, add instructions when introducing new features or modifying existing features. +2. Explain the functional design ideas to facilitate review and later maintenance. + +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 Java Contrib +* Any change to the semantic of existing functionality, even when current behavior is incorrect. +* Any large code change that will touch multiple components +* Any change to the configuration + +### When is a PCIP *not* required? + +* Bug-fixes +* Small documentation changes +* Small website changes +* Build scripts changes (except: a complete rewrite) Review Comment: ```suggestion ``` ########## pcip/README.md: ########## @@ -0,0 +1,65 @@ +# 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. + +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. As a user manual, add instructions when introducing new features or modifying existing features. +2. Explain the functional design ideas to facilitate review and later maintenance. + +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 Java Contrib +* Any change to the semantic of existing functionality, even when current behavior is incorrect. +* Any large code change that will touch multiple components +* Any change to the configuration + +### When is a PCIP *not* required? + +* Bug-fixes +* Small documentation changes +* Small website changes Review Comment: ```suggestion ``` ########## pcip/README.md: ########## @@ -0,0 +1,65 @@ +# 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. + +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. As a user manual, add instructions when introducing new features or modifying existing features. +2. Explain the functional design ideas to facilitate review and later maintenance. + +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 Java Contrib +* Any change to the semantic of existing functionality, even when current behavior is incorrect. +* Any large code change that will touch multiple components +* Any change to the configuration + +### When is a PCIP *not* required? + +* Bug-fixes +* Small documentation changes Review Comment: ```suggestion * Documentation changes ``` -- 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]
