Skip to content

Commit 3469871

Browse files
authored
Create MAINTAINERS
1 parent c3cfe6a commit 3469871

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

MAINTAINERS

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# List of maintainers of the RT-Thread open-source community
2+
#
3+
# This file manages the maintainers and their associated sections in the repository.
4+
# Developers should update this file according to project needs.
5+
# The following are explanations of each field and guidelines for adding new maintainer entries.
6+
#
7+
# When adding new entries, please follow the format:
8+
#
9+
# 1. **tag** - Assign a unique tag to each entry for identifying the code module or functionality.
10+
# - The tag should be concise and descriptive, such as `workflow`, `libc`.
11+
# - Tags should be written in lowercase letters, avoiding special characters and spaces.
12+
# - **Rule for Adding**: Use a new tag when adding a new functionality or module to ensure it clearly describes the area of responsibility.
13+
#
14+
# 2. **path** - Specify the directory or file path that the maintainer is responsible for.
15+
# - The path must be relative to the repository's root directory and can refer to either a single file or a folder.
16+
# - 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.
17+
# - **Rule for Adding**: Ensure that the path correctly points to the relevant code location. If multiple paths are managed by different maintainers, you can add multiple entries.
18+
#
19+
# 3. **owners** - List the maintainers responsible for the section, including their GitHub usernames and contact information.
20+
# - The owners should be listed as a comma-separated list if there are multiple maintainers.
21+
# - Format: `Name(GitHub username)<email address>`.
22+
# - **Rule for Adding**: Ensure that the listed GitHub usernames are correct, and the maintainers are aware of their responsibilities and duties.
23+
#
24+
# Example: How to Add a Maintainer Entry
25+
#
26+
# The following is a template for adding new entries in the MAINTAINER file:
27+
#
28+
# tag: <module-name>
29+
# path: <file-or-directory-path>
30+
# owners: <maintainer1>, <maintainer2>, ...
31+
#
32+
# When adding entries, please follow these guidelines:
33+
# - Ensure the `tag` is unique and descriptive.
34+
# - Ensure the `path` points to the correct location in the repository.
35+
# - Ensure the `owners` are accurate and that all new maintainers are aware of their responsibilities.
36+
#
37+
# Example Entry:
38+
# tag: example-module
39+
# path: example/module/path
40+
# owners: John Doe(johndoe)<[email protected]>, Jane Smith(janesmith)<[email protected]>
41+
42+
# Below are existing maintainer entries, divided by module:
43+
-----------------------------------------------------------------------------------------------------------------------------------------------------------
44+
tag: bsp: stm32
45+
path: bsp/stm32
46+
owners: ixd (kurisaW) <[email protected]>
47+
48+
tag: kernel
49+
path: src
50+
owners: ixd (kurisaW) <[email protected]>, pad (Nedki-L) <[email protected]>
51+
52+
tag: kernel
53+
path: include
54+
owners: pad (Nedki-L) <[email protected]>
55+
56+
tag: workflow
57+
path: .github/workflows
58+
owners: ixd (kurisaW) <[email protected]>, pad (Nedki-L) <[email protected]>, mem (KurisaW-Collaborative) <[email protected]>
59+
-----------------------------------------------------------------------------------------------------------------------------------------------------------
60+
61+
# Note: Each entry includes a `tag` that identifies the module or functionality, a `path` that points to the relevant code location,
62+
# and `owners` who are the maintainers for that part of the codebase.

0 commit comments

Comments
 (0)