[feature request] score-implementation-sample repo template

[mathieu-benoit]

To create a new Score implementation, we have this today:

• https://github.com/score-spec/score-go?tab=readme-ov-file#parsing-score-files
• "How to write a new Score implementation?" doc docs#122
• And yes we say that score-compose is the reference, but could we do more simple and helpful than that?

We could do better. Let's create an actual new repo score-implementation-sample in Go, actually having all the needed commands, functions, templates, etc. that anyone can use as template to get up to speed to write their own implementation.

We could start small and go with iteration:

• Create the repo --> score-implementation-sample
• Document the approach and the guidance --> let's have this tackled in "How to write a new Score implementation?" doc docs#122
• Have a minimal go setup, functions, go packages, container, etc. --> in https://github.com/score-spec/score-implementation-sample
• ...

Rough idea of what could this sample implementation example:

• Commands:
  • init
  • generate
  • resources
  • check-version
  • completion?
• State
• Reading Score
• dummy echo provisioners (stateless)
• manifests generated --> output will be the Score file

[payalkanyan]

Hello @mathieu-benoit,
After reviewing The provided links and your detail explanation of the issue. It seems to me that there is a requirement to establish a new repository under score-spec, specifically for a tutorial or documentation. This repository would also include practical implementation examples starting from basic examples referring this showcasing the diverse uses of the commands. Please correct me if my understanding is not accurate.

[mathieu-benoit]

Thanks for asking for clarifications on this one, @payalkanyan.

I would summarize this like this:

1. Create a new doc in https://docs.score.dev/docs/ like described here "How to write a new Score implementation?" doc docs#122.
2. Build a practical example/sample in this newly created repo: https://github.com/score-spec/score-implementation-sample
3. Update the doc in 1. with this concrete implementation
4. Ultimately, this new repo could be used as a GitHub repository template in order speed up the process of creating new Score implementation

I just updated the description of this issue accordingly.

Hope that helps?

[payalkanyan]

Thank you so much for your clear and concise explanation, @mathieu-benoit. I now fully understand what is required and am eager to contribute. To ensure efficiency and prevent any overlap in efforts, could I kindly request that you assign this issue to me? This way, we can avoid any confusion and duplicate work.

[mathieu-benoit]

Sure thing, @payalkanyan, feel free to ask questions if you need clarification, and share updates as it will involve multiple PRs/iterations ;) Thanks for your help!

[payalkanyan]

@mathieu-benoit Hey I have tagged you on CNCF slack score-dev channel. Can you please answer it there.

[mathieu-benoit]

Hi @payalkanyan, we understand that it's not enough information at this stage with what was already provided, so please hold on on this one for now, because we have to refine it and provide more presecriptive guidance... stay tuned in the near future, I don't know yet when to set the expectation.

[mathieu-benoit]

So, we now have the first version of the score-implementation-sample here score-spec/score-implementation-sample#1 that anyone can start with to create their own Score implementation.

It was needed to have one of the core maintainer to write this down, thanks @astromechza for tackling this!

Closing this one now.