# 贡献指北
## 提交信息格式
提交信息应遵循 [PJ568 提交说明规范](https://github.com/PJ-568/git-commit-regulation)。
## 提交更改
1. Fork 此仓库，在您的仓库新建一个基于此仓库默认分支（branch）的分支。
2. 在该新建分支对项目进行更改，确保语法不存在问题后应用更改您的仓库。
3. 向我们的仓库提交拉取请求。请确保您遵循了上述说明。
4. 我们将定期审查拉取请求，并告知您我们的问题以及在合并您的拉取请求之前需要进行的任何更改。
5. 我们希望您在 15 日内作出回应，之后如果没有显示活动，您的拉取请求可能会被关闭。
### 参考流程
1. Fork 源码，下载到本地并运行项目；
2. 添加或修改代码，并配置测试；
3. 配置 rust 环境并运行以下命令以测试：
```bash
cargo fmt --all -- --check && \
cargo check --all-targets && \
cargo clippy --all-targets -- -D warnings && \
cargo test --all-targets && \
cargo doc --no-deps --document-private-items
```
4. 对相关改动进行全面的自我测试；
5. 确认无误后提交修改到 Github；
6. 提交 Pull Request。
### 注意事项
- 单次 Pull Request 不应提交过多修改，请确保每次提交都针对特定的功能且务必说明本次改动的具体目的，例如：修复某 bug、优化某方法 等，方便进行 Code Review；
- 对于 bug 的修复，应该将本次 Pull Request 和相对应 bug 的 issue 关联起来，让别人知道该问题已经被修复；
- 对于较大的新功能，你需要先提交 Issues，例如“【新增】添加 XXX 功能”，确认该功能有被添加的必要后，再开始工作；
- 对于一些主观的样式、交互逻辑调整：如颜色、图标的使用，某些预设配置的增减修改等，一般不予通过。但可以在 Discussions 中进行讨论；
- 其他如简单的代码优化、文档修正等，只要修改合理都会被接受。