Flink Code Base Best Practices

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Flink Code Base Best Practices

Ufuk Celebi-2
Hey all,

I've just created a Wiki page with a loose collection of some coding
"best practices" for the Flink project. The list was the result of a
discussion with other PMCs, committers, and contributors. It is not a
set of enforced rules, but a general list of tips, links to Flink
utilities, common patterns etc.

https://cwiki.apache.org/confluence/display/FLINK/Best+Practices+and+Lessons+Learned

Since the project only has a minimum set of enforced or automatically
checked rules, the goal of the document is to help both new and old
contributors alike with some guidelines. In the future we might
consider translating some of the listed items to automatic checks or
IDE setup templates.

The document is in progress. Feel free to comment, add or remove items
while browsing or working on the Flink code base.

– Ufuk
Reply | Threaded
Open this post in threaded view
|

Re: Flink Code Base Best Practices

Stephan Ewen
Very nice, thanks Ufuk!



On Mon, Jan 16, 2017 at 12:05 PM, Ufuk Celebi <[hidden email]> wrote:

> Hey all,
>
> I've just created a Wiki page with a loose collection of some coding
> "best practices" for the Flink project. The list was the result of a
> discussion with other PMCs, committers, and contributors. It is not a
> set of enforced rules, but a general list of tips, links to Flink
> utilities, common patterns etc.
>
> https://cwiki.apache.org/confluence/display/FLINK/Best+
> Practices+and+Lessons+Learned
>
> Since the project only has a minimum set of enforced or automatically
> checked rules, the goal of the document is to help both new and old
> contributors alike with some guidelines. In the future we might
> consider translating some of the listed items to automatic checks or
> IDE setup templates.
>
> The document is in progress. Feel free to comment, add or remove items
> while browsing or working on the Flink code base.
>
> – Ufuk
>
Reply | Threaded
Open this post in threaded view
|

Re: Flink Code Base Best Practices

Shaoxuan Wang
In reply to this post by Ufuk Celebi-2
Ufuk,
Thanks a lot for noting down all those "good to know" and sharing them to
the community.

On Mon, Jan 16, 2017 at 7:05 PM, Ufuk Celebi <[hidden email]> wrote:

> Hey all,
>
> I've just created a Wiki page with a loose collection of some coding
> "best practices" for the Flink project. The list was the result of a
> discussion with other PMCs, committers, and contributors. It is not a
> set of enforced rules, but a general list of tips, links to Flink
> utilities, common patterns etc.
>
> https://cwiki.apache.org/confluence/display/FLINK/Best+
> Practices+and+Lessons+Learned
>
> Since the project only has a minimum set of enforced or automatically
> checked rules, the goal of the document is to help both new and old
> contributors alike with some guidelines. In the future we might
> consider translating some of the listed items to automatic checks or
> IDE setup templates.
>
> The document is in progress. Feel free to comment, add or remove items
> while browsing or working on the Flink code base.
>
> – Ufuk
>