Skip to content

Commit

Permalink
create wg-code-quality
Browse files Browse the repository at this point in the history
Create wg charter and add sigs.yaml entry.

Signed-off-by: Daniel Hiller <[email protected]>
  • Loading branch information
dhiller committed Nov 7, 2024
1 parent efe7e38 commit e48948a
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 0 deletions.
30 changes: 30 additions & 0 deletions sigs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,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
Expand Down
64 changes: 64 additions & 0 deletions wg-code-quality/wg-charter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# WG Code-Quality Charter

## Scope

The Code-Quality Working Group has two goals:

* (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**

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.
* Through automation and active intervention in code reviews.
* Through 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 and
* SIG Storage
* sig-ci
* automation purposes of code-quality measures

### Roles and responsibilities

#### Chairs [1]
- @EdDev
- @iholder101

#### Liaisons
- @dhiller

## Deliverables

The inter-SIG process definition will be manifested in one or more documents that define the quality effort:
* what tooling and what documentation is required,
* what metrics for code structure should be established and how it 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

0 comments on commit e48948a

Please sign in to comment.