forked from mamoe/mirai
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1 from mamoe/master
Sync
- Loading branch information
Showing
118 changed files
with
3,695 additions
and
1,361 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |
| name: Bug 报告 | ||
| about: 提交一个 bug | ||
| title: '' | ||
| labels: " bug " | ||
| labels: " problem " | ||
| assignees: '' | ||
|
|
||
| --- | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| # This is a basic workflow to help you get started with Actions | ||
|
|
||
| name: mirai-doc Publish | ||
|
|
||
| # Controls when the action will run. Triggers the workflow on push or pull request | ||
| # events but only for the master branch | ||
| on: | ||
| release: | ||
| types: | ||
| - created | ||
|
|
||
| # A workflow run is made up of one or more jobs that can run sequentially or in parallel | ||
| jobs: | ||
| # This workflow contains a single job called "build" | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - name: Set up JDK 1.8 | ||
| uses: actions/setup-java@v1 | ||
| with: | ||
| java-version: 1.8 | ||
| - name: Grant execute permission for gradlew | ||
| run: chmod +x gradlew | ||
| - name: Gradle clean | ||
| run: ./gradlew clean | ||
| - name: Gradle build | ||
| run: ./gradlew build # if test's failed, don't publish | ||
| - name: Gradle :mirai-core:dokkaGitHubUpload | ||
| run: ./gradlew :mirai-core:dokkaGitHubUpload -Dgithub_token=${{ secrets.MAMOE_TOKEN }} -Pgithub_token=${{ secrets.MAMOE_TOKEN }} | ||
| - name: Gradle :mirai-core-qqandroid:dokkaGitHubUpload | ||
| run: ./gradlew :mirai-core-qqandroid:dokkaGitHubUpload -Dgithub_token=${{ secrets.MAMOE_TOKEN }} -Pgithub_token=${{ secrets.MAMOE_TOKEN }} | ||
|
|
||
|
|
||
| # - name: Upload artifact | ||
| # uses: actions/[email protected] | ||
| # with: | ||
| # # Artifact name | ||
| # name: mirai-core | ||
| # # Directory containing files to upload | ||
| # path: "mirai-core/build/libs/mirai-core-*-all.jar" | ||
| # - name: Upload artifact | ||
| # uses: actions/[email protected] | ||
| # with: | ||
| # # Artifact name | ||
| # name: mirai-core-qqandroid-all | ||
| # # Directory containing files to upload | ||
| # path: "mirai-core-qqandroid/build/libs/mirai-core-qqandroid-*-all.jar" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,27 @@ | ||
| # 贡献 | ||
|
|
||
| 感谢你来到这里和你对 mirai 做的所有贡献。 | ||
| **感谢你来到这里和你对 mirai 做的所有贡献。** | ||
|
|
||
| mirai 欢迎一切形式的代码贡献。你可以通过以下几种途径向 mirai 贡献。 | ||
|
|
||
| ## 主仓库 `mirai-core` | ||
|
|
||
| **阅读文档**： [docs/mirai.md](docs/mirai.md) | ||
|
|
||
| ### 代码优化 | ||
| 优化功能设计或实现, 或是引入一个新的设计（建议先通过 issue 与我们达成共识） | ||
| ### 能做什么? | ||
|
|
||
| ### 协议更新 | ||
| 为 mirai 添加更广泛的协议支持。 | ||
| **请基于 `master` 分支进行文档修改; 基于 `dev` 分支进行其他修改 (否则你的修改可能被关闭或不会立即合并)** | ||
|
|
||
| - 代码优化: 优化任何功能设计或实现, 或是引入一个新的设计（请先通过 issue 与维护者达成共识） | ||
| - 解决问题: 在 [issues](https://github.com/mamoe/mirai/issues) 查看 mirai 正遇到的所有问题, 或在 [里程碑](https://github.com/mamoe/mirai/milestones) 查看版本计划 | ||
| - 协议支持: 添加新协议支持, 但需要避免添加 [mirai.md#声明](docs/mirai.md#L9) 中的内容 | ||
|
|
||
| ### 注意事项 | ||
| - mirai 使用 [`kotlinx.io`](https://github.com/Kotlin/kotlinx-io) IO 库 | ||
| - 尽量不要引用新的库 | ||
| - 遵守 Kotlin 代码规范（提交前使用 IDE 格式化代码 (commit 时勾选 'Reformat code')） | ||
| - 不要手动拆解数据包. 请一定使用 `kotlinx.serialization` 拆解 ProtoBuf, 使用 mirai 的 `Jce` 序列化器拆解 Jce 数据包, 使用 `kotlinx.serialization` 拆解 Json 数据. | ||
| - 遵守 Kotlin 官方代码规范（提交前使用 IDE 格式化代码 (commit 时勾选 'Reformat code')） | ||
| - 不要手动拆解数据包. 请一定使用 `kotlinx.serialization` 拆解 ProtoBuf, 使用 [`jcekt`](https://github.com/him188/jcekt) 拆解 Tars 数据包, 使用 `kotlinx.serialization` 拆解 Json 数据. | ||
|
|
||
| ## 社区 | ||
|
|
||
| 插件社区不要求太高的代码质量，任何人都可以帮助 mirai。 | ||
| 插件社区不要求太高的代码质量，任何人都可以帮助 mirai。 | ||
| 可以为 [mirai-console](https://github.com/mamoe/mirai-console) 编写插件, 并发布到社区网站: (建设中) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| theme: jekyll-theme-cayman |
Oops, something went wrong.