community,wg,code-quality: establish working group code-quality (#333)

* create wg-code-quality Create wg charter and add sigs.yaml entry. Signed-off-by: Daniel Hiller <[email protected]> * wg,generate: update sig-list.md Signed-off-by: Daniel Hiller <[email protected]> * Apply suggestions from code review Co-authored-by: aburdenthehand <[email protected]> Signed-off-by: Daniel Hiller <[email protected]> --------- Signed-off-by: Daniel Hiller <[email protected]> Signed-off-by: Daniel Hiller <[email protected]> Co-authored-by: aburdenthehand <[email protected]>
kubevirt · Nov 20, 2024 · 640347a · 640347a
1 parent 3c7a366
commit 640347a
Show file tree

Hide file tree

Showing 3 changed files with 96 additions and 0 deletions.
diff --git a/sig-list.md b/sig-list.md
@@ -49,6 +49,7 @@ Each group's material is in its subdirectory in this project.
 |------|-----------|------------|---------|----------|
 |[S390x architecture working group](wg-arch-s390x/charter.md) |[wg-arch-s390x](https://github.com/kubevirt/kubevirt/labels/wg-arch-s390x) | <ol><li>[Jan Schintag](https://github.com/jschintag), IBM</li><li>[Cheryl Fillekes](https://github.com/cfilleke), IBM</li><li>[vamsikrishna-siddu](https://github.com/vamsikrishna-siddu), IBM</li></ol> | |<ul></ul> |
 |[ARM architecture working group](wg-arch-arm/charter.md) |[wg-arch-arm](https://github.com/kubevirt/kubevirt/labels/wg-arch-arm) | <ol><li>[Howard Zhang](https://github.com/zhlhahaha), ARM</li></ol> | |<ul></ul> |
+|[Code-Quality Working Group](wg-code-quality/charter.md) |[wg/code-quality](https://github.com/kubevirt/kubevirt/labels/wg/code-quality) | <ol><li>[Edward Haas](https://github.com/EdDev), Red Hat</li><li>[Itamar Holder](https://github.com/iholder101), Red Hat</li></ol> |[Slack](kubevirt-dev)<br/> [Mailing List](https://groups.google.com/forum/#!forum/kubevirt-dev) |<ul><li>KubeVirt Code-Quality Working Group meeting: [ Thu at 09:00 UTC (biweekly) ](https://zoom.us/j/93168599900)</li></ul> |
 
 
 

diff --git a/sigs.yaml b/sigs.yaml
@@ -309,6 +309,36 @@ workinggroups:
         - github: zhlhahaha
           name: "Howard Zhang"
           company: ARM
+    - dir: wg-code-quality
+      name: Code-Quality Working Group
+      mission_statement: |
+        The Code-Quality Working Group aims to create an inter-SIG process for identifying, agreeing on and addressing code quality issues
+      label: wg/code-quality
+      leadership:
+        chairs:
+        - github: EdDev
+          name: Edward Haas
+          company: Red Hat
+        - github: iholder101
+          name: Itamar Holder
+          company: Red Hat
+      meetings:
+      - description: KubeVirt Code-Quality Working Group meeting
+        day: Thu
+        time: "09:00"
+        tz: UTC
+        frequency: biweekly
+        url: https://zoom.us/j/93168599900
+        archive_url: https://docs.google.com/document/d/1fBgXan7AQ1LZOmQpNq38H11MmtfuWxOz9DPypyV9UL0/edit
+      contact:
+        slack: kubevirt-dev
+        mailing_list: https://groups.google.com/forum/#!forum/kubevirt-dev
+        teams:
+        - name: wg-code-quality
+          description: Code-Quality Working Group
+        liaison:
+          github: dhiller
+          name: "Daniel Hiller"
 usergroups:
     - dir: kubevirt-community
       name: KubeVirt Community

diff --git a/wg-code-quality/wg-charter.md b/wg-code-quality/wg-charter.md
@@ -0,0 +1,65 @@
+# WG Code-Quality Charter
+
+## Scope
+
+The Code-Quality Working Group has two goals:
+
+* (short-term) **focus on the improvement of code quality**
+* (long-term) **create an inter-SIG process for identifying, agreeing on and addressing code quality issues**
+
+The long-term goal is achieved when the process is implemented and executed as required.
+
+## In scope
+
+The main objective of this effort is to continuously improve the quality of the project codebase.
+
+With this in mind, there is a need to define a clear scope on which areas and through what means this can be accomplished.
+
+* Create and maintain code-quality guidelines, best practices and standards.
+* Assure distribution of knowledge in regard to code quality.
+  * This may include presentations, documentation, lectures, certifications, linters, etc.
+* Enforcement of selected standards via the following methods:
+  * Automation and active intervention in code reviews.
+  * Codebase infrastructure. E.g reusable libraries.
+* Management:
+  * Prioritizing tasks.
+  * Focusing on selected topics.
+* Monitoring and identification of code-quality issues.
+
+The WG will work on facilitating and managing the quality effort until enough tooling, documentation, code structure, reviewer and maintainer awareness is achieved.
+
+## Stakeholders
+
+### Special Interest Groups
+
+* All SIGs claiming code ownership and producing code, currently
+  * SIG Compute
+  * SIG Network
+  * SIG Storage
+* SIG CI
+  * automation purposes of code-quality measures
+
+### Roles and responsibilities
+
+#### Chairs [1]
+- @EdDev
+- @iholder101
+- @{vacant}
+
+#### Liaisons
+- @dhiller
+
+## Deliverables
+
+The inter-SIG process definition will be manifested in one or more documents that define the quality effort:
+* The tooling and documentation required
+* The code structure metrics to be established and how they will be implemented
+* How reviewer and maintainer awareness will be achieved
+
+Also those documents will include how and when effective measures are executed.
+
+## Timelines and Disbanding
+
+The WG will decide at a certain point that the basic goal is achieved - when there is good enough documentation, tooling and metrics about the targets described above available. In that case it can decide to disband itself.
+
+[1]: https://github.com/kubevirt/community/blob/main/membership_policy.md#working-group-wg-chair