From 1b55e4b4d89722aa10a5bd47ff87ecd986baee01 Mon Sep 17 00:00:00 2001 From: Jay Faulkner Date: Wed, 8 Nov 2023 11:53:03 -0800 Subject: [PATCH] Document new bug deputy role for Ironic Attempt to create new bug deputy role; because triaging bugs is important! Change-Id: Ie11ec93a0f3a3a22d7ffb08c90107522ca1a0a7e --- doc/source/contributor/bug-deputy.rst | 85 +++++++++++++++++++++++++++ doc/source/contributor/index.rst | 1 + 2 files changed, 86 insertions(+) create mode 100644 doc/source/contributor/bug-deputy.rst diff --git a/doc/source/contributor/bug-deputy.rst b/doc/source/contributor/bug-deputy.rst new file mode 100644 index 0000000000..57bff71e11 --- /dev/null +++ b/doc/source/contributor/bug-deputy.rst @@ -0,0 +1,85 @@ +Bug Deputy Guide +================ + +Ironic has a rotating bug deputy role with assigned responsibilities around +ensuring recurring project maintenance occurs, with a specific focus on bug +triage. + +It is the intent that the time commitment of an upstream bug deputy be no more +than two to four hours a week on average. + +Schedule +-------- +Typically, a bug deputy will serve for a one week period, with the Ironic +meeting marking the beginning and end of the term. + +A bug deputy schedule will be built at the beginning of the OpenStack release +cycle and populated by project volunteers. Contributors can select weeks to +volunteer for stints as bug deputy. + +If there are insufficient volunteers, to cover a majority of weeks, the bug +deputy program will be cancelled. + +Responsibilities +---------------- + +Bug Triage +^^^^^^^^^^ +Triage bugs opened in any Ironic project. + +All Ironic project bugtrackers, filtered and sorted for triage: + +* `ironic `_ +* `ironic-inspector `_ +* `ironic-python-agent `_ +* `ironic-lib `_ +* `bifrost `_ +* `ironic-prometheus-exporter `_ +* `ironic-python-agent-builder `_ +* `ironic-ui `_ +* `metalsmith `_ +* `molteniron `_ +* `networking-baremetal `_ +* `networking-generic-switch `_ +* `python-ironic-inspector-client `_ +* `python-ironicclient `_ +* `sushy `_ +* `sushy-tools `_ +* `tenks `_ +* `virtualbmc `_ + +Bug Bash +^^^^^^^^ +A bug bash is an informal, synchronous meeting to triage bugs. A bug deputy +runs one per week at a time and in a format convenient for them. + +The selected time and venue for this should be announced on the mailing list +and at the Ironic meeting when the bug deputy position is handed over. + +.. note:: + Bug bashes may be discontinued when the backlog of old, untriaged bugs have + been worked through. + +Review Periodic Stable CI Jobs +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The bug deputy is responsible for reviewing the periodic stable CI jobs once +during their week and notifying the community if one fails for a new, +non-random reason. The bug deputy should also be prepared to help debug the +issue, but is ultimately only responsible for documenting it. + +* `Periodic Zuul build failures for Ironic/IPA/Ironic-Prom-Exp/Bifrost `_ +* `Periodic Zuul build failures for Ironic UI/NBM/NGS `_ +* `Periodic Zuul build failures for inspector-client/sushy/sushy-tools/vbmc/vpdu/ `_ + +As of this writing, no other projects under Ironic governance run periodic +jobs. + +Weekly Report +^^^^^^^^^^^^^ +Once a week, at the end of the bug deputy's term, they should deliver a report +to the Ironic meeting and the mailing list. This report should include any +concerning bugs or CI breakages, as well as any other issues that the bug +deputy feels the community needs to know about. + +For contributors who do not wish to attend the weekly meeting, a small written +report in the meeting agenda is sufficient. diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index 4e41642180..2b969d1c04 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -14,6 +14,7 @@ project. Bare Metal Community Developer Contribution Guide Bugs Reporting and Triaging Guide + Bug Deputy Guide Setting Up Your Development Environment Priorities Specifications