| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 1 个月前 | ||
| 2 个月前 | ||
| 2 个月前 |
RFC Document Directory
This directory contains technical design documents (RFC - Request for Comments) for the HCOMM repository. These documents are used to align on solutions and document design decisions before code implementation.
Directory Structure
0000-template.md- RFC writing templateINDEX.md- RFC number registry, a complete list of all assigned RFC numbersNNNN-xxx-xxx.md- RFC documents (4-digit number plus a brief description)
Naming Convention
RFC file naming format: {4-digit-number}-{brief-description}.md
For example: 0001-add-new-feature.md
- Number: 4-digit zero-padded (0001 to 9999)
- Description: English lowercase, hyphen-separated, concise
Numbering Mechanism (Core)
- Number reservation PR (lightweight): Modify only INDEX.md to append a reservation row
- RFC document PR (heavyweight): Write the RFC document and submit it for review. The number is already locked through the number reservation PR.
Number reservation rules:
- Sequential allocation, prioritize the smallest unused number
- Never reused. Merged numbers are not recycled even if the RFC is subsequently replaced
- For details, see INDEX.md
RFC Lifecycle
- Requirement phase: Submit the requirement as a Requirement type Issue and wait for the SIG group to accept it
- Number reservation PR: Append a reservation row in INDEX.md (status
reserved) and submit a number reservation PR - Number reservation PR merged: The number is occupied. You can start writing the RFC.
- Writing phase: Write the system solution following the RFC template
- Review phase: The RFC document PR is reviewed. Modify the solution based on feedback during the process.
- Decision phase:
- Merge: The Maintainer approves the review. Add
/lgtmand/approveto merge. Update the status in INDEX.md toaccepted. - Close: The review is not approved. Close the PR. The number remains
reservedand is not recycled (the author can restart the review process).
- Merge: The Maintainer approves the review. Add
- Implementation phase: The merged RFC serves as the implementation contract. Code PRs must follow the RFC solution.
Replacement Relationship
When the implementation of an RFC is replaced by a subsequent RFC:
- Add the following note at the end of the replaced RFC document:
> Superseded by 00NN - Update the status of the corresponding row in INDEX.md from
acceptedtosuperseded - Do not modify the original number