贡献指南

欢迎对 SSCMA 做出贡献！我们欢迎任何类型的贡献，包括不限于:

• 修复错误

  修复代码实现错误的步骤如下:

  如果提交的代码改动较大，建议先提交 Issue，并正确描述 Issue 的现象、原因和复现方式，讨论后确认修复方案。

  修复错误并补充相应的单元测试，提交拉取请求。

• 新增功能或组件

  如果新功能或模块涉及较大的代码改动，建议先提交 Issue，确认功能的必要性。

  实现新增功能并添单元测试，提交拉取请求。

• 文档补充

  修复文档可以直接提交拉取请求。

  添加文档或将文档翻译成其他语言步骤如下:

  提交 Issue，确认添加文档的必要性。

如何贡献

请参考 Github 文档 - Collaborating。

提交格式

我们建议您在编写 commit 时，遵循以下编写原则，这可以让我们的项目更加整洁，方便迭代

build: build related changes
chore: typo fixes, library updates, etc.
ci: continue integration related changes
deps: dependencies update
docs: docs related changes
feat: new feactures
fix: fix issues
perf: add perf results
refactor: refactor components
revert: undo some changes
style: code style changes
test: test cases changes

许可部分

在贡献被提交之后，我们默认您同意了本项目的许可协议。