summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/bithesis/contributing-zh.md
blob: cfdf95b80d362e42aabf6382e6300e15d0821d29 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# 贡献者指南

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

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

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

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

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

## Guidance

**[我不想看下面的内容,我只是想问个小问题!!!](#加入我们的-slack-频道)**

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

## 加入我们的 Slack 频道

在我们提供的[官方 Slack 频道][slack channel invitation]中有**很多活跃的维护者**和**友好的社区氛围**。在这里你能获得很多与本项目有关的帮助。

[![点击这里加入 Slack](/assets/slack.svg)](https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw)

- 使用 `#community` 频道来**讨论问题**、**提出你的建议**或者**寻求帮助**。
- 使用 `#random` 频道来**水群**:laughing:!
- 使用 `#announcement` 频道获取和本项目相关的**最新资讯和使用方法**!

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

## 在 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)_。

[slack channel invitation]: https://join.slack.com/t/bithesis/shared_invite/zt-epmzkyk0-fJRsUS36AlwMNB2AI_Q~Vw
[issue reporting link]: https://github.com/BITNP/BIThesis/issues/new