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

add key components #169

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

Smart-City-Muenster
Copy link

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.

@bfabio
Copy link
Contributor

bfabio commented Oct 5, 2023

@Smart-City-Muenster thanks, the proposal looks very promising

@yaml-9000 minor-change

@yaml-9000
Copy link

Thanks for your contribution 🙏

This is now marked as a minor-change proposal to the standard,
this means that old versions of publiccode.yml will still be valid with this change.

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 @yaml-9000 vote-start

cc @ruphy @publiccodeyml/steering-committee

📄 Voting procedure | 📄 Working Group Charter | 🤖 bot commands

@yaml-9000 yaml-9000 added standard-minor-change This change is backward compatible. It's a new feature. vote-draft Change proposal to the Standard or to the governance procedures labels Oct 5, 2023
Copy link
Member

@libremente libremente left a 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 Show resolved Hide resolved

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,
Copy link
Member

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?

Copy link
Contributor

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?

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 ;)

docs/standard/schema.core.rst Outdated Show resolved Hide resolved
@libremente
Copy link
Member

Just my 2 cents here.
After seeing the components key I am not 100% convinced that it conveys the meaning we are looking for (I know I originally proposed it back in the days but it still doesn't sound convincing...)
Should we look for other terms? I don't have many ideas, the only stuff I can think about is units or building-blocks but they are probably worse than the first proposal.

@bfabio
Copy link
Contributor

bfabio commented Mar 11, 2024

Just my 2 cents here. After seeing the components key I am not 100% convinced that it conveys the meaning we are looking for (I know I originally proposed it back in the days but it still doesn't sound convincing...) Should we look for other terms? I don't have many ideas, the only stuff I can think about is units or building-blocks but they are probably worse than the first proposal.

I don't mind the word components, what's not working for you with it?

Other alternatives like parts (sounds liks each part can't stand on its own), elements (kinda generic), modules (can have a technical meaning) and as you said, units or building-blocks sound less immediate or have specific connotations.

@bfabio
Copy link
Contributor

bfabio commented May 21, 2024

I think this needs more discussion, so it will skip this round of voting.

@Smart-City-Muenster
Copy link
Author

As for the discussion about the word components. From all alternatives, the word parts sounds best to me, maybe even better than components. I don't have the association that one part is able to run on it's own, but I'm not a native speaker ;)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
standard-minor-change This change is backward compatible. It's a new feature. vote-draft Change proposal to the Standard or to the governance procedures
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants