You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@flink.apache.org by bowenli86 <gi...@git.apache.org> on 2018/02/20 19:12:25 UTC

[GitHub] flink pull request #5537: [FLINK-8719] add module description for flink-cont...

GitHub user bowenli86 opened a pull request:

    https://github.com/apache/flink/pull/5537

    [FLINK-8719] add module description for flink-contrib to clarify its purpose

    ## What is the purpose of the change
    
    flink-contrib currently doesn't have any clarification or description of its purpose, which confuses lots of developers. Adding clarification and module description
    
    ## Brief change log
    
    Adding clarification and module description which I borrowed from the PR description of https://github.com/apache/flink/pull/5523
    
    ## Verifying this change
    
    This change is a trivial rework / code cleanup without any test coverage.
    
    ## Does this pull request potentially affect one of the following parts:
    
    none
    
    ## Documentation
    
    none

You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/bowenli86/flink FLINK-8719

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/flink/pull/5537.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

    This closes #5537
    
----
commit aecfcdd6e776f2b885f4cb5288bcb1b27d4b23cd
Author: Bowen Li <bo...@...>
Date:   2018-02-20T19:04:43Z

    [FLINK-8719] add module description for flink-contrib to clarify its purpose

----


---

[GitHub] flink issue #5537: [FLINK-8719] add module description for flink-contrib to ...

Posted by StephanEwen <gi...@git.apache.org>.

Github user StephanEwen commented on the issue:

    https://github.com/apache/flink/pull/5537
  
    I think it is good to add such a text, but the `description` within the POM file is a bit hidden. I don't think anyone would really look there.
    
    How about adding a README.md file to the `flink-contrib` project instead?
    
    I would also try to phrase it a bit more positive ;-) Something like "This is a staging/incubating area for new modules while the community evaluates how they are received by users and whether there will be commitment to maintain them long term."


---

[GitHub] flink pull request #5537: [FLINK-8719] add README for flink-contrib to clari...

Posted by asfgit <gi...@git.apache.org>.

Github user asfgit closed the pull request at:

    https://github.com/apache/flink/pull/5537


---