Denovo1998 commented on code in PR #10: URL: https://github.com/apache/pulsar-java-contrib/pull/10#discussion_r1822514784
########## 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 diagrams, avoid attaching large files. You can use [MermaidJS]([url](https://mermaid.js.org/)) as a simple language to describe many types of diagrams. Review Comment: Images are still needed. ``` IMAGES If you need the diagrams, please create a folder named pcip-XXX under the pcip/static/img path and put the images in. ``` -- 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]
