contributing

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Contributing

贡献指南

When working inside the Feynman repository, read the repo-root
CONTRIBUTING.md
and
AGENTS.md
files for project-specific conventions.
Use this skill when working on Feynman itself, especially for:
  • CLI or runtime changes in
    src/
  • prompt changes in
    prompts/
  • bundled skill changes in
    skills/
  • subagent behavior changes in
    .feynman/agents/
  • install, packaging, or release changes in
    scripts/
    ,
    README.md
    , or website docs
Minimum local checks before claiming the repo change is done:
bash
npm test
npm run typecheck
npm run build
If the docs site changed, also validate
website/
.
When changing release-sensitive behavior, verify that
.nvmrc
, package
engines
, runtime guards, and install docs stay aligned.
在Feynman代码仓库中工作时,请阅读仓库根目录下的
CONTRIBUTING.md
AGENTS.md
文件,了解项目特定的规范。
在对Feynman本身进行开发时使用本技能,尤其适用于以下场景:
  • src/
    目录下的CLI或运行时变更
  • prompts/
    目录下的提示词变更
  • skills/
    目录下的内置skill变更
  • .feynman/agents/
    目录下的子Agent行为变更
  • scripts/
    README.md
    或网站文档中的安装、打包或发布流程变更
在确认仓库变更完成前,需完成以下本地检查:
bash
npm test
npm run typecheck
npm run build
如果文档网站有变更,还需验证
website/
目录。
当修改与发布相关的敏感行为时,请确保
.nvmrc
、package中的
engines
配置、运行时防护以及安装文档保持一致。