For visibility, we can have a link on both the beam.apache.org website and
in the core repository's README file.

Regarding testing *could* be a little trickier. Any unit test should
continue to live in the core repository, and the examples from the examples
repository could serve as end-to-end tests. This means the examples
repository also needs a testing infrastructure, which should be triggerable
from the root directory. Having it this way would allow us to have a test
in the core repository that clones the examples repository in a temporary
directory and runs the tests from there.

This way, users don't *need* to have the examples as a strict dependency,
but developers modifying the core repository will have both (just like it
is today).

On Wed, Aug 1, 2018 at 3:16 PM Charles Chen <c...@google.com> 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 <dcava...@google.com> 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
>> <https://docs.google.com/document/d/1vhcKJlP0qH1C7NZPDjohT2PUbOD-k71avv1CjEYapdw/edit?usp=sharing>
>> .
>>
>> Cheers,
>> David
>>
>

Reply via email to