Code Style and Quality Guide — Common Rules # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # 1. Copyright # Each file must include the Apache license information as a header. /* * Licensed to the Apache Software Foundation (ASF) under one * or more contributor license agreements.| flink.apache.org
Code Style and Quality Guide — Components Guide # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # Component Specific Guidelines # Additional guidelines about changes in specific components. Configuration Changes # Where should the config option go? ‘flink-conf.yaml’: All configuration that pertains to execution behavior that one may want to standardize across jobs.| flink.apache.org
Code Style and Quality Guide — Formatting Guide # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # Java Code Formatting Style # We recommend to set up the IDE to automatically check the code style. Please follow the IDE Setup Guide to set up spotless and checkstyle . License # Apache license headers.| flink.apache.org
Code Style and Quality Guide — Java # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # Java Language Features and Libraries # Preconditions and Log Statements # Never concatenate strings in the parameters Don’t: Preconditions.checkState(value <= threshold, "value must be below " + threshold) Don’t: LOG.| flink.apache.org
Code Style and Quality Guide — Pull Requests & Changes # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # Rationale: We ask contributors to put in a little bit of extra effort to bring pull requests into a state that they can be more easily and more thoroughly reviewed. This helps the community in many ways:| flink.apache.org
Code Style and Quality Guide — Scala # Preamble # Pull Requests & Changes # Common Coding Guide # Java Language Guide # Scala Language Guide # Components Guide # Formatting Guide # Scala Language Features # Where to use (and not use) Scala # We use Scala for Scala APIs or pure Scala Libraries. We do not use Scala in the core APIs and runtime components.| flink.apache.org
How to Review a Pull Request # This guide is for all committers and contributors that want to help with reviewing code contributions. Thank you for your effort - good reviews are one of the most important and crucial parts of an open source project. This guide should help the community to make reviews such that: Contributors have a good contribution experience. Our reviews are structured and check all important aspects of a contribution.| flink.apache.org