Skip to content

Commit f79a353

Browse files
committed
fix: format issues and typos
1 parent be671d7 commit f79a353

File tree

2 files changed

+23
-26
lines changed

2 files changed

+23
-26
lines changed

Diff for: contributing-zh.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 贡献者指南
22

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

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

@@ -12,20 +12,20 @@
1212

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

15-
| | 普通使用者 | 开发者 |
16-
|-----------------|----------|---------------|
17-
| 提出问题 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
18-
| 提交 Bug | [Slack](#加入我们的-slack-频道) | [Github - Issues](#在-github-上提交-bug) |
19-
| 有好的想法 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
20-
| 提交 PR | | [Github - Pull Request](#提交-pull-request) |
15+
| | 普通使用者 | 开发者 |
16+
| ---------- | ------------------------------- | ------------------------------------------- |
17+
| 提出问题 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
18+
| 提交 Bug | [Slack](#加入我们的-slack-频道) | [Github - Issues](#在-github-上提交-bug) |
19+
| 有好的想法 | [Slack](#加入我们的-slack-频道) | [Slack](#加入我们的-slack-频道) |
20+
| 提交 PR | | [Github - Pull Request](#提交-pull-request) |
2121

2222
## 加入我们的 Slack 频道
2323

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

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

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

@@ -35,14 +35,13 @@
3535

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

38-
3938
## 提交 Pull Request
4039

4140
欢迎提交 Pull Request!
4241

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

45-
1. fork 这个项目。
44+
1. Fork 这个项目。
4645
2. 使用 `git clone` 将项目拉取到本地。
4746
3. 使用最少的修改来解决 bug。
4847
4. 使用 `git commit` 提交变更。

Diff for: contributing.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing
22

3-
:tada:First off, thanks for taking the time to contribute!:tada:
3+
:tada: First off, thanks for taking the time to contribute! :tada:
44

55
The following is a set of guidelines for contributing to BIThesis.
66

@@ -11,12 +11,12 @@ and feel free to propose changes to this document in a pull request.
1111

1212
**[I don't want to read this whole thing, I just have a small question!!!](#join-our-slack-channel)**
1313

14-
| | For User | For Developer |
15-
|-----------------|----------|---------------|
16-
| Have a Question | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
17-
| Bug Report | [Slack](#join-our-slack-channel) | [Github - Issues](#bug-report-on-github) |
18-
| Feature Request | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
19-
| Pull Request | | [Github - Pull Request](#pull-request-process) |
14+
| | For Users | For Developers |
15+
| --------------- | -------------------------------- | ---------------------------------------------- |
16+
| Have a Question | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
17+
| Bug Report | [Slack](#join-our-slack-channel) | [Github - Issues](#bug-report-on-github) |
18+
| Feature Request | [Slack](#join-our-slack-channel) | [Slack](#join-our-slack-channel) |
19+
| Pull Request | | [Github - Pull Request](#pull-request-process) |
2020

2121
## Join Our Slack Channel
2222

@@ -38,23 +38,21 @@ rethink before write.
3838
If you can locate the bug or provide more detailed information, you may
3939
_[report an issue here][issue reporting link]_.
4040

41-
4241
## Pull Request Process
4342

4443
Pull Request are welcomed!
4544

4645
The following steps will help you finish a pull request.
4746

48-
1. fork this repo.
49-
2. git clone your forked repo.
50-
3. make small changes until bug fixed.
51-
4. commit changes.
52-
5. create a pull request with related information.
53-
6. keep in touch with further discussion and refine.
47+
1. Fork this repo.
48+
2. `git clone` your forked repo.
49+
3. Make changes until the bug is fixed.
50+
4. Commit your changes.
51+
5. Create a pull request with related information.
52+
6. Keep in touch with further discussion and refine.
5453

55-
for more information, refer to the
54+
For more information, refer to the
5655
_[Github Help](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests)_.
5756

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

0 commit comments

Comments
 (0)