blob: 4c95078a43061d101b5dbb03ed6966822903d273 [file] [log] [blame]
Ed Tanousceeba4f2022-05-16 14:59:33 -07001# Below lists the current bmcweb maintainers. bmcweb is used in a number of
2# different contexts, and is one of the few nearly-universally used core
3# components in OpenBMC. As such, given the severe consequences of mistakes
4# made within the codebase, maintainers on this list are expected to:
5# - Have a solid understanding of the bmcweb core code, and how it's used.
6#
7# - Have access to at least one upstream platform to test relevant patchsets.
8#
9# - Help to manage the orderly merging of patchsets onto master through review.
10# It is expected that bmcweb maintainers participate on a majority of code
11# reviews, and although maintainers may work with each other to segment the
12# responsibilities into sub-parts the codebase, it is expected that maintainers
13# should be capable of reviewing all code in all modules if the need arises.
14#
15# - Provide help in testing and triage of cross-platform issues that arise as a
16# result of merging new features.
17#
18# - Have an in-depth understanding of the Redfish standard, its constraints in
19# how it interacts with OpenBMC, and how the bmcweb implementation compares to
20# other Redfish instances and how changes effect compatibility with other
21# Redfish services compatibility.
22#
23# - Be capable of, and have a track record of posing questions, clarifications,
24# and specification changes to [DMTF](https://www.dmtf.org/standards/redfish)
25# for resources implemented within the Redfish standard. bmcweb maintainers
26# regularly attend the Redfish specification meetings to have a handle on
27# "intent" behind Redfish APIs. In many cases, the role of the maintainer
28# requires knowing when a Redfish resource is underspecified, and direct people
29# to the standard before their changes can be accepted.
30#
31# - Have an understanding of, and track record of executing the various test
32# harnesses that bmcweb needs to pass, listed in CLIENTS.md, and at least a
33# rudimentary understanding of their requirements, and limitations.
34#
35# - Have an understanding of DBus and the specific implementations of sdbusplus
36# APIs that bmcweb uses, and their limitations in versioning, consistency, and
37# general implementation completeness.
38#
39# - Join and answer questions of the #bmcweb-and-redfish channel within
40# discord.
41#
42# - Join and answer architecture queries posed to the mailing list concerning
43# bmcweb.
44#
45# - Be capable of responding to CVE queries forwarded from the
46# [openbmc-security-response-team]
47# (https://github.com/openbmc/docs/blob/master/security/obmc-security-response-team.md).
48# Considering that in most implementations of the OpenBMC security model,
49# bmcweb is the primary attacker/client facing application on the network, it
50# is expected that a number of potential CVEs will be posted, for which bmcweb
51# forms a component of the alleged attack. Maintainers should be prepared to
52# respond to such requests in the timeframe required by the CVE process, and
53# ideally should have a track record of doing it in the past.
54#
Gunnar Mills1d7c0f02023-06-29 13:47:28 -050055# - Understand webui-vue, that bmcweb can optionally host, its use cases, and
56# how they differ from "normal" client-based use cases, as well as an
57# understanding of hosting web services in general.
Ed Tanousceeba4f2022-05-16 14:59:33 -070058#
59# If you believe you meet the qualifications for the above, please open a
60# patchset, adding your name to the list below, documenting some evidence of
61# the above requirements being met, and the existing maintainers will happily
62# add you to the list.
63
Ed Tanouseaa96da2021-02-05 10:50:34 -080064owners:
65- ed@tanous.net
Gunnar Millsd50c69b2024-02-21 11:17:11 -060066- gunnar@gmills.xyz
Gunnar Mills6afb06d2021-12-01 13:39:09 -060067
Ed Tanousceeba4f2022-05-16 14:59:33 -070068
69# The below specifies a list of reviewers and interested parties that should be
70# included on code reviews to stay informed of progress.
71
Gunnar Mills6afb06d2021-12-01 13:39:09 -060072reviewers:
Nan Zhou01358542022-06-24 01:36:23 +000073- nanzhoumails@gmail.com
Ed Tanousb0d3a852022-06-28 08:35:47 -070074
75matchers:
76# unit tests
77- suffix: _test.cpp
78 owners:
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000079 - nanzhoumails@gmail.com
Ed Tanousb0d3a852022-06-28 08:35:47 -070080
81# Redfish schemas
Nan Zhoub4d71812022-08-18 20:13:10 +000082- exact: redfish-core/include/query.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000083 owners:
84 - nanzhoumails@gmail.com
Nan Zhoub4d71812022-08-18 20:13:10 +000085- exact: redfish-core/include/utils/query_param.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000086 owners:
87 - nanzhoumails@gmail.com
Ed Tanousb0d3a852022-06-28 08:35:47 -070088- exact: redfish-core/lib/certificate_service.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000089 owners:
90 - nanzhoumails@gmail.com
Nan Zhou3daf7272022-11-16 20:34:09 +000091- exact: redfish-core/lib/log_services.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000092 owners:
93 - nanzhoumails@gmail.com
Ed Tanousb0d3a852022-06-28 08:35:47 -070094- exact: redfish-core/lib/memory.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000095 owners:
96 - nanzhoumails@gmail.com
Ed Tanousb0d3a852022-06-28 08:35:47 -070097- exact: redfish-core/lib/sensors.hpp
Nan Zhoudf0c4ee2022-11-09 18:48:11 +000098 owners:
99 - nanzhoumails@gmail.com