Hi all,
I've now merged the guide to the Flink website:
https://flink.apache.org/contributing/code-style-and-quality-preamble.html
I'm looking forward to more pull requests enhancing the guide.
On Tue, Jul 23, 2019 at 7:22 PM Hugo Louro wrote:
> Sounds good @stephan! Thanks.
>
> On Tue, Jul 2
Sounds good @stephan! Thanks.
On Tue, Jul 23, 2019 at 10:15 AM Stephan Ewen wrote:
> @hugo For your suggestions, I would ask to start a separate discussion
> thread.
> I think this mail thread has converged towards merging the initial
> suggestion as a starting point and refining it later based
@hugo For your suggestions, I would ask to start a separate discussion
thread.
I think this mail thread has converged towards merging the initial
suggestion as a starting point and refining it later based on new
discussions.
Best,
Stephan
On Thu, Jun 27, 2019 at 10:48 PM Hugo Louro wrote:
> +1
I have received one review for the PR so far.
I'll merge it in the next 24 hours unless there's further feedback.
On Mon, Jul 8, 2019 at 6:04 PM Robert Metzger wrote:
> I've converted the google document into a markdown-based pull request
> here: https://github.com/apache/flink-web/pull/224
>
>
I've converted the google document into a markdown-based pull request here:
https://github.com/apache/flink-web/pull/224
I didn't put a ton of effort into splitting the guide into multiple pages.
It would be nice to reach consensus on the exact split in the PR.
On Thu, Jun 27, 2019 at 10:48 PM Hu
+1. Thanks for working on the guide. It's very thorough and a good resource
to learn good practices from.
I would like use this thread as a placeholder for a couple of topics that
may be deserving of further discussion on different threads:
- What's the best way to keep track of checkstyle versi
I think it makes sense to also start individual [DISCUSS] threads about
extensions and follow-ups.
Various suggestions came up, partly as comments in the doc, some as
questions in other threads.
Examples:
- use of null in return types versus Optional versus @Nullable/@Nonnull
- initialization
Thanks for the pointer David.
I was not aware of this tool and I have no experience with its practical
impact. For example I would be curious what the effect of this is for
existing PRs, merge conflicts, etc.
If you want, feel free to start another discuss thread on the introduction
of such a too
I love this kind of unification being pushed forward, the benefit it has on
code reviews is enormous. Just my two cents, did you guys think about
adopting an automatic code formatter for java, the same way as Apache Beam
did?
It is super easy to use for contributors as they don't need to keep any
Thanks, everyone, for the positive feedback :-)
@Robert - It probably makes sense to break this down into various pages,
like PR, general code style guide, Java, component specific guides,
formats, etc.
Best,
Stephan
On Fri, Jun 21, 2019 at 4:29 PM Robert Metzger wrote:
> It seems that the di
It seems that the discussion around this topic has settled.
I'm going to turn the Google Doc into a markdown file (maybe also multiple,
I'll try out different things) and then open a pull request for the Flink
website.
I'll post a link to the PR here once I'm done.
On Fri, Jun 14, 2019 at 9:36 AM
Thanks for providing this useful guide for benefiting both contributors and
committers in consistency.
I just reviewed and learned the whole doc which covers a lot of information.
Wish it further categoried and put onto somewhere for easily traced future.
Best,
Zhijiang
Thanks a lot for putting this together!
I'm in the process of reworking the "How to contribute" pages [1] and I'm
happy to add the guide to the Flink website, once the discussion here is
over.
[1] https://github.com/apache/flink-web/pull/217
On Fri, Jun 14, 2019 at 3:21 AM Kurt Young wrote:
>
Big +1 and thanks for preparing this.
I think wha't more important is making sure most all the contributors can
follow
the same guide, a clear document is definitely a great start. Committers can
first try to follow the guide by self, and spread the standard during code
reviewing.
Best,
Kurt
On
+1 for this, I think all contributors can benefit from this.
Best,
Congxian
Aljoscha Krettek 于2019年6月13日周四 下午8:14写道：
> +1 I think this is a very good effort and should put to rest some
> back-and-forth discussions on PRs and some differences in “style” between
> committers. ;-)
>
> > On 13. Ju
+1 I think this is a very good effort and should put to rest some
back-and-forth discussions on PRs and some differences in “style” between
committers. ;-)
> On 13. Jun 2019, at 10:21, JingsongLee
> wrote:
>
> big +1, the content is very useful and enlightening.
> But it's really too long to
big +1, the content is very useful and enlightening.
But it's really too long to look at.
+1 for splitting it and expose it to contributors.
Even I think it's possible to put its link on the default description of
pull request, so that the user has to see it when submits the code.
Best, Jingsong
As for >add the guide to our repository<, it means check in
guide files under docs/, possibly docs/flinkDev. If we exclude
details of the guide from the doc site, maybe somewhere else.
Best,
tison.
Stephan Ewen 于2019年6月13日周四 下午3:54写道：
> This should definitely be split up into topics, agreed.
>
+1 for it and general content and thank everybody that was involved in creating
& writing this down.
+1 for splitting it up into some easily navigable topics.
Piotrek
> On 13 Jun 2019, at 09:54, Stephan Ewen wrote:
>
> This should definitely be split up into topics, agreed.
> And it should be
This should definitely be split up into topics, agreed.
And it should be linked form the "how to contribute" page or the PR
template to make contributors aware.
On Thu, Jun 13, 2019 at 9:51 AM Zili Chen wrote:
> Thanks for creating this guide Stephan. It is also
> a good start point to internals
Thanks for creating this guide Stephan. It is also
a good start point to internals doc.
One suggestion is we could finally separate the guide
into separated files each of which focus on a specific
topic. Besides, add the guide to our repository should
make contributors more aware of it.
Best,
tis
Thanks for the proposal, Stephan. Big +1 on this.
This is definitely helpful and indispensable for flink's code quality and
healthy community growth.
It would also benefit downstream project to integrate flink easier.
Till Rohrmann 于2019年6月13日周四 下午3:29写道：
> Thanks for creating this code style
Thanks for creating this code style and quality guide Stephan. I think
Flink can benefit from such a guide. Thus +1 for introducing and adhering
to it.
Cheers,
Till
On Thu, Jun 13, 2019 at 5:26 AM Bowen Li wrote:
> Hi Stephan,
>
> Definitely a good guide in principle IMO! I personally already f
Hi Stephan,
Definitely a good guide in principle IMO! I personally already find it
useful in practice to learn from it myself, and also promote and cultivate
a better coding habit around by referencing it. So big +1 to adopt it.
Also want to highlight that we need to make real use of it, and keep
24 matches
Mail list logo
