Browse Source

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 <unicorn_wang@outlook.com>
Chen Wang 1 week ago
parent
commit
f00b0a4384
1 changed files with 70 additions and 49 deletions
  1. 70 49
      MAINTAINERS

+ 70 - 49
MAINTAINERS

@@ -2,23 +2,33 @@
 #
 # This file manages the maintainers and their associated sections in the repository.
 # Developers should update this file according to project needs.
-# The following are explanations of each field and guidelines for adding new maintainer entries.
+# The following are explanations of each field and guidelines for adding new
+# maintainer entries.
 #
 # When adding new entries, please follow the format:
 #
-# 1. **tag** - Assign a unique tag to each entry for identifying the code module or functionality.
+# 1. **tag** - Assign a unique tag to each entry for identifying the code module
+#    or functionality.
 #    - The tag should be concise and descriptive, such as `workflow`, `libc`...
-#    - **Rule for Adding**: Use a new tag when adding a new functionality or module to ensure it clearly describes the area of responsibility.
+#    - **Rule for Adding**: Use a new tag when adding a new functionality or
+#      module to ensure it clearly describes the area of responsibility.
 #
 # 2. **path** - Specify the directory or file path that the maintainer is responsible for.
-#    - The path must be relative to the repository's root directory and can refer to either a single file or a folder.
-#    - 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.
-#    - **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.
+#    - The path must be relative to the repository's root directory and can
+#      refer to either a single file or a folder.
+#    - 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.
+#    - **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.
 #
-# 3. **owners** - List the maintainers responsible for the section, including their GitHub usernames and contact information.
-#    - The owners should be listed as a comma-separated list if there are multiple maintainers.
+# 3. **owners** - List the maintainers responsible for the section, including
+#    their GitHub usernames and contact information.
+#    - The owners should be listed as a comma-separated list if there are multiple
+#      maintainers.
 #    - Format: `Name(GitHub username)<email address>`.
-#    - **Rule for Adding**: Ensure that the listed GitHub usernames are correct, and the maintainers are aware of their responsibilities and duties.
+#    - **Rule for Adding**: Ensure that the listed GitHub usernames are correct,
+#      and the maintainers are aware of their responsibilities and duties.
 #
 # Example: How to Add a Maintainer Entry
 #
@@ -31,7 +41,8 @@
 # When adding entries, please follow these guidelines:
 # - Ensure the `tag` is unique and descriptive.
 # - Ensure the `path` points to the correct location in the repository.
-# - Ensure the `owners` are accurate and that all new maintainers are aware of their responsibilities.
+# - Ensure the `owners` are accurate and that all new maintainers are aware of
+#   their responsibilities.
 #
 # Example Entry:
 # tag: example-module
@@ -39,20 +50,31 @@
 # owners: John Doe(johndoe)<johndoe@example.com>, Jane Smith(janesmith)<janesmith@example.com>
 
 # Note:
-# - 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.
-# - 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.
+# - 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.
+#
+# - 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.
+#
 # - Each entry must be sorted in alphabetical order with tag as the keyword.
+#   It is recommended that the tag naming method follow the directory path in
+#   the code tree. For example, if the entry path is 'bsp/cvitek', then the tag
+#   name is 'bsp_cvitek'. It is recommended to use all lowercase letters and not
+#   mix uppercase and lowercase letters.
 
 # Below are existing maintainer entries, divided by module:
 
-tag: at
-path: components/net/at
-owners: Chen Beidou(Ryan-CW-Code)<1831931681@qq.com>, lizhen9880(lizhen9880)<lizhen9880@126.com>
-
 tag: bsp_cvitek
 path: bsp/cvitek
 owners: Chen Wang(unicornx)<unicorn_wang@outlook.com>
 
+tag: bsp_esp32_c3
+path: bsp/ESP32_C3/builtin_imgs
+path: bsp/ESP32_C3/drivers
+owners: Damoshed_Xu(xu18838022837)<496121493@qq.com>
+
 tag: bsp_gd32105c-eval
 path: bsp/gd32/arm/gd32105c-eval
 owners: Xiansong Cao(CXSforHPU)<19511928573@163.com>
@@ -97,11 +119,6 @@ tag: bsp_ultrarisc
 path: bsp/ultrarisc/ur_dp1000_evb
 owners: Zhang Jing(zhangjing0303)<zhangjing@ultrarisc.com>
 
-tag: bsp_ESP32_C3
-path: bsp/ESP32_C3/builtin_imgs
-path: bsp/ESP32_C3/drivers
-owners: Damoshed_Xu(xu18838022837)<496121493@qq.com>
-
 tag: bsp_renesas
 path: bsp/renesas
 owners: Yuqiang Wang(kurisaW)<2053731441@qq.com>
