Back to Details

rfc-check

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

RFC Check

RFC 检查

Determine if proposed changes require an RFC (Request for Comments).
判断提议的变更是否需要提交RFC（Request for Comments）。

Instructions

说明

  1. Identify changed files using 
    git diff --name-only
    or provided context
  2. Apply RFC criteria:
    RFC Required:
    • New APIs in 
      src/openenv/core/
    • Breaking changes to existing APIs
    • New abstractions or design patterns
    • Changes affecting the two-interface model (WebSocket/MCP separation)
    • Major architectural decisions
    RFC Not Required:
    • Bug fixes
    • Documentation updates
    • Minor refactoring (no API changes)
    • New example environments (unless introducing new patterns)
    • Dependency updates
    • Test additions
  3. Check against existing RFCs in 
    rfcs/
    for conflicts or dependencies
  1. 识别变更文件：使用
    git diff --name-only
    或提供的上下文
  2. 应用RFC判定标准：
    需要RFC的场景：
    • 在
      src/openenv/core/
      中新增API
    • 对现有API进行破坏性变更
    • 引入新的抽象或设计模式
    • 变更影响双接口模型（WebSocket/MCP分离）
    • 重大架构决策
    无需RFC的场景：
    • Bug修复
    • 文档更新
    • 小型重构（无API变更）
    • 新增示例环境（除非引入新模式）
    • 依赖更新
    • 测试用例新增
  3. 核对现有RFC：检查
    rfcs/
    目录中的现有RFC，确认是否存在冲突或依赖关系

Analysis Steps

分析步骤

  1. List all files being changed
  2. Identify any files in 
    src/openenv/core/
  3. Check for public API signature changes
  4. Look for new abstractions or patterns
  5. Review existing RFCs for related decisions
  1. 列出所有待变更的文件
  2. 识别是否涉及
    src/openenv/core/
    目录下的文件
  3. 检查是否存在公开API签名变更
  4. 查看是否引入了新的抽象或模式
  5. 回顾现有RFC中的相关决策

Output Format

输出格式

undefined
undefined

RFC Analysis

RFC 分析

Files Changed

变更文件

  • [list of files]
  • [文件列表]

Core Files Touched

涉及核心文件

  • [any files in src/openenv/core/, or "None"]
  • [src/openenv/core/下的相关文件，或“无”]

API Changes

API变更

  • [any signature changes to public APIs, or "None"]
  • [公开API的签名变更内容，或“无”]

New Patterns/Abstractions

新增模式/抽象

  • [any new patterns introduced, or "None"]
  • [引入的新模式内容，或“无”]

Verdict: NOT REQUIRED / RECOMMENDED / REQUIRED

判定结果：无需RFC / 建议提交 / 必须提交

Reasoning

判定理由

[Explanation of decision based on criteria above]
[基于上述标准的决策说明]

If RFC Needed

若需提交RFC

  • Suggested title: "RFC NNN: [title]"
  • Related RFCs: [list any related existing RFCs]
  • Key decisions to document: [list]
undefined
  • 建议标题："RFC NNN: [标题]"
  • 相关现有RFC：[相关RFC列表]
  • 需记录的关键决策：[列表]
undefined

RFC Template Reference

RFC模板参考

If an RFC is needed, use the template in 
rfcs/README.md
:
markdown
undefined
若需要提交RFC，请使用
rfcs/README.md
中的模板：
markdown
undefined

RFC NNN: Title

RFC NNN: 标题

Status: Draft Created: YYYY-MM-DD Authors: @username
状态：草稿 创建时间：YYYY-MM-DD 作者：@用户名

Summary

概述

[1-2 paragraph overview]
[1-2段内容的概述]

Motivation

动机

[Problem Statement + Goals]
[问题描述 + 目标]

Design

设计

[Architecture Overview, Core Abstractions, Key Design Decisions]
[架构概述、核心抽象、关键设计决策]

Examples

示例

[Code samples demonstrating usage]
undefined
[演示用法的代码示例]
undefined