PasteFerry (隔空贴): clipboard and file sync across macOS, Windows and Linux. Direct-first, end-to-end encrypted. Optional official access: no server to host. Independent self-hosting remains available.
为隔空贴贡献代码
感谢参与项目。每个 PR 请只处理一个独立目标,让它能够单独审查、测试和回退。
一个 PR,一个目标
- 每个 PR 只增加一项独立功能、修复一个问题,或完成一项明确的文档改进。与该改动直接相关的测试和文档应放在同一个 PR 中。
- 无关的功能、重构、依赖升级和顺手修复请分别提交,即使它们修改了同一个文件。为完成当前目标确有必要的重构或依赖调整可以一并提交,请说明它们的关系。
- 不硬性限制 commit 数量或修改行数,重点是范围清楚、便于审查。
- PR 涉及多个独立目标时,维护者会先与你讨论范围和拆分方式。已经进入审查的 PR,请不要持续加入与原目标无关的新功能。
能够独立审查、测试和回退的改动,通常建议分别提交。例如,安装方式的改进与独立的界面功能通常适合拆分;某项功能的实现、回归测试和使用文档应放在一起。同一个问题在多个平台上的修复,也可以作为一个完整 PR。如果较大的改动必须共同完成同一目标,请说明关联,与维护者协商范围。
较大改动先讨论
较大的新功能、架构调整、新增运行时依赖或安装方式,请先开 Issue,说明要解决的问题、预计范围和方案,与维护者讨论后再实现。
可以使用简短的功能讨论模板,不需要先完成实现才来讨论。小范围的问题修复和文档改进可以直接提交 PR。
每项独立改动从最新的 main 创建单独分支。如果依赖其他 PR,请附上链接,说明依赖关系和合并顺序。尚未完成的工作请标记为 Draft。
写清改动和验证结果
请使用 PR 模板,说明以下内容:
- 这次只解决什么问题或实现什么目标;有相关 Issue 时附上链接。
- 具体修改了什么,影响哪些平台或现有行为。
- 实际执行过的检查、结果和手动复现或验证步骤;相关平台尚未测试的,请明确注明。
- 界面变化的截图或短录屏,以及兼容性和迁移方面的影响。
请运行与改动相关的检查,在请求审查前处理本次改动引入的 CI 失败。如果已有 CI 故障或环境问题阻碍验证,请说明情况,共同排查。不要求贡献者自备全部平台的设备:请提供能够完成的验证和未覆盖范围,其他平台由 CI 或维护者协助验证。修复问题时,在可行的情况下补充或更新回归测试;纯文档修改可以通过检查格式和链接验证。构建方法见从源码构建。
审查期间的后续提交应围绕原定目标。新想法请另开 Issue 或 PR。如果被要求拆分,请在拆分后的 PR 中链接原来的讨论。
保留贡献来源
维护者部分采纳 PR 或重新整理外部贡献时,会关联原 PR 和最终提交,说明哪些内容已采用、哪些尚未纳入。
保留贡献者提交时,应保留原作者信息。将实质性的外部代码整理进新提交时,应记录相应贡献,例如使用贡献者提供的作者信息添加 Co-authored-by 署名。参考方案后重新实现的部分,应注明原提案并致谢,避免让人误以为原提交已被合并。
对于这些规范发布或修订前已提交的 PR,应与贡献者沟通范围和拆分方式,不以事后新增的要求认定此前贡献不合规范。