Skip to content

Commit e44c101

Browse files
committed
CONTRIBUTING_CN.md
1 parent 4099419 commit e44c101

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/CONTRIBUTING_CN.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ _中文_ | [English](CONTRIBUTING.md)
1616
## 我发现了 Bug
1717
### Issues
1818

19-
如果您在Discord组件库或官方维护的组件库中发现了一个 bug,那么首先您可以前往
20-
[Issues](https://github.com/simple-robot/simbot-component-discord/issues/)
19+
如果您在Telegram组件库或官方维护的组件库中发现了一个 bug,那么首先您可以前往
20+
[Issues](https://github.com/simple-robot/simbot-component-telegram/issues/)
2121
中选择合适的分类并提交与此 bug 相关的详细信息 (包括使用的库版本、错误日志等);
2222

2323
在反馈时,我们建议您使用 Markdown 语法[^about write] 来提高反馈内容的可读性与观感,这也可以帮助参与者快速阅读与定位问题所在。
@@ -27,7 +27,7 @@ _中文_ | [English](CONTRIBUTING.md)
2727
### Pull Request
2828

2929
如果您有兴趣与能力为我们贡献此 bug 的修复,
30-
那么欢迎您通过 [Pull Request](https://github.com/simple-robot/simbot-component-discord/pulls) 提交您的变更。
30+
那么欢迎您通过 [Pull Request](https://github.com/simple-robot/simbot-component-telegram/pulls) 提交您的变更。
3131
当您提交代码变更时,需要了解如下几点:
3232

3333
**代码贡献**
@@ -37,7 +37,7 @@ _中文_ | [English](CONTRIBUTING.md)
3737
**参与者**
3838

3939
包括核心库与官方组件库在内,它们都会在项目中存在配置参与者的地方。
40-
本指南以Discord组件库为例,在 `buildSrc/src/main/kotlin/P.kt` 中的如下代码内添加有关您的信息:
40+
本指南以Telegram组件库为例,在 `buildSrc/src/main/kotlin/P.kt` 中的如下代码内添加有关您的信息:
4141

4242
```Kotlin
4343
override val developers: List<Developer> = developers {
@@ -58,7 +58,7 @@ override val developers: List<Developer> = developers {
5858
## 代码贡献
5959
### 注释风格
6060

61-
Discord组件库对源代码的注释有着一些约定
61+
Telegram组件库对源代码的注释有着一些约定
6262

6363
* 要对所有访问级别为 `public``protected` 的内容 (包括类/接口、函数、属性等)
6464
使用**中文****易懂的英文**编写较为细致的文档注释[^KDoc]
@@ -76,7 +76,7 @@ Discord组件库对源代码的注释有着一些约定。
7676

7777
### 代码风格
7878

79-
Discord组件库对整体的代码风格有着一些约定
79+
Telegram组件库对整体的代码风格有着一些约定
8080

8181
这些代码风格的大部分规则被作为配置文件保存在了 `.editorconfig` 中,部分IDE (例如 IDEA) 应当可以自动识别加载、或手动加载它。
8282
这些风格与
@@ -104,7 +104,7 @@ Discord组件库对整体的代码风格有着一些约定。
104104

105105
### KMP
106106

107-
Discord组件库绝大多数模块都是支持 [KMP](https://kotlinlang.org/docs/multiplatform.html) 的。
107+
Telegram组件库绝大多数模块都是支持 [KMP](https://kotlinlang.org/docs/multiplatform.html) 的。
108108

109109
### 二进制兼容
110110

@@ -115,7 +115,7 @@ Discord组件库绝大多数模块都是支持 [KMP](https://kotlinlang.org/docs
115115

116116
### 友好 API
117117

118-
Discord组件库对外提供的公开API,都应该是 Java 友好、或有配套的 Java 友好 API,尤其指可挂起函数 `suspend fun`。
118+
Telegram组件库对外提供的公开API,都应该是 Java 友好、或有配套的 Java 友好 API,尤其指可挂起函数 `suspend fun`。
119119
大部分挂起函数的 Java 友好 API 通过编译器插件
120120
[Kotlin Suspend Transform compiler plugin](https://github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin) 实现,
121121
可参阅手册中的
@@ -132,7 +132,7 @@ API文档是使用 [Dokka](https://github.com/Kotlin/dokka) 根据源码的文
132132

133133
### 手册贡献
134134

135-
Discord组件库手册使用 [Writerside](https://www.jetbrains.com/help/writerside) 编写,
135+
Telegram组件库手册使用 [Writerside](https://www.jetbrains.com/help/writerside) 编写,
136136
你可以在目录 `Writerside` 中找到它的内容。
137137

138138
## 社区贡献

0 commit comments

Comments
 (0)