You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tr...@apache.org on 2018/09/20 08:49:09 UTC

[flink-web] 01/02: [FLINK-10307] Instruct users to email us with proper code snippets

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

trohrmann pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/flink-web.git

commit 7e3cf1ed1300b79b7112a18040b7b4028ac5cb1f
Author: Nikos Maris <nm...@crypteianetworks.com>
AuthorDate: Thu Sep 20 10:47:21 2018 +0200

    [FLINK-10307] Instruct users to email us with proper code snippets
---
 community.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/community.md b/community.md
index e32a4ff..f170d67 100755
--- a/community.md
+++ b/community.md
@@ -9,6 +9,14 @@ title: "Community & Project Info"
 
 There are many ways to get help from the Apache Flink community. The [mailing lists](#mailing-lists) are the primary place where all Flink committers are present. For user support and questions use the *user mailing list*. Some committers are also monitoring [Stack Overflow](http://stackoverflow.com/questions/tagged/apache-flink). Please remember to tag your questions with the *[apache-flink](http://stackoverflow.com/questions/tagged/apache-flink)* tag. Bugs and feature requests can eith [...]
 
+If you send us an email with a code snippet, make sure that:
+
+1. you do not link to files in external services as such files can change, get deleted or the link might break and thus make an archived email thread useless
+2. you paste text instead of screenshots of text
+3. you keep formatting when pasting code in order to keep the code readable
+4. there are enough import statements to avoid ambiguities
+
+
 ## Mailing Lists
 
 <table class="table table-striped">