Skip to content

Commit f00b0a4

Browse files
unicornxRbb666
authored andcommitted
MAINTAINER: standardize tag writing
Update the tag writing requirements in the Note. It is recommended that the tag name directly refer to the module path in the code tree. For example, if the module path is 'bsp/cvitek', then the tag name should be 'bsp_cvitek'. And the name should be lowercase. According to the above rules, the tag name of the existing entries are adjusted. Other changes remain unchanged. Other text modifications are mainly to limit the width of each line, try not to exceed 80 columns. Signed-off-by: Chen Wang <[email protected]>
1 parent 74a1e4f commit f00b0a4

File tree

1 file changed

+70
-49
lines changed

1 file changed

+70
-49
lines changed

MAINTAINERS

Lines changed: 70 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -2,23 +2,33 @@
22
#
33
# This file manages the maintainers and their associated sections in the repository.
44
# Developers should update this file according to project needs.
5-
# The following are explanations of each field and guidelines for adding new maintainer entries.
5+
# The following are explanations of each field and guidelines for adding new
6+
# maintainer entries.
67
#
78
# When adding new entries, please follow the format:
89
#
9-
# 1. **tag** - Assign a unique tag to each entry for identifying the code module or functionality.
10+
# 1. **tag** - Assign a unique tag to each entry for identifying the code module
11+
# or functionality.
1012
# - The tag should be concise and descriptive, such as `workflow`, `libc`...
11-
# - **Rule for Adding**: Use a new tag when adding a new functionality or module to ensure it clearly describes the area of responsibility.
13+
# - **Rule for Adding**: Use a new tag when adding a new functionality or
14+
# module to ensure it clearly describes the area of responsibility.
1215
#
1316
# 2. **path** - Specify the directory or file path that the maintainer is responsible for.
14-
# - The path must be relative to the repository's root directory and can refer to either a single file or a folder.
15-
# - If the maintainer is responsible for all files in a directory, use the directory path; if it's for a specific file, provide the full file path.
16-
# - **Rule for Adding**: Ensure that the path correctly points to the relevant code location. Please note that a tag should correspond to only one path. Currently, multiple paths are not supported.
17+
# - The path must be relative to the repository's root directory and can
18+
# refer to either a single file or a folder.
19+
# - If the maintainer is responsible for all files in a directory, use the
20+
# directory path; if it's for a specific file, provide the full file path.
21+
# - **Rule for Adding**: Ensure that the path correctly points to the relevant
22+
# code location. Please note that a tag should correspond to only one path.
23+
# Currently, multiple paths are not supported.
1724
#
18-
# 3. **owners** - List the maintainers responsible for the section, including their GitHub usernames and contact information.
19-
# - The owners should be listed as a comma-separated list if there are multiple maintainers.
25+
# 3. **owners** - List the maintainers responsible for the section, including
26+
# their GitHub usernames and contact information.
27+
# - The owners should be listed as a comma-separated list if there are multiple
28+
# maintainers.
2029
# - Format: `Name(GitHub username)<email address>`.
21-
# - **Rule for Adding**: Ensure that the listed GitHub usernames are correct, and the maintainers are aware of their responsibilities and duties.
30+
# - **Rule for Adding**: Ensure that the listed GitHub usernames are correct,
31+
# and the maintainers are aware of their responsibilities and duties.
2232
#
2333
# Example: How to Add a Maintainer Entry
2434
#
@@ -31,28 +41,40 @@
3141
# When adding entries, please follow these guidelines:
3242
# - Ensure the `tag` is unique and descriptive.
3343
# - Ensure the `path` points to the correct location in the repository.
34-
# - Ensure the `owners` are accurate and that all new maintainers are aware of their responsibilities.
44+
# - Ensure the `owners` are accurate and that all new maintainers are aware of
45+
# their responsibilities.
3546
#
3647
# Example Entry:
3748
# tag: example-module
3849
# path: example/module/path
3950
# owners: John Doe(johndoe)<[email protected]>, Jane Smith(janesmith)<[email protected]>
4051

4152
# Note:
42-
# - Each entry includes a `tag` that identifies the module or functionality, a `path` that points to the relevant code location, and `owners` who are the maintainers for that part of the codebase.
43-
# - If there are multiple entries, each entry should be separated by a blank line. Within a single entry, there is no need to insert blank lines between the tag, path, and owners.
53+
# - Each entry includes a `tag` that identifies the module or functionality, a
54+
# `path` that points to the relevant code location, and `owners` who are the
55+
# maintainers for that part of the codebase.
56+
#
57+
# - If there are multiple entries, each entry should be separated by a blank line.
58+
# Within a single entry, there is no need to insert blank lines between the
59+
# tag, path, and owners.
60+
#
4461
# - Each entry must be sorted in alphabetical order with tag as the keyword.
62+
# It is recommended that the tag naming method follow the directory path in
63+
# the code tree. For example, if the entry path is 'bsp/cvitek', then the tag
64+
# name is 'bsp_cvitek'. It is recommended to use all lowercase letters and not
65+
# mix uppercase and lowercase letters.
4566

4667
# Below are existing maintainer entries, divided by module:
4768

48-
tag: at
49-
path: components/net/at
50-
owners: Chen Beidou(Ryan-CW-Code)<[email protected]>, lizhen9880(lizhen9880)<[email protected]>
51-
5269
tag: bsp_cvitek
5370
path: bsp/cvitek
5471
owners: Chen Wang(unicornx)<[email protected]>
5572

