blob: 06b46f7925f09bc7bb29a133615c48d5a989532b [file] [log] [blame]
Gunnar Millsde502e12018-08-15 12:31:14 -05001Maintainers
Brendan Higgins124203d2016-10-31 18:44:58 -07002===============================
3
Gunnar Millsde502e12018-08-15 12:31:14 -05004`MAINTAINERS` files list the maintainers and reviewers for each individual
5repository. The `MAINTAINERS` file is found within the root directory of the
6repository. This `MAINTAINERS` file is for the docs repository.
7
Brendan Higgins124203d2016-10-31 18:44:58 -07008How to use this list:
9 Find the most specific section entry (described below) that matches where
10 your change lives and add the reviewers (R) and maintainers (M) as
11 reviewers. You can use the same method to track down who knows a particular
12 code base best.
13
14 Your change/query may span multiple entries; that is okay.
15
16 If you do not find an entry that describes your request at all, someone
17 forgot to update this list; please at least file an issue or send an email
18 to a maintainer, but preferably you should just update this document.
19
20Description of section entries:
21
22 Section entries are structured according to the following scheme:
23
Brendan Higgins124203d2016-10-31 18:44:58 -070024 X: NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>
25 X: ...
26 .
27 .
28 .
29
Gunnar Millsef1e9942017-04-08 11:51:41 -050030 Where REPO_NAME is the name of the repository within the OpenBMC GitHub
Brendan Higgins124203d2016-10-31 18:44:58 -070031 organization; FILE_PATH is a file path within the repository, possibly with
32 wildcards; X is a tag of one of the following types:
33
34 M: Denotes maintainer; has fields NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>;
Gunnar Millsef1e9942017-04-08 11:51:41 -050035 if omitted from an entry, assume one of the maintainers from the
Brendan Higgins124203d2016-10-31 18:44:58 -070036 MAINTAINERS entry.
37 R: Denotes reviewer; has fields NAME <EMAIL_USERNAME@DOMAIN> <IRC_USERNAME!>;
38 these people are to be added as reviewers for a change matching the repo
39 path.
Gunnar Millsef1e9942017-04-08 11:51:41 -050040 F: Denotes forked from an external repository; has fields URL.
Brendan Higgins124203d2016-10-31 18:44:58 -070041
42 Line comments are to be denoted "# SOME COMMENT" (typical shell style
43 comment); it is important to follow the correct syntax and semantics as we
44 may want to use automated tools with this file in the future.
45
Gunnar Millsde502e12018-08-15 12:31:14 -050046 A change cannot be added to an OpenBMC repository without a MAINTAINER's
Brendan Higgins124203d2016-10-31 18:44:58 -070047 approval; thus, a MAINTAINER should always be listed as a reviewer.
48
49START OF MAINTAINERS LIST
50-------------------------
51
Gunnar Millsd2227402018-01-04 13:43:49 -060052M: Brad Bishop <bradleyb@fuzziesquirrel.com> <radsquirrel!>
53M: Gunnar Mills <gmills@us.ibm.com> <gmills!>
Brendan Higgins124203d2016-10-31 18:44:58 -070054R: Adriana Kobylak <anoo@us.ibm.com> <anoo!>
55R: Andrew Jeffery <andrew@aj.id.au> <amboar!>