From bbb05dca951031bc127df7d86a9ce3b0e9d8dede Mon Sep 17 00:00:00 2001 From: Yuhui Huang Date: Sun, 10 Oct 2021 00:01:14 +0800 Subject: [PATCH] feat: contribution guide. --- Multiplayer/Help/OWNERS | 1 + .../{Multi_Help.md => multiplayer-help.md} | 0 Multiplayer/OWNERS | 1 + Multiplayer/{index.md => multiplayer.md} | 0 README.md | 51 +++++++++++++++++- mod/OWNERS | 1 + Mod-helper/Mod_helper.md => mod/mod.md | 0 {Mod-helper => mod}/mod_install.png | Bin {Mod-helper => mod}/mod_loader.png | Bin 9 files changed, 53 insertions(+), 1 deletion(-) create mode 100644 Multiplayer/Help/OWNERS rename Multiplayer/Help/{Multi_Help.md => multiplayer-help.md} (100%) create mode 100644 Multiplayer/OWNERS rename Multiplayer/{index.md => multiplayer.md} (100%) create mode 100644 mod/OWNERS rename Mod-helper/Mod_helper.md => mod/mod.md (100%) rename {Mod-helper => mod}/mod_install.png (100%) rename {Mod-helper => mod}/mod_loader.png (100%) diff --git a/Multiplayer/Help/OWNERS b/Multiplayer/Help/OWNERS new file mode 100644 index 0000000..f18ff13 --- /dev/null +++ b/Multiplayer/Help/OWNERS @@ -0,0 +1 @@ +wifi-left \ No newline at end of file diff --git a/Multiplayer/Help/Multi_Help.md b/Multiplayer/Help/multiplayer-help.md similarity index 100% rename from Multiplayer/Help/Multi_Help.md rename to Multiplayer/Help/multiplayer-help.md diff --git a/Multiplayer/OWNERS b/Multiplayer/OWNERS new file mode 100644 index 0000000..f18ff13 --- /dev/null +++ b/Multiplayer/OWNERS @@ -0,0 +1 @@ +wifi-left \ No newline at end of file diff --git a/Multiplayer/index.md b/Multiplayer/multiplayer.md similarity index 100% rename from Multiplayer/index.md rename to Multiplayer/multiplayer.md diff --git a/README.md b/README.md index 3ff6c4d..09be96a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,51 @@ # HMCL-docs -Documentations for Hello Minecraft! Launcher +Hello Minecraft! Launcher 帮助文档仓库 + +您可以通过对本仓库提交 Pull Request 的方式来为 HMCL 帮助文档贡献自己的力量！ +本仓库内容使用 Attribution-NonCommercial 4.0 International (CC BY-NC 4.0) 协议（附带额外条款）开放，协议内容请参见 LICENSE 文件。 + +## 贡献 +本仓库组织方式为一篇文章放在一个目录中。如果你要提交 PR，请不要将 md 文件直接放在根目录下。 + +每篇文章的文件夹结构如下： +``` +文件夹
+ *
.md + * img1.png + * img2.png + * ... + * OWNERS +``` + +其中，`
` 表示你的文章的英文名，请仅使用英文字母、数字、中划线、下划线字符，不要使用空格、中文字符。请确保 md 文件名和文件夹名一致。具体可以参考已有文章目录格式。 + +每篇文章由 Markdown 编写的 `
.md` 文件及附带图片组成。此外你还需要在文章目录中添加 OWNERS 文件，以标记该文章由哪些人编写或编辑过。 + +### 添加新文章 + +添加新文章时，请确保你的 PR 仅在根文件夹下创建一个全新的文章目录，并将内容按照上述格式要求存放。你也可以参考已经写好的文章格式。 + +切记不要在一个添加新文章的 PR 里修改其他文章的内容。 + +### 修改已有文章 + +修改已有文章时，请确保你的 PR 仅修改一个文章内容，并在该文章的 OWNERS 里署名。 + +### 文章分类 + +如果你要提交的文章可以被囊括为一个分类，我们推荐你对文章进行分类。 + +目录分类的格式为： +``` +文件夹 + * 文件夹 + * .md + * OWNERS + * 文件夹 + * .md + * OWNERS + * .md + * OWNERS +``` + +具体你可以参考 multiplayer 分类。 \ No newline at end of file diff --git a/mod/OWNERS b/mod/OWNERS new file mode 100644 index 0000000..52f50cf --- /dev/null +++ b/mod/OWNERS @@ -0,0 +1 @@ +asdqp233 \ No newline at end of file diff --git a/Mod-helper/Mod_helper.md b/mod/mod.md similarity index 100% rename from Mod-helper/Mod_helper.md rename to mod/mod.md diff --git a/Mod-helper/mod_install.png b/mod/mod_install.png similarity index 100% rename from Mod-helper/mod_install.png rename to mod/mod_install.png diff --git a/Mod-helper/mod_loader.png b/mod/mod_loader.png similarity index 100% rename from Mod-helper/mod_loader.png rename to mod/mod_loader.png