# 贡献者指南

[![English version](assets/english.svg)](./contributing.md)

:tada: 首先，感谢你为本项目付出的宝贵时间！:tada:

以下是有关如何为本项目贡献力量的一些指导建议。

以下内容大多是指导性质的建议，并非强制要求。总之，在行动之前确保你知道自己要做什么。

本文档目前仍处于完善阶段，欢迎通过提出你自己的意见或者提交 PR 来帮助我们。

## Guidance

**[我不想看下面的内容，我只是想问个小问题！！！](#加入我们的-QQ-群)**

|                | 普通使用者                      | 开发者                                          |
| ----------     | ------------------------------- | -------------------------------------------     |
| 提出问题       | [QQ 群](#加入我们的-qq-群) | [QQ 群](#加入我们的-qq-群)                 |
| 提交 Bug       | [QQ 群](#加入我们的-qq-群) | [GitHub - Issues](#在-github-上提交-bug)       |
| 有好的想法     | [QQ 群](#加入我们的-qq-群) | GitHub - Issues                |
| 提交 PR        |                                 | [GitHub - Pull Request](#提交-pull-request)    |
| 有信心维护代码 |                                 | [加入QQ 群并联系我们](#加入我们的-qq-群) |

## 加入我们的 QQ 群

在我们提供的 [QQ 群`737548118`][QQ chat group invitation]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。

[![Join on QQ Chat Group](https://img.shields.io/badge/QQ%E7%BE%A4-737548118-green)](https://jq.qq.com/?_wv=1027&k=KYDrmS5z)

> **Note**
> 关于具体如何提出问题并没有明确的要求。总之请提供尽可能详细的信息，并且思考一下这个问题是不是已经被解决了。

## 在 GitHub 上提交 Bug

如果你能更精确地定位问题所在，或者能够提供更详细的信息；你可以向我们[提交一个 issue][issue reporting link]。

## 提交 Pull Request

欢迎提交 Pull Request！

以下流程将会帮助你完成一次 PR。

1. Fork 这个项目。
2. 使用 `git clone` 将项目拉取到本地。
3. 使用最少的修改来解决 bug。
4. 使用 `git commit` 提交变更。
5. 创建一个 PR，并添加相应的说明。
6. 在 PR 被合并之前请保持关注，以便进行修改。

更细致的流程请参考
_[GitHub Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_。

[QQ chat group invitation]: https://jq.qq.com/?_wv=1027&k=KYDrmS5z
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new