SpineViewer/CONTRIBUTING.md

CONTRIBUTING

仓库分支

仓库目前包含 4 个分支:

• main: 默认分支, 也是项目最新版的发布用分支
• dev/wpf: WPF 版本开发分支
• release/wf: Winforms 旧版本发布分支 (已弃用, 仅进行 bug 修复)
• dev/wf: Winforms 旧版本开发分支 (已弃用, 仅进行 bug 修复)

仓库的每个发布分支都有对应的开发分支 dev/*, 在进行贡献和推送时请在开发分支上进行, 待开发分支上审核完毕进行必要的确认 (例如版本号的更新) 后, 再从开发分支向对应的发布分支发起 pr, 合并后将会通过 Actions 进行自动生成和发布.

仓库结构

仓库目前包含两个可执行文件项目, 分别是:

• SpineViewer.csproj
• SpineViewerCLI.csproj

前者为仓库主要项目, 提供一个预览操作 Spine 模型文件的 UI 界面, 后者基于社区贡献进行开发, 提供一些便捷的 CLI 功能, 从而可以对模型文件进行一些批量操作.

除此之外其余项目均为一些基础功能库, 为以上两个项目提供必要的功能支持. 原则上 UI 项目和 CLI 项目二者独立互不引用, 仅引用相同的基础功能库, 以保证整个仓库的层次结构清晰便于维护.

如何贡献

对于一些小改动, 例如:

• 某些文件内的 bug 修复 (例如一些逻辑上的错误)
• 已有功能的扩展性增强 (例如在已有代码逻辑结构上扩充某些功能字段)
• 其他可能的对已有功能的修复改进

可以直接 fork 修改后向开发分支发起 pr, 经 review 无问题后可直接合并.

对于较大的改动, 例如:

• 新增某些代码文件 (例如需要添加一些全新的类)
• 添加一些全新的逻辑或者功能代码 (例如在自行车上加装发动机)
• 其他可能影响项目代码逻辑结构的改动

这些改动请先提 Issue, 进行必要性讨论, 以及确认新功能的引入方式, 请不要直接将这些可能的破坏性改动发起 pr.