Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feature request] score-implementation-sample repo template #57

Open
1 of 4 tasks
mathieu-benoit opened this issue Oct 18, 2024 · 6 comments
Open
1 of 4 tasks

[feature request] score-implementation-sample repo template #57

mathieu-benoit opened this issue Oct 18, 2024 · 6 comments
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mathieu-benoit
Copy link
Contributor

mathieu-benoit commented Oct 18, 2024

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

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:

@mathieu-benoit mathieu-benoit added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 18, 2024
@mathieu-benoit mathieu-benoit changed the title [feature request] score-implementation example [feature request] score-implementation repo template Oct 18, 2024
@payalkanyan
Copy link
Contributor

payalkanyan commented Oct 19, 2024

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 mathieu-benoit changed the title [feature request] score-implementation repo template [feature request] score-implementation-sample repo template Oct 19, 2024
@mathieu-benoit
Copy link
Contributor Author

mathieu-benoit commented Oct 19, 2024

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
Copy link
Contributor

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
Copy link
Contributor Author

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
Copy link
Contributor

payalkanyan commented Oct 24, 2024

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

@mathieu-benoit
Copy link
Contributor Author

mathieu-benoit commented Oct 24, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
Status: Todo
Development

No branches or pull requests

2 participants