@@ -16,8 +16,8 @@ _中文_ | [English](CONTRIBUTING.md)
16
16
## 我发现了 Bug
17
17
### Issues
18
18
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/ )
21
21
中选择合适的分类并提交与此 bug 相关的详细信息 (包括使用的库版本、错误日志等);
22
22
23
23
在反馈时,我们建议您使用 Markdown 语法[ ^about write] 来提高反馈内容的可读性与观感,这也可以帮助参与者快速阅读与定位问题所在。
@@ -27,7 +27,7 @@ _中文_ | [English](CONTRIBUTING.md)
27
27
### Pull Request
28
28
29
29
如果您有兴趣与能力为我们贡献此 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 ) 提交您的变更。
31
31
当您提交代码变更时,需要了解如下几点:
32
32
33
33
** 代码贡献**
@@ -37,7 +37,7 @@ _中文_ | [English](CONTRIBUTING.md)
37
37
** 参与者**
38
38
39
39
包括核心库与官方组件库在内,它们都会在项目中存在配置参与者的地方。
40
- 本指南以Discord组件库为例 ,在 ` buildSrc/src/main/kotlin/P.kt ` 中的如下代码内添加有关您的信息:
40
+ 本指南以Telegram组件库为例 ,在 ` buildSrc/src/main/kotlin/P.kt ` 中的如下代码内添加有关您的信息:
41
41
42
42
``` Kotlin
43
43
override val developers: List <Developer > = developers {
@@ -58,7 +58,7 @@ override val developers: List<Developer> = developers {
58
58
## 代码贡献
59
59
### 注释风格
60
60
61
- Discord组件库对源代码的注释有着一些约定 。
61
+ Telegram组件库对源代码的注释有着一些约定 。
62
62
63
63
* 要对所有访问级别为 ` public ` 、` protected ` 的内容 (包括类/接口、函数、属性等)
64
64
使用** 中文** 或** 易懂的英文** 编写较为细致的文档注释[ ^ KDoc ] 。
@@ -76,7 +76,7 @@ Discord组件库对源代码的注释有着一些约定。
76
76
77
77
### 代码风格
78
78
79
- Discord组件库对整体的代码风格有着一些约定 。
79
+ Telegram组件库对整体的代码风格有着一些约定 。
80
80
81
81
这些代码风格的大部分规则被作为配置文件保存在了 ` .editorconfig ` 中,部分IDE (例如 IDEA) 应当可以自动识别加载、或手动加载它。
82
82
这些风格与
@@ -104,7 +104,7 @@ Discord组件库对整体的代码风格有着一些约定。
104
104
105
105
### KMP
106
106
107
- Discord 组件库绝大多数模块都是支持 [KMP ](https: // kotlinlang.org/docs/multiplatform.html) 的。
107
+ Telegram 组件库绝大多数模块都是支持 [KMP ](https: // kotlinlang.org/docs/multiplatform.html) 的。
108
108
109
109
### 二进制兼容
110
110
@@ -115,7 +115,7 @@ Discord组件库绝大多数模块都是支持 [KMP](https://kotlinlang.org/docs
115
115
116
116
### 友好 API
117
117
118
- Discord 组件库对外提供的公开 API 中 ,都应该是 Java 友好、或有配套的 Java 友好 API ,尤其指可挂起函数 `suspend fun `。
118
+ Telegram 组件库对外提供的公开 API 中 ,都应该是 Java 友好、或有配套的 Java 友好 API ,尤其指可挂起函数 `suspend fun `。
119
119
大部分挂起函数的 Java 友好 API 通过编译器插件
120
120
[Kotlin Suspend Transform compiler plugin ](https : // github.com/ForteScarlet/kotlin-suspend-transform-compiler-plugin) 实现,
121
121
可参阅手册中的
@@ -132,7 +132,7 @@ API文档是使用 [Dokka](https://github.com/Kotlin/dokka) 根据源码的文
132
132
133
133
### 手册贡献
134
134
135
- Discord 组件库手册使用 [Writerside ](https://www.jetbrains.com/help/writerside) 编写,
135
+ Telegram 组件库手册使用 [Writerside ](https://www.jetbrains.com/help/writerside) 编写,
136
136
你可以在目录 `Writerside ` 中找到它的内容。
137
137
138
138
## 社区贡献
0 commit comments