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

Update CONTRIBUTING.md #2698

Merged
merged 1 commit into from
Jul 23, 2024
Merged

Update CONTRIBUTING.md #2698

merged 1 commit into from
Jul 23, 2024

Conversation

michi-covalent
Copy link
Contributor

@michi-covalent michi-covalent commented Jul 18, 2024

Document that we are planning to merge Cilium CLI code into cilium/cilium repository.

Ref: cilium/design-cfps#9

@michi-covalent
Copy link
Contributor Author

cc @joestringer @aanm (i can't seem to @ cilium-maintainers team)

@joestringer
Copy link
Member

@cilium/cilium-maintainers

README.md Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the intent to change the user experience for this too? For instance, expect users to download from cilium/cilium, release on a different cadence?

@michi-covalent
Copy link
Contributor Author

Is the intent to change the user experience for this too? For instance, expect users to download from cilium/cilium, release on a different cadence?

the current proposal is to not change the user experience, at least in the short term. we'll continue to publish release artifacts in cilium/cilium-cli repo at its own release cadence independent of cilium/cilium release cycle:

https://github.com/cilium/design-cfps/blame/3b5b719b9fac007d2ea683b18aafe4b3cb62e1eb/cilium/CFP-25694-move-cilium-cli-to-cilium-repo.md#L77-L80

@joestringer
Copy link
Member

OK, the reason I ask is that this is placing the warning right at the top as the first thing that users see. This looks like a warning for users to get ready to change the way they pull the tool.

Developer-focused warnings should probably be lower down in the readme in a section that's clearly about how you contribute.

@michi-covalent
Copy link
Contributor Author

yeah makes sense. maybe i can update https://github.com/cilium/cilium-cli/blob/main/CONTRIBUTING.md instead 💭

@pchaigno
Copy link
Member

Is it expected that cilium/cli is also an owner for the README? That doesn't make much sense for me.

@michi-covalent
Copy link
Contributor Author

Is it expected that cilium/cli is also an owner for the README? That doesn't make much sense for me.

cilium/cli team is the default owner of this repo, so yeah i guess it is sort of expected https://github.com/cilium/cilium-cli/blob/main/CODEOWNERS#L17 do you have any particular team on your mind who should own README.md?

@pchaigno
Copy link
Member

cilium-cli-maintainers? 😁 Or we split cli into cilium-cli and cilium's CLIs.

@michi-covalent
Copy link
Contributor Author

Or we split cli into cilium-cli and cilium's CLIs.

this could be an option, i can go either way. maybe a good topic to bring up in the community meeting 💭 just as a reference cilium/cli team's responsibility is currently described as:

Provide user experience feedback on changes to Command-Line Interfaces.
These owners are a stand-in for the user community to bring a user
perspective to the review process. Consider how information is presented,
consistency of flags and options.

https://github.com/cilium/cilium/blob/4d0836b05cc25d19a2c767d5e508679e401c1d75/CODEOWNERS#L31-L35

@pchaigno
Copy link
Member

Yeah, so we at least can agree that the description doesn't match the current role of fallback for all of cilium-cli.

@joestringer
Copy link
Member

The reviewer group for CLI is currently documented as having a project-wide scope: https://docs.cilium.io/en/stable/contributing/development/reviewers_committers/review_process/#project-wide . We can of course revisit this and figure out if there is a better set of individuals who could take ownership of different components.

Document that we are planning to merge Cilium CLI code into
cilium/cilium repository.

Ref: cilium/design-cfps#9

Signed-off-by: Michi Mutsuzaki <[email protected]>
@michi-covalent
Copy link
Contributor Author

#2710 should reduce the noise to the cli team during the cilium-cli release process 🚀 🙏

@michi-covalent michi-covalent changed the title Update README.md Update CONTRIBUTING.md Jul 23, 2024
@michi-covalent michi-covalent merged commit 70ab5dc into main Jul 23, 2024
13 checks passed
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

Successfully merging this pull request may close these issues.

3 participants