Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 3.28 KB

contributing.md

File metadata and controls

53 lines (34 loc) · 3.28 KB

贡献指南

项目首页 · 开发文档 · English

欢迎改善 Foundation 的代码、文档和翻译,也欢迎提供可复现的问题与设备验证结果。

报告问题

先查看 FAQ 与目标版本的发行说明,再使用 GitHub Issue 模板提交:

  • Windows 版本与系统构建号。
  • Foundation Sunshine、桌面 GUI、Moonlight 客户端的版本。
  • 显卡、驱动和相关设备型号。
  • 从什么操作开始,预期是什么,实际出现什么;附可重复的步骤。
  • 对应时间段的日志、报错与必要截图。

涉及 HDR 时说明显示设备与实际协商格式;音频说明输出设备、声道和编码;手柄说明连接方式、虚拟类型和组件状态。客户端安装、商店分发或仅发生在客户端内的问题,反馈给对应客户端项目。

提交代码

主机服务与 WebUI 修改提交到本仓库;桌面 GUI 修改提交到 sunshine-control-panel。跨仓库修改需要在 PR 中相互链接,并说明要使用的提交或构建组合。

  1. 说明一个具体问题或使用场景,并限定修改范围。
  2. 参考开发文档准备环境,执行与修改相关的检查。
  3. PR 写清修改后的行为、验证方法、结果及仍未验证的条件。
  4. 新增用户功能时,同步更新使用文档、GUI 文案和对应语言。

标题和说明先写用户可观察的变化。涉及协议、驱动、捕获或生命周期的修改,再补充评审需要的实现细节。

文档与翻译

内容放在哪里

内容 位置
项目亮点、下载、完整首次连接 根目录 README
功能说明、开启方法、确认方式 docs/zh-CN/features.md 与 docs/en/features.md
症状、处理步骤、反馈信息 对应语言的 faq.md
更新与配置保留 对应语言的 upgrading.md
开发环境、代码与验证入口 对应语言的 development.md
贡献流程 根目录 CONTRIBUTING

写法与格式

每页用一个 H1,主要任务用 H2,必要的子步骤用 H3。操作使用有序列表,方案比较使用简短表格,路径、文件名和命令用代码格式。新手必做步骤直接展示;折叠块只容纳次要细节。

功能介绍说明用途;设置步骤说明在哪里点、选什么;确认步骤说明应该看到什么。组件、硬件或客户端条件与对应功能放在一起。避免没有测试依据的性能数字和“所有客户端完整支持”等表述。

README、用户指南与贡献入口提供中英文对应页;同名文件保持相同目录,页面顶部提供返回和语言切换。新增下载、步骤或能力条件时在同一修改中同步两种语言。中文梗在英文中自然改写,操作指引保持准确。

提供设备验证

验证结果请记录两端版本、硬件、连接方式、选项与实际表现。HDR 协商、主机信息注入和终端显示效果分别记录;手柄按基础输入、扳机、触觉等能力分别记录。这样才能形成可复查的兼容性依据。