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

Explicit statement on sub-project scoping #46

Open
shizhMSFT opened this issue Mar 16, 2023 · 4 comments
Open

Explicit statement on sub-project scoping #46

shizhMSFT opened this issue Mar 16, 2023 · 4 comments

Comments

@shizhMSFT
Copy link
Contributor

shizhMSFT commented Mar 16, 2023

The question about scope of each sub-project continues to come up. I'm suggesting the readme can define the scope:
"The oras-dotnet repo is scoped at implementing a dotnet version of ORAS functionality. "

The interesting thing that came up with the oras-py implementation is whether each library is following an implementation of a common spec? What's the reference for each library?
For now, It's probably ok to just say the above.

Originally posted by @SteveLasker in oras-project/oras-dotnet#2 (comment)

@shizhMSFT
Copy link
Contributor Author

Do we need to have the following explicit statement for all repositories matching the pattern oras-<language>?

The oras-<language> repo is scoped at implementing a <language> version of ORAS library functionality.

I think it is redundant to have the explicit statement since the project name "ORAS <language> library" already states it is an oras library for a particular programming language.

@shizhMSFT
Copy link
Contributor Author

The interesting thing that came up with the oras-py implementation is whether each library is following an implementation of a common spec?

All ORAS libraries should follow https://oras.land/client_libraries/.
Since libraries are language specific, we can only have common high-level designs.

What's the reference for each library?

Since libraries are language specific, references will be available on the language specific website. A link should be added to the README.md correspondingly. Language specific tutorials should be updated to https://oras.land/.

@SteveLasker
Copy link
Contributor

Thanks @shizhMSFT for opening this.
I agree, for the language libraries, the scope is fairly defined. WIthout a specific spec, common across all libraries, we need some reference. If https://oras.land/client_libraries/ is the reference, that's great to call out. This way, someone wanting to implement a library will know the target.

For other sub-projects may be a bit broader, or different. Having each sub-project define it's scope is goal. Not too much, not too little, juuuust right.

@TerryHowe
Copy link
Member

Just a paragraph in the README with goals/non-goals maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants