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

proposal for new WG code-quality #327

Closed
dhiller opened this issue Sep 26, 2024 · 14 comments · Fixed by #333
Closed

proposal for new WG code-quality #327

dhiller opened this issue Sep 26, 2024 · 14 comments · Fixed by #333
Assignees

Comments

@dhiller
Copy link
Contributor

dhiller commented Sep 26, 2024

Is your feature request related to a problem? Please describe:
As pointed out in kubevirt/project-infra#3614 there's currently no public approachable group in existence related to code-quality 1

However, it would make sense to build such a group, since there obviously is an interest in the topic of code-quality, as there's 20+ issues and 400+ pull requests with that label (see query below). In general there's people required to steer that effort by making general decisions about topics long term goals and guidelines.

As discussed in the community meeting and on mentioned PR, it does not make sense to build a SIG. Also a committee does not have to operate in the open and has a closed membership.

Describe the solution you'd like:
The proposal 2 is to create a WG that has the goal of

  • short-term focus on the improvement of code quality and
  • long-term create an inter-SIG process for identifying, agreeing on and addressing code quality issues

Describe alternatives you've considered:
A clear and concise description of any alternative solutions or features you've considered.

Additional context:
References:

@iholder101
Copy link
Contributor

Thank you @dhiller! Looks good to me.

I think that such a committee might be a good alternative for the suggested yet controversial sig-api here: #296.

@EdDev
Copy link
Member

EdDev commented Sep 29, 2024

I think that such a committee might be a good alternative for the suggested yet controversial sig-api here: #296.

I disagree. That effort has nothing to do with code-quality and everything to do with having a good and stable formal API.

@EdDev
Copy link
Member

EdDev commented Sep 29, 2024

As discussed in the community meeting and on mentioned PR, it does neither make sense to build a SIG nor a WG on that matter.

Can you please summarize here what was the result of that discussion?
I agree that code-quality is not a SIG, but I do not understand why it is not a WG.

@iholder101
Copy link
Contributor

iholder101 commented Sep 30, 2024

I think that such a committee might be a good alternative for the suggested yet controversial sig-api here: #296.

I disagree. That effort has nothing to do with code-quality and everything to do with having a good and stable formal API.

I meant that IMO a committee is better to discuss good and stable API than a SIG.

@lyarwood
Copy link
Member

lyarwood commented Oct 2, 2024

Can you please summarize here what was the result of that discussion?
I agree that code-quality is not a SIG, but I do not understand why it is not a WG.

https://github.com/kubevirt/community/blob/main/GOVERNANCE.md#working-groups

Yeah also think this could be a WG as it's cross SIG etc.

It would be great to have an upstream group defined for this outside of the much appreciated but localised downstream group currently leading this effort!

@dhiller
Copy link
Contributor Author

dhiller commented Oct 2, 2024

Can you please summarize here what was the result of that discussion?
I agree that code-quality is not a SIG, but I do not understand why it is not a WG.

main/GOVERNANCE.md#working-groups

Yeah also think this could be a WG as it's cross SIG etc.

It would be great to have an upstream group defined for this outside of the much appreciated but localised downstream group currently leading this effort!

K8s WGs are time bound and will be disbanded after the goal has been achieved 1. To my understanding we want to follow what Kubernetes does.

Since improving code quality is an ongoing process, this contradicts with formation of WGs.

@dhiller
Copy link
Contributor Author

dhiller commented Oct 2, 2024

@dosu please explain what criterias for Kubernetes Working Groups are.

@lyarwood
Copy link
Member

lyarwood commented Oct 2, 2024

K8s WGs are time bound and will be disbanded after the goal has been achieved 1. To my understanding we want to follow what Kubernetes does.

Since improving code quality is an ongoing process, this contradicts with formation of WGs.

I appreciate that but by definition k8s committees also have closed membership and do not have to operate in the open.

I think a WG focused on the short term improvement of code quality and on defining a longer term inter-SIG process for identifying, agreeing on and addressing code quality issues is perfectly acceptable. Once such a process is in place the WG can disband and the SIGs can take over improving code quality within their respected parts of the codebase.

@dhiller
Copy link
Contributor Author

dhiller commented Oct 7, 2024

K8s WGs are time bound and will be disbanded after the goal has been achieved 1. To my understanding we want to follow what Kubernetes does.
Since improving code quality is an ongoing process, this contradicts with formation of WGs.

I appreciate that but by definition k8s committees also have closed membership and do not have to operate in the open.

I think a WG focused on the short term improvement of code quality and on defining a longer term inter-SIG process for identifying, agreeing on and addressing code quality issues is perfectly acceptable. Once such a process is in place the WG can disband and the SIGs can take over improving code quality within their respected parts of the codebase.

Makes sense.

@0xFelix @iholder101 @fossedihelm pinging you for awareness.

/assign

I'll take the task of creating a PR to propose something - or any other takers?

@dhiller dhiller changed the title proposal for new committee code-quality proposal for new WG code-quality Oct 7, 2024
@dhiller
Copy link
Contributor Author

dhiller commented Oct 7, 2024

@lyarwood updated the issue description, please chime in if you disagree

@lyarwood
Copy link
Member

lyarwood commented Oct 7, 2024

@lyarwood updated the issue description, please chime in if you disagree

That's excellent thanks @dhiller!

@iholder101
Copy link
Contributor

Thanks @dhiller and @lyarwood!

I'm not sure why a WG is better than a committee TBH, but I don't feel strongly about it.
I also still think that we should use a WG/committee for the "sig-api" effort.

@0xFelix
Copy link
Member

0xFelix commented Oct 8, 2024

@dhiller Looks good to me! Thanks

Will this WG have some sort of regular meetings or a channel / forum to discuss topics in? How should we organize it?

@dhiller
Copy link
Contributor Author

dhiller commented Oct 8, 2024

  • short-term focus on the improvement of code quality and
  • long-term create an inter-SIG process for identifying, agreeing on and addressing code quality issues

@0xFelix good point - I have added this as a topic to our community meeting agenda

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

Successfully merging a pull request may close this issue.

5 participants