Ed Tanous | ceeba4f | 2022-05-16 14:59:33 -0700 | [diff] [blame] | 1 | # 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 Mills | 1d7c0f0 | 2023-06-29 13:47:28 -0500 | [diff] [blame] | 55 | # - 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 Tanous | ceeba4f | 2022-05-16 14:59:33 -0700 | [diff] [blame] | 58 | # |
| 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 Tanous | eaa96da | 2021-02-05 10:50:34 -0800 | [diff] [blame] | 64 | owners: |
| 65 | - ed@tanous.net |
Gunnar Mills | d50c69b | 2024-02-21 11:17:11 -0600 | [diff] [blame] | 66 | - gunnar@gmills.xyz |
Gunnar Mills | 6afb06d | 2021-12-01 13:39:09 -0600 | [diff] [blame] | 67 | |
Ed Tanous | ceeba4f | 2022-05-16 14:59:33 -0700 | [diff] [blame] | 68 | |
| 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 Mills | 6afb06d | 2021-12-01 13:39:09 -0600 | [diff] [blame] | 72 | reviewers: |
Nan Zhou | 0135854 | 2022-06-24 01:36:23 +0000 | [diff] [blame] | 73 | - nanzhoumails@gmail.com |
Ed Tanous | b0d3a85 | 2022-06-28 08:35:47 -0700 | [diff] [blame] | 74 | |
| 75 | matchers: |
| 76 | # unit tests |
| 77 | - suffix: _test.cpp |
| 78 | owners: |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 79 | - nanzhoumails@gmail.com |
Ed Tanous | b0d3a85 | 2022-06-28 08:35:47 -0700 | [diff] [blame] | 80 | |
| 81 | # Redfish schemas |
Nan Zhou | b4d7181 | 2022-08-18 20:13:10 +0000 | [diff] [blame] | 82 | - exact: redfish-core/include/query.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 83 | owners: |
| 84 | - nanzhoumails@gmail.com |
Nan Zhou | b4d7181 | 2022-08-18 20:13:10 +0000 | [diff] [blame] | 85 | - exact: redfish-core/include/utils/query_param.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 86 | owners: |
| 87 | - nanzhoumails@gmail.com |
Ed Tanous | b0d3a85 | 2022-06-28 08:35:47 -0700 | [diff] [blame] | 88 | - exact: redfish-core/lib/certificate_service.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 89 | owners: |
| 90 | - nanzhoumails@gmail.com |
Nan Zhou | 3daf727 | 2022-11-16 20:34:09 +0000 | [diff] [blame] | 91 | - exact: redfish-core/lib/log_services.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 92 | owners: |
| 93 | - nanzhoumails@gmail.com |
Ed Tanous | b0d3a85 | 2022-06-28 08:35:47 -0700 | [diff] [blame] | 94 | - exact: redfish-core/lib/memory.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 95 | owners: |
| 96 | - nanzhoumails@gmail.com |
Ed Tanous | b0d3a85 | 2022-06-28 08:35:47 -0700 | [diff] [blame] | 97 | - exact: redfish-core/lib/sensors.hpp |
Nan Zhou | df0c4ee | 2022-11-09 18:48:11 +0000 | [diff] [blame] | 98 | owners: |
| 99 | - nanzhoumails@gmail.com |