CONTRIBUTING-zh.md · nuo534202/Nuo-Math-Compiler

# 为 Nuo-Math-Compiler 贡献代码

感谢您有意参与贡献！我们非常欢迎那些能够提升正确性、可读性、测试、文档或开发者体验的贡献。本文档解释了如何准备和提交贡献，以便快速审查和合并。

## 如何贡献

- 在实现重要的更改之前，请先开一个 issue 进行讨论。包含清晰的描述、复现步骤（对于 bug）以及预期行为。
- 可以直接通过拉取请求提交微小的修改（如打字错误、文档、微小的清理等）。
- 请在一个特性分支上进行修改，并保持更改的集中和范围明确。

## 报告缺陷

报告缺陷时，请包含以下信息：

- 一个简短的描述性标题。
- 您使用的版本或提交（如果知道）。
- 复现问题的步骤以及适用的最小示例输入（`test/extra/` 目录中有示例输入）。
- 预期行为与实际行为。
- 任何错误信息、堆栈跟踪或日志。

在 Gitee 上创建一个 issue，并添加 `bug` 标签（如果可用）。

## 提出改进建议

对于功能改进，请创建一个 issue，描述改进动机和提议的方案。如果您准备了补丁，请在您的拉取请求中引用该 issue。

## 测试

- 尽可能为缺陷修复和新功能添加测试。将测试用例或示例输入放在 `test/extra/` 目录中。

## 分支与拉取请求

1.  在 Gitee 上 Fork 此仓库。
2.  从默认分支创建一个描述性的分支：
   - `feature/简短的描述性名称` 或 `bugfix/简短的描述性名称`
3.  保持提交内容小而集中。
4.  准备好后，向上游的默认分支开启拉取请求，并引用相关的 issue（如果有）。

您的拉取请求描述应包含：

- 更改了什么以及原因。
- 任何对用户可见的更改。
- 如何在本地测试此更改（构建/测试步骤）。
- 任何待办事项或后续工作。

## 提交信息指南

请遵循以下指南以使审查更容易：

- 使用简短的主题行（不超过 50 个字符）。
- 留一个空行，然后根据需要添加更长的正文解释原因。
- 在主题行中使用祈使语气（例如，“修复负数的解析问题”）。
- 相关时引用 issue 编号（例如，“修复 #12”）。

## 代码风格

- 遵循仓库中已有的 C 语言代码风格：一致的缩进、描述性的命名、清晰的函数边界。
- 相比巧妙的技巧，更倾向于可读的代码。为非显而易见的逻辑添加注释。
- 如果使用任何适用于平台的 linter 或格式化工具，请运行它们；对样式工具的更改请记录在本文档中。

## 审查与采纳

- 每个更改将由一名或多名维护者进行审查。审查重点是正确性、测试、清晰度以及更改的最小影响范围。
- 维护者可能会在合并前请求修改，请在同一个分支的后续提交中处理这些请求。

## 补充说明

- 参与贡献即表示您同意遵守项目的 `CODE_OF_CONDUCT.md`。
- 请遵守项目许可证（参见 `LICENSE`）。
- 如果您的贡献需要许可证或贡献者协议，维护者将与您联系。

感谢您帮助改进这个项目！

nuo534202/Nuo-Math-Compiler