osdir.com


[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Question: Flink JIRA issues for simple code comment improvements


Hi Miguel,

it's a good point you are bringing up here. One of the reasons why there
are some irregularities is that the code has grown quite a bit over time.
Another is that we have established checkstyle rules but they are not yet
activated for all modules because the initial effort to fix all violations
was too high. The idea was to enable more and more checkstyle rules once we
have fixed the issues. As a consequence, many contributors fix the
irregularites (wrt checkstyle) when they are touching a component but don't
do this as a task alone.

In that sense I would say to open a PR if you've already made the work but
in the future I would refrain from doing solely minor comment cleanup work
because the review load is already quite a bit for the community to handle
and these PRs might simply not get enough attention.

Does that make sense?

Cheers,
Till

On Tue, Nov 20, 2018 at 6:59 PM Miguel Coimbra <miguel.e.coimbra@xxxxxxxxx>
wrote:

>  Hello,
>
> I want to start contributing to the Apache Flink code base and have a
> question.
>
> While reading the code, I found small inconsistencies in the way comments
> are written
> (highly irrelevant but still noticeable) such as some function argument
> comments ending in a period while others do not, among other minor
> irregularities.
>
> As an initial way to grasp how to contribute, I thought about opening a
> JIRA issue to contribute with corrections to a specific file.
> For example, I was looking at the
> org.apache.flink.runtime.executiongraph.Execution.java file.
>
> Is this sort of contribution acceptable and desirable, or would it be to
> much of a waste of time for the maintainers?
>
> Thanks for your time.
>
> Best regards,
>
> Miguel Coimbra
>