search

artiso-solutions / CoVoX

MIT License
1 stars 1 forks source link

Repo restructure #72

Closed tommasobertoni closed 3 years ago

tommasobertoni commented 3 years ago

Closes #60.

Repo looks like this:

image

do we want to move poc somewhere else, or is it fine like this? @antonio8101 @kczornik

antonio8101 commented 3 years ago

I'm pretty fine with the overall repo structure.. But I found the 3 folders (repo, samples, scenarios) maybe can be grouped together..

tommasobertoni commented 3 years ago

I'm pretty fine with the overall repo structure.. But I found the 3 folders (repo, samples, scenarios) maybe can be grouped together..

Yes I though about that, but I didn't like them as-is, because it would create the following structure:

samples/

  Samples.sln
  WpfDemo/

  poc/
    Poc.sln
    ...

  scenarios/
    Scenarios.sln
    ..

Samples.sln is not referencing the projects of poc and scenario.

Can we find a grouping for those?

???/
  samples/
  scenarios/
  poc/

or

samples/
  ???/
  scenarios/
  poc/

@antonio8101 @kczornik

antonio8101 commented 3 years ago

I'm pretty fine with the overall repo structure.. But I found the 3 folders (repo, samples, scenarios) maybe can be grouped together..

Yes I though about that, but I didn't like them as-is, because it would create the following structure:

samples/

  Samples.sln
  WpfDemo/

  poc/
    Poc.sln
    ...

  scenarios/
    Scenarios.sln
    ..

Samples.sln is not referencing the projects of poc and scenario.

Can we find a grouping for those?

???/
  samples/
  scenarios/
  poc/

or

samples/
  ???/
  scenarios/
  poc/

@antonio8101 @kczornik

Are really the samples (as defined now) different from scenarios or poc? Maybe our samples can be set in the scenarios group.. And We can also document them in the main README.md..

tommasobertoni commented 3 years ago

scenarios show implementations of the Use case scenarios. poc refers to the research that we did on the sdk, not much interesting for a consumer of the library. samples are everything else, like: platform (e.g. WPF), API showcase (e.g. typed-commands, state-machine).

antonio8101 commented 3 years ago

scenarios show implementations of the Use case scenarios. poc refers to the research that we did on the sdk, not much interesting for a consumer of the library. samples are everything else, like: platform (e.g. WPF), API showcase (e.g. typed-commands, state-machine).

Is samples expected to grow? And How? Are they really like poc or scenarios (some of the samples will be defined as use case scenario so will be put in that folder, some other will be defined as poc, because just implementation made for research and/or showcase something..

tommasobertoni commented 3 years ago

Imo a sample is a showcase of the APIs, while a scenario shows a general environment/use case where Covox can be used. poc is mainly for internal usage, since is where we show what we learned as a pre-dev phase.

samples will increase in number, scenarios only if we identify a new general use case that needs to be documented, poc will follow our research.