-
Notifications
You must be signed in to change notification settings - Fork 39
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
add key components #169
base: main
Are you sure you want to change the base?
add key components #169
Conversation
@Smart-City-Muenster thanks, the proposal looks very promising @yaml-9000 minor-change |
Thanks for your contribution 🙏 This is now marked as a Example of minor changes are additions of new keys or making keys optional. The Chair will eventually pick up this proposal and start the voting procedure using cc @ruphy @publiccodeyml/steering-committee 📄 Voting procedure | 📄 Working Group Charter | 🤖 bot commands |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few comments by my side, thanks for the effort @Smart-City-Muenster!!
docs/standard/schema.core.rst
Outdated
|
||
Some software projects are organized in more than one repository. | ||
In addition to the key ``url``, this key gives you an option to specify | ||
more than one URL to further relevant repositories. If you use the key, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would spend a few words here to specify what a "relevant repository" is. I mean, can they be random repos spread all over the Internet or they have to respect some sort of pattern, like e.g., /sameUrlOrg/repo1
, /sameUrlOrg/repo2
etc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed on expanding what we expect this key to be used for, with a couple of examples.
IMO we should state that components
should be parts of the same project / sofware, but not related software in general. So, for example, the frontend, backend and apps of Google Maps can be components
in the Google Maps publiccode.yml
, but Google Assistant should not.
I think they should point wherever the components are, even on other orgs or forges. Typically that should not be the case, but I don't see a reason to not allow it.
Should we also explicitly mention guidance about plugins? Should they be components
? Probably not if they're not essential to run the software.
WDYT @Smart-City-Muenster, @libremente?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi there,
I've just pushed a small addition that specifies what repositories should go into "components".
I was reluctant to explicitly mention plugins, because I do not necessarily see harm in seeing a plugins-repo in this field, although I also do not want to encourage people to add it there ;)
Just my 2 cents here. |
I don't mind the word Other alternatives like |
I think this needs more discussion, so it will skip this round of voting. |
As for the discussion about the word |
This is a follow-up to #62.
I just changed two files in the
standard
folder. Let me know, if I neet to change any other files or if I should do something more.