101 lines
4.3 KiB
Markdown
101 lines
4.3 KiB
Markdown
# 我的世界中国版 共创教程
|
||
|
||
欢迎来到我的世界中国版-共创教程！
|
||
|
||
本Wiki囊括了位于官网首页【教学课程】下的所有内容
|
||
|
||
[跳转到我们的官网教程页](https://mc.163.com/dev/course.html)
|
||
|
||
## 贡献文档说明
|
||
|
||
如果你发现了一些错误，或者想要补充一些新的教程到我们的官网，那可以在本仓库提交pr，并在项目中留下你的大名！
|
||
提交的文档会经过审核，最终以每两周一次的频率更新到我们的官网中
|
||
|
||
## 注意事项
|
||
|
||
- 因为**mcguide/12-入门教程/10-注册成为开发者**的文件名，是首页 https://mc.163.com/dev/guide.html 左侧目录生成抓取的依据，因此请开发者们勿修改**注册成为开发者**文件名。修改了文件名的Pull requests审核将不通过
|
||
- 文档一般双周进行同步，如需要立即同步等需求，请开发者在自己的提交请求下@MCNeteaseDevs，并给出申请立即同步的原因（如我提交的文档有误导致目录错误等）
|
||
|
||
## 贡献指南
|
||
|
||
**开发指南/教学课程文档**与**Mod SDK文档**修改流程不一致，接下来将会分别介绍
|
||
|
||
### Mod SDK文档修改
|
||
1. 点击仓库中**Issues** - 点击**New Issue** - 选择**SDK文档修改**
|
||
|
||
2. 按照模版依次填写以下内容：
|
||
- 标题：为了方便其他开发者查找相同修改，请写明**接口名称与修改部分**。例如：StopCustomMusicById添加备注
|
||
- 接口名称：填写需要修改的接口名称或链接
|
||
- 接口类型：选择接口的类型，共有服务端、客户端、双端三种选项
|
||
- 修改内容：详细描述修改的接口文档内容
|
||
- 其他补充信息：如有其他信息可以补充在这里
|
||
- 开发者信息：将会用于贡献致谢展示与奖品发放
|
||
|
||
3. 完成后点击Create。修改内容会由官方进行审核，审核通过后会在**两周之内**同步至官网
|
||
|
||
### 开发指南/教学课程修改
|
||
1. Fork 本项目。点击 Fork 按钮，创建一个新的派生项目到自己的工作区（Create a new fork）
|
||
|
||
2. 克隆派生
|
||
```bash
|
||
# 克隆项目到本地（注意是派生项目的链接，不是原始项目）
|
||
git clone https://github.com/your-user-name/your-fork-name.git
|
||
```
|
||
|
||
3. 创建分支
|
||
```bash
|
||
# 创建并切换到本地新分支，分支的命名尽量简洁，并与想要解决的问题相关
|
||
git checkout -b your-branch-name
|
||
```
|
||
|
||
4. 修改文档内容或者新增文档
|
||
|
||
5. 提交更改
|
||
```bash
|
||
git commit -m 'your-commit-content'
|
||
```
|
||
|
||
6. 推送到分支
|
||
```bash
|
||
git push --set-upstream origin your-branch-name
|
||
```
|
||
7. 提交合并请求
|
||
提交时添加标题和描述信息，信息是提交内容的概要，方便审核
|
||
> 如果有对应的 issue，也请键入添加
|
||
|
||
8. 等待审核
|
||
|
||
9. 审核通过后，两周内会刷新到官网中
|
||
|
||
## 备注
|
||
|
||
我们的官网文档是使用VuePress构建的，我们鼓励你使用VuePress的语法对文档进行美化
|
||
|
||
## 鸣谢
|
||
|
||
[Minecraft Bedrock Wiki](https://github.com/Bedrock-OSS/bedrock-wiki?tab=readme-ov-file#minecraft-bedrock-wiki)
|
||
|
||
|
||
|
||
## 致谢
|
||
|
||
在此感谢以下开发者作出的贡献（以下排名不分先后）
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
||
<!-- prettier-ignore-start -->
|
||
<!-- markdownlint-disable -->
|
||
<table>
|
||
<tbody>
|
||
<tr>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/MCNeteaseDevs"><img src="https://avatars.githubusercontent.com/u/186891705?v=4?s=100" width="100px;" alt="MCNeteaseDevs"/><br /><sub><b>MCNeteaseDevs</b></sub></a><br /><a href="#doc-MCNeteaseDevs" title="Documentation">📖</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/sevenstars0"><img src="https://avatars.githubusercontent.com/u/148792757?v=4?s=100" width="100px;" alt="sevenstars"/><br /><sub><b>sevenstars</b></sub></a><br /><a href="#doc-sevenstars0" title="Documentation">📖</a></td>
|
||
<td align="center" valign="top" width="14.28%"><a href="https://github.com/LiangJi23333"><img src="https://avatars.githubusercontent.com/u/102958768?v=4?s=100" width="100px;" alt="LiangJi23333"/><br /><sub><b>LiangJi23333</b></sub></a><br /><a href="#doc-LiangJi23333" title="Documentation">📖</a></td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
|
||
<!-- markdownlint-restore -->
|
||
<!-- prettier-ignore-end -->
|
||
|
||
<!-- ALL-CONTRIBUTORS-LIST:END -->
|