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

Re: Community Examples Repository

Looks good to me. This also sounds like a great way to ensure we aren't making breaking changes to the API surface of Beam across releases. I've been told this is a painful thing we frequently do. Hopefully we can run tests on these external examples against various versions of Beam.


On Wed, Aug 1, 2018, 3:37 PM Jesse Anderson <jesse@xxxxxxxxxxxxxxxxxxx> wrote:
The examples have to be separate from the main beam repository. This way, they serve as an example of how to use them in your code instead of how to do it as part of Beam. It would also you to show the dependencies in sbt or Maven. 

On Wed, Aug 1, 2018, 3:16 PM Charles Chen <ccy@xxxxxxxxxx> wrote:
The examples we have right now serve both as examples to users and along with their unit tests, as tests of functionality.  If we move the examples out, what is a good way to make sure that we continue to have visibility and test coverage?  Can we address this in a section of the doc?

On Wed, Aug 1, 2018 at 3:12 PM David Cavazos <dcavazos@xxxxxxxxxx> wrote:
Hi everyone!

We wanted to migrate the examples from the core repository to a new Beam community examples repository. As the number of examples grow, it makes sense to modularize and decouple the core functionality from the examples.

We will also create some guidelines with the best practices for new examples to be submitted.

For more details, feel free to take a look and comment on the proposal.