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

publiccode.yml #3

Open
6543 opened this issue Apr 22, 2022 · 5 comments
Open

publiccode.yml #3

6543 opened this issue Apr 22, 2022 · 5 comments

Comments

@6543
Copy link

6543 commented Apr 22, 2022

https://publiccodeyml.readthedocs.io/en/latest/index.html

use an already existing format standart to represent&store information of repos/projects

https://github.com/publiccodeyml/publiccode.yml

@realaravinth
Copy link
Member

Thank you for sharing!

I would love to adopt an already existing schema for the Git-based synchronization mechanism for sharing indexed data, but there are a few roadblocks, mostly posed by mandatory fields which can't be automatically generated by starchart from repository metadata:

  1. platforms describes the platform the software will run on, which is hard to determine automatically by starchart.
  2. categories is mandatory is defined as the list of words used to describe the software. It may be derived from repository tags, but tags on forges are optional so starchart will be breaking the mandatory requirement.
  3. developmentStatus: concept, development, beta, etc. (see full list in link), are not possible to determine.
  4. softwareType is similar to platform but is more fine-grained, again, something that starchart can't auto-generate.
  5. description/[lang]/genericName
  6. description/[lang]/longDescription may be derived from repository description, but it is an optional field in forges
  7. description/[lang]/features mandatory per schema but not possible to auto generate
  8. legal/license hard to generate when repository doesn't contain a license file
  9. maintainance/type is hard to determine

There are other mandatory fields, which can't be generated too. So maybe, starchart can support a subset of the mandatory fields that are required by publiccodeyml. Thoughts?

@realaravinth
Copy link
Member

For your reference, a discussion regarding the file format and mechanism is already going on the forgefriends forum(on which forgeflux related discussions are also hosted). Would you be willing to sign up for the forum? There are people who don't use GitHub for privacy reasons, so it will be beneficial for them.

But I'm also willing to ferry your comments over to the forum thread, if you are unwilling to signup :)

@ruphy
Copy link

ruphy commented May 5, 2022

hello @realaravinth, speaking from @publiccodeyml here: we'd love do address these points if they are real blockers! feel free to pop by our discussion and open PRs, we have a 100% open governance model and would love to improve the format and make sure we could include more open source software in the list!

@realaravinth
Copy link
Member

Thanks for reaching out, @ruphy! I'll be sure to start a thread on the publiccodeyml issue tracker within the week.

@realaravinth
Copy link
Member

I started a thread here

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