You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@pulsar.apache.org by pe...@apache.org on 2023/06/30 01:09:42 UTC

[pulsar] branch master updated: [improve][doc] Update PIP TEMPLATE.md: Clarify images (#20684)

This is an automated email from the ASF dual-hosted git repository.

penghui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git


The following commit(s) were added to refs/heads/master by this push:
     new cb5676eb17c [improve][doc] Update PIP TEMPLATE.md: Clarify images (#20684)
cb5676eb17c is described below

commit cb5676eb17cc0c044b443bd04f3644d9dc611adb
Author: Asaf Mesika <as...@gmail.com>
AuthorDate: Fri Jun 30 04:09:35 2023 +0300

    [improve][doc] Update PIP TEMPLATE.md: Clarify images (#20684)
---
 pip/TEMPLATE.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/pip/TEMPLATE.md b/pip/TEMPLATE.md
index 549916c7eb9..a605ed1bbc6 100644
--- a/pip/TEMPLATE.md
+++ b/pip/TEMPLATE.md
@@ -6,6 +6,9 @@ RULES
 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.
+
 THIS COMMENTS
 Please remove them when done.
 -->