diff --git a/sigs.yaml b/sigs.yaml index 661f3fa0..6fcb1e6c 100644 --- a/sigs.yaml +++ b/sigs.yaml @@ -289,6 +289,33 @@ 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 + 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 new file mode 100644 index 00000000..2081878e --- /dev/null +++ b/wg-code-quality/wg-charter.md @@ -0,0 +1,59 @@ +# 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 therefore work on processes through which the above goals can be 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 +- @your-github-handle-2 + +#### Liaisons +- @dhiller + +## Deliverables + +The inter-SIG process definition will be manifested in one or more documents that define processes or other means, also how and when these 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 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 \ No newline at end of file