73+
tag: bsp_esp32_c3
74+
path: bsp/ESP32_C3/builtin_imgs
75+
path: bsp/ESP32_C3/drivers
76+
owners: Damoshed_Xu(xu18838022837)<[email protected]>
77+
5678
tag: bsp_gd32105c-eval
5779
path: bsp/gd32/arm/gd32105c-eval
5880
owners: Xiansong Cao(CXSforHPU)<[email protected]>
@@ -97,11 +119,6 @@ tag: bsp_ultrarisc
97119
path: bsp/ultrarisc/ur_dp1000_evb
98120
owners: Zhang Jing(zhangjing0303)<[email protected]>
99121

100-
tag: bsp_ESP32_C3
101-
path: bsp/ESP32_C3/builtin_imgs
102-
path: bsp/ESP32_C3/drivers
103-
owners: Damoshed_Xu(xu18838022837)<[email protected]>
104-
105122
tag: bsp_renesas
106123
path: bsp/renesas
107124
owners: Yuqiang Wang(kurisaW)<[email protected]>
@@ -150,59 +167,63 @@ tag: components
150167
path: components
151168
owners: Huanyi Mai(Maihuanyi)<[email protected]>
152169

153-
tag: documentation
154-
path: documentation
155-
owners: Chen Wang(unicornx)<[email protected]>, Guorui Li(GorrayLi)<[email protected]>, Lian Wang(lianux-mm)<[email protected]>, Xiansong Cao(CXSforHPU)<[email protected]>
156-
157-
tag: driver_can
170+
tag: components_driver_can
158171
path: components/drivers/can
159172
owners: Liya Huang(wdfk-prog)<[email protected]>
160173

161-
tag: driver_i2c
174+
tag: components_driver_i2c
162175
path: components/drivers/i2c
163176
owners: Liya Huang(wdfk-prog)<[email protected]>
164177

165-
tag: driver_pm
178+
tag: components_driver_pm
166179
path: components/drivers/pm
167180
owners: Liya Huang(wdfk-prog)<[email protected]>
168181

169-
tag: driver_spi
182+
tag: components_driver_serial_v2
183+
path: components/drivers/serial/dev_serial_v2.c
184+
path: components/drivers/include/drivers/dev_serial_v2.h
185+
path: examples/utest/testcases/drivers/serial_v2
186+
owners: Chen Beidou(Ryan-CW-Code)<[email protected]>
187+
188+
tag: components_driver_spi
170189
path: components/drivers/spi
171190
owners: Liya Huang(wdfk-prog)<[email protected]>, Liang He(Liang1795)<[email protected]>
172191

173-
tag: driver_ymodem
174-
path: components/utilities/ymodem
175-
owners: Liya Huang(wdfk-prog)<[email protected]>
176-
177-
tag: fal
192+
tag: components_fal
178193
path: components/fal
179194
owners: Yucai Liu(illustriousness)<[email protected]>
180195

181-
tag: kernel
182-
path: src
183-
owners: Damoshed_Xu(xu18838022837)<[email protected]>, Guorui Li(GorrayLi)<[email protected]>, Han Lv(hamburger-os)<[email protected]>, Lian Wang(lianux-mm)<[email protected]>, Liya Huang(wdfk-prog)<[email protected]>, Xiaowei Swenson(ReviewSun)<[email protected]>
184-
185-
tag: libc
196+
tag: components_libc
186197
path: components/libc
187198
owners: Meco Jianting Man(mysterywolf)<[email protected]>, Guorui Li(GorrayLi)<[email protected]>
188199

189-
tag: lwp
200+
tag: components_lwp
190201
path: components/lwp
191202
owners: Damoshed_Xu(xu18838022837)<[email protected]>
192203

193-
tag: maintainers
194-
path: MAINTAINERS
195-
owners: Bingru Zhang(Rbb666)<[email protected]>, Yuqiang Wang(kurisaW)<[email protected]>
204+
tag: components_net_at
205+
path: components/net/at
206+
owners: Chen Beidou(Ryan-CW-Code)<[email protected]>, lizhen9880(lizhen9880)<[email protected]>
207+
208+
tag: components_utilities_ymodem
209+
path: components/utilities/ymodem
210+
owners: Liya Huang(wdfk-prog)<[email protected]>
211+
212+
tag: documentation
213+
path: documentation
214+
owners: Chen Wang(unicornx)<[email protected]>, Guorui Li(GorrayLi)<[email protected]>, Lian Wang(lianux-mm)<[email protected]>, Xiansong Cao(CXSforHPU)<[email protected]>
196215

197-
tag: rvlibcpu
216+
tag: kernel
217+
path: src
218+
owners: Damoshed_Xu(xu18838022837)<[email protected]>, Guorui Li(GorrayLi)<[email protected]>, Han Lv(hamburger-os)<[email protected]>, Lian Wang(lianux-mm)<[email protected]>, Liya Huang(wdfk-prog)<[email protected]>, Xiaowei Swenson(ReviewSun)<[email protected]>
219+
220+
tag: libcpu_riscv
198221
path: libcpu/risc-v
199222
owners: Shun Wang(Yaochenger)<[email protected]>
200223

201-
tag: serial_v2
202-
path: components/drivers/serial/dev_serial_v2.c
203-
path: components/drivers/include/drivers/dev_serial_v2.h
204-
path: examples/utest/testcases/drivers/serial_v2
205-
owners: Chen Beidou(Ryan-CW-Code)<[email protected]>
224+
tag: maintainers
225+
path: MAINTAINERS
226+
owners: Bingru Zhang(Rbb666)<[email protected]>, Yuqiang Wang(kurisaW)<[email protected]>
206227

207228
tag: workflow
208229
path: .github

0 commit comments

Comments
 (0)