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

Re: Community Examples Repository

it makes sense to modularize

It certainly does, but somebody just had another proposal to move the website into the main repository ;-). That proposal was also good for ~everyone. Fun times...

(I have my opinions, of course, but I'm fine with any approach.)

On Wed, Aug 1, 2018 at 4:37 PM, Ahmet Altay <altay@xxxxxxxxxx> wrote:
Thank you for this initiative.

How about keeping a set of core examples in the main repository as a way of 1) convenient testing at a PR level 2) Testing with end to end tests against Beam head rather than a released Beam version 3) I think there is some educational value in having wordcount as a simple example living along with the code.

For anything else examples repository would be a great idea.

For testing, I would also like to understand how could we test examples against both released versions of Beam and the code currently being developed in master.


On Wed, Aug 1, 2018 at 3:36 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.