common-domain-model icon indicating copy to clipboard operation
common-domain-model copied to clipboard

CDM Demonstation Repo

Open minesh-s-patel opened this issue 2 years ago • 5 comments

@finos/cdm-maintainers

The community has been asking for examples of how to implement the CDM. There are a vast number of use cases so it does not make sense to add them all to the main common-domain-model repo.

An example is this repo: https://github.com/minesh-s-patel/sec-lending-cdm-example. Having these demos will help users of the CDM understand its usage.

I propose we create a new GitHub repo called finos/common-domain-model-examples and document the demonstrations there.

Please give a 👍 if you like the idea.

minesh-s-patel avatar Aug 18 '23 15:08 minesh-s-patel

Quick questions on this:

  • Who maintains the samples when the model is updated? If the samples become out of step with the model then we run the risk of the samples actually becoming a hindrance rather than an asset.
  • Will the samples be under the same governance as the model itself i.e. who decides when a sample should be included in the new repo?
  • We already have a lot of samples in the model distribution. Will these be moved to the new repo?

I'm all for increasing the number of samples we have of CDM use cases and implementations. What I don't want is for this to become too much of an additional overhead.

Putting the samples into a separate repo means that we do not have to keep them in line with model versions, which means they will not impact release schedules (although even if they were in the same repo as the CDM we can still leave them as-is and not update them for a release). However, this also means we have the very real possibility that samples will stop working.

chrisisla avatar Aug 21 '23 08:08 chrisisla

My opinion would be:

  1. It's up to the contributors to maintain and update their demos when the model changes.
  2. There is no need for governance as it's already possible to create demos an post them in a new github repo without separate approval.
  3. I believe we can leave a small number of examples in the CDM that are part of the getting started documentation.

I also believe that we should consider moving other applications, not just demos, to separate repos, so as to limit the scope to the model and test cases, separate from specific applications.

tomhealey-icma avatar Aug 21 '23 12:08 tomhealey-icma

This repo will be under FINOS though as per the original request, which means that it should thus be maintained by the CDM maintainers... this also infers that the CDM maintainers should be responsible for maintaining the samples, thus my question on governance etc.

Happy to have lots of CDM samples out there, I just think that they should probably remain outside of FINOS and thus bear no relationship to the core CDM project and its governance/maintenance frameworks at all. There can be no confusion then about who owns them, who should be maintaining them, whether they should work etc etc etc

chrisisla avatar Aug 21 '23 12:08 chrisisla

I was also questioning the need for separate repo - but on reflection, making the CDM Repo as simple as possible and getting examples out of there would be helpful I think.

Re maintenance, I don't think we can get away from this being maintained by the CDM project team too (i.e. the code keepers). But we can lean on any demo providers to do the work to keep things updated. Governance should be limited to, it works, it is helpful to demonstrate the CDM's potential, and the contributor will keep updated! We should also agree to a limited set of examples/demos to begin with. Also, to begin with, the demos and applications are ones that the Trade Associations have built - so that should be "easier" to maintain. Also less is more, we only want a few basic things to start with as I said above.

[Another question (not for now and potentially a new issue - I can raise at later date) is should we build these demos stand them up on a FINOS hosted site to go with other marketing materials ("click here to use a date calculator based on CDM code" , "click here to create a CDM eligible collateral schedule")]

iansloyan avatar Aug 23 '23 08:08 iansloyan

Hi @minesh-s-patel Just wanted to check in and see if this issue can be moved under the Contribution Review WG project or if I can help move it towards closure. Please let me know. Thank you!

eteridvalishvili avatar Jan 16 '24 22:01 eteridvalishvili

Hi @minesh-s-patel Just wanted to check in and see if this issue can be moved under the Contribution Review WG project or if I can help move it towards closure. Please let me know. Thank you!

Not much traction on this topic. I will close and we can re-open if there is more interest.

minesh-s-patel avatar Jan 21 '25 21:01 minesh-s-patel