@@ -150,59 +167,63 @@ tag: components
 path: components
 owners: Huanyi Mai(Maihuanyi)<m19825309307@163.com>
 
-tag: documentation
-path: documentation
-owners: Chen Wang(unicornx)<unicorn_wang@outlook.com>, Guorui Li(GorrayLi)<liguorui1213@163.com>, Lian Wang(lianux-mm)<lianux.mm@gmail.com>, Xiansong Cao(CXSforHPU)<19511928573@163.com>
-
-tag: driver_can
+tag: components_driver_can
 path: components/drivers/can
 owners: Liya Huang(wdfk-prog)<1425075683@qq.com>
 
-tag: driver_i2c
+tag: components_driver_i2c
 path: components/drivers/i2c
 owners: Liya Huang(wdfk-prog)<1425075683@qq.com>
 
-tag: driver_pm
+tag: components_driver_pm
 path: components/drivers/pm
 owners: Liya Huang(wdfk-prog)<1425075683@qq.com>
 
-tag: driver_spi
+tag: components_driver_serial_v2
+path: components/drivers/serial/dev_serial_v2.c
+path: components/drivers/include/drivers/dev_serial_v2.h
+path: examples/utest/testcases/drivers/serial_v2
+owners: Chen Beidou(Ryan-CW-Code)<1831931681@qq.com>
+
+tag: components_driver_spi
 path: components/drivers/spi
 owners: Liya Huang(wdfk-prog)<1425075683@qq.com>, Liang He(Liang1795)<111111000@163.com>
 
-tag: driver_ymodem
-path: components/utilities/ymodem
-owners: Liya Huang(wdfk-prog)<1425075683@qq.com>
-
-tag: fal
+tag: components_fal
 path: components/fal
 owners: Yucai Liu(illustriousness)<1486344514@qq.com>
 
-tag: kernel
-path: src
-owners: Damoshed_Xu(xu18838022837)<496121493@qq.com>, Guorui Li(GorrayLi)<liguorui1213@163.com>, Han Lv(hamburger-os)<296570182@qq.com>, Lian Wang(lianux-mm)<lianux.mm@gmail.com>, Liya Huang(wdfk-prog)<1425075683@qq.com>, Xiaowei Swenson(ReviewSun)<Sxw1204814381@outlook.com>
-
-tag: libc
+tag: components_libc
 path: components/libc
 owners: Meco Jianting Man(mysterywolf)<920369182@qq.com>, Guorui Li(GorrayLi)<liguorui1213@163.com>
 
-tag: lwp
+tag: components_lwp
 path: components/lwp
 owners: Damoshed_Xu(xu18838022837)<496121493@qq.com>
 
-tag: maintainers
-path: MAINTAINERS
-owners: Bingru Zhang(Rbb666)<751061401@qq.com>, Yuqiang Wang(kurisaW)<2053731441@qq.com>
+tag: components_net_at
+path: components/net/at
+owners: Chen Beidou(Ryan-CW-Code)<1831931681@qq.com>, lizhen9880(lizhen9880)<lizhen9880@126.com>
+
+tag: components_utilities_ymodem
+path: components/utilities/ymodem
+owners: Liya Huang(wdfk-prog)<1425075683@qq.com>
+
+tag: documentation
+path: documentation
+owners: Chen Wang(unicornx)<unicorn_wang@outlook.com>, Guorui Li(GorrayLi)<liguorui1213@163.com>, Lian Wang(lianux-mm)<lianux.mm@gmail.com>, Xiansong Cao(CXSforHPU)<19511928573@163.com>
 
-tag: rvlibcpu
+tag: kernel
+path: src
+owners: Damoshed_Xu(xu18838022837)<496121493@qq.com>, Guorui Li(GorrayLi)<liguorui1213@163.com>, Han Lv(hamburger-os)<296570182@qq.com>, Lian Wang(lianux-mm)<lianux.mm@gmail.com>, Liya Huang(wdfk-prog)<1425075683@qq.com>, Xiaowei Swenson(ReviewSun)<Sxw1204814381@outlook.com>
+
+tag: libcpu_riscv
 path: libcpu/risc-v
 owners: Shun Wang(Yaochenger)<1516081466@qq.com>
 
-tag: serial_v2
-path: components/drivers/serial/dev_serial_v2.c
-path: components/drivers/include/drivers/dev_serial_v2.h
-path: examples/utest/testcases/drivers/serial_v2
-owners: Chen Beidou(Ryan-CW-Code)<1831931681@qq.com>
+tag: maintainers
+path: MAINTAINERS
+owners: Bingru Zhang(Rbb666)<751061401@qq.com>, Yuqiang Wang(kurisaW)<2053731441@qq.com>
 
 tag: workflow
 path: .github