flink-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From rmetz...@apache.org
Subject flink-web git commit: added guava checks usage recommendation in coding guidelines
Date Fri, 05 Jun 2015 07:44:07 GMT
Repository: flink-web
Updated Branches:
  refs/heads/asf-site 86f2da148 -> bf4b55f76

added guava checks usage recommendation in coding guidelines

This closes #1

Project: http://git-wip-us.apache.org/repos/asf/flink-web/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink-web/commit/bf4b55f7
Tree: http://git-wip-us.apache.org/repos/asf/flink-web/tree/bf4b55f7
Diff: http://git-wip-us.apache.org/repos/asf/flink-web/diff/bf4b55f7

Branch: refs/heads/asf-site
Commit: bf4b55f7608cf8f8006286684e4cda32fd85c648
Parents: 86f2da1
Author: Lokesh Rajaram <rajaram.lokesh@gmail.com>
Authored: Thu Jun 4 23:59:24 2015 -0700
Committer: Robert Metzger <rmetzger@apache.org>
Committed: Fri Jun 5 09:43:32 2015 +0200

 coding-guidelines.md | 1 +
 1 file changed, 1 insertion(+)

diff --git a/coding-guidelines.md b/coding-guidelines.md
index 49f02b4..f1010b8 100644
--- a/coding-guidelines.md
+++ b/coding-guidelines.md
@@ -36,6 +36,7 @@ for (...) {
   If you are wondering why, recall the famous [*goto bug*](https://www.imperialviolet.org/2014/02/22/applebug.html)
in Apple's SSL library.
 - **No wildcard imports**. Do not use wildcard imports in the core files. They can cause
problems when adding to the code and in some cases even during refactoring. Exceptions are
the Tuple classes, Tuple-related utilities, and Flink user programs, when importing operators/functions.
Tests are a special case of the user programs.
 - **No unused imports**. Remove all unused imports.
+- **Use Guava Checks**. To increase homogeneity, consistently use Guava methods checkNotNull
and checkArgument rather than Apache Commons Validate.
 - **No raw generic types**. Do not use raw generic types, unless strictly necessary (sometime
necessary for signature matches, arrays).
 - **Supress warnings**. Add annotations to suppress warnings, if they cannot be avoided (such
as "unchecked", or "serial").
 - **Comments**. Add comments to your code. What is it doing? Add JavaDocs or inherit them
by not adding any comments to the methods. Do not automatically generate comments and avoid
unnecessary comments like:

View raw message