-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c65744a
commit 7bb4840
Showing
4 changed files
with
129 additions
and
4 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 |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # minecraftctl 贡献指南 | ||
|
|
||
| [](https://github.com/MemoryShadow/minecraftctl/actions/workflows/main.yml) | ||
| [](https://github.com/MemoryShadow/minecraftctl/tree/i18n) | ||
| [](https://github.com/MemoryShadow/minecraftctl/releases/latest) | ||
| [](LICENSE) | ||
| [](https://github.com/RichardLitt/standard-readme) | ||
|
|
||
| ## 您遇到了一个BUG? | ||
|
|
||
| 1. 在 Github 的 [Issue](https://github.com/MemoryShadow/minecraftctl/issues) 页面中搜索相关的问题, 确保之前从没有人遇到过它. | ||
| 2. 如果你确保你这个问题从没有人提出过, 请[创建一个新Issues](https://github.com/MemoryShadow/minecraftctl/issues/new)并在其中详细的描述你遇到的问题和复现的方法. | ||
| 3. 如果可以, 最好能附加上你使用的上下文命令以及使用的系统环境以帮助我们复现该问题, 如果你有更好的建议, 欢迎也放到这里来. | ||
|
|
||
| ## 您写了一个修补BUG的补丁? | ||
|
|
||
| 1. 在 Github 上打开一个新的 PR. | ||
| 2. 确保这个 PR 能清晰的描述这个问题和你使用的解决方案, 如果有一个与之对应的 Issue 请附上它的编号. | ||
| 3. 在提交之前, 请确保你的提交遵循[约定式提交](https://www.conventionalcommits.org/zh-hans/v1.0.0-beta.4/), 如果不遵循有可能导致你的提交被压缩. 如果完全遵循我们会在验证后变基合并. | ||
|
|
||
| ## 您调整了空格, 格式化了代码或是制作了纯粹的装饰性补丁? | ||
|
|
||
| 那些本质上是装饰性的, 并没有对 minecraftctl 本身的稳定性, 功能性或可测试性增加任何实质性内容的更改通常不会被接受. 这些调整往往在开发某个功能时就会被顺带处理. | ||
|
|
||
| ## 您打算新增功能还是调整现有功能? | ||
|
|
||
| 1. 在 [Ideas · Discussions](https://github.com/orgs/minecraftctl/discussions/categories/ideas) 中提出您的更改建议, 然后开始编写代码. | ||
| 2. 在有人参与您的讨论之前, 不要因此创建一个新的 Issue, Issue 主要用于错误报告和修复. | ||
| 3. 我们通常拒绝对核心组件与核心工作模式的更改, 这些问题应当在充分讨论后才可能被接受, 因为我们希望尽可能减少破坏式更新. | ||
|
|
||
| ## 您对源代码有疑问? | ||
|
|
||
| 欢迎在 [General · Discussions](https://github.com/orgs/minecraftctl/discussions/categories/general) 中提出询问关于源代码的任何问题. | ||
|
|
||
| ## 您想为 minecraftctl 文档做贡献吗? | ||
|
|
||
| 我们随时欢迎您的PR, 但别忘了以docs开头且说明您在PR中所做更改的文档. | ||
|
|
||
| minecraftctl 现在是由志愿者维护的项目, 我们欢迎且鼓励您加入我们. | ||
|
|
||
| 谢谢 :heart: :heart: :heart: | ||
|
|
||
| MemoryShadow |
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,8 @@ | ||
| etc/i18n | ||
| etc/*i18n | ||
| .vscode | ||
| .Template | ||
| build/deb | ||
| build/rpm | ||
| */ci | ||
| bin/event/VIRTUAL/command.d/spectator |
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,74 @@ | ||
| # minecraftctl 开发文档 | ||
|
|
||
| 欢迎您的参与 :heart: :heart: :heart:, 本文将会帮助您完成在 `minecraftctl` 的开发前置工作。 | ||
|
|
||
| 阅读并跟随此文档, 您将获得一个完整的 minecraftctl 开发环境. | ||
|
|
||
| ## 目录 | ||
|
|
||
| - [minecraftctl 开发文档](#minecraftctl-开发文档) | ||
| - [目录](#目录) | ||
| - [初始环境](#初始环境) | ||
| - [操作系统](#操作系统) | ||
| - [编辑器环境](#编辑器环境) | ||
| - [依赖项](#依赖项) | ||
| - [RedHat系](#redhat系) | ||
| - [Debian系](#debian系) | ||
| - [ArchLinux系](#archlinux系) | ||
| - [开发与测试环境](#开发与测试环境) | ||
|
|
||
| ## 初始环境 | ||
|
|
||
| - 操作系统: Linux 任一发行版, 在本例中将使用 Arch Linux 进行演示. | ||
| - 编辑器环境: 您使用任何您熟悉的编辑器即可, 本文将使用[Visual Studio Code](https://code.visualstudio.com/)编辑器进行演示. | ||
| - 依赖项(通常使用包管理器即可安装): sudo,git,bash,screen,vim,aria2,curl,tar,zip,unzip,wget,git | ||
|
|
||
| ### 操作系统 | ||
|
|
||
| 由于本项目转为类 Unix 系统设计, 为性能优化使用了不少该系统的特性, 故此开发与测试工作也同样需要在一个类 Unix 系统上进行. | ||
|
|
||
| ### 编辑器环境 | ||
|
|
||
| 本项目所使用的语言为非编译型语言, 由于不需要编译, 因此只需要使用任意一个编辑器即可, 例如: Visual Studio Code, vim, emacs 等, 推荐支持高亮. | ||
|
|
||
| ### 依赖项 | ||
|
|
||
| 本项目在开发, 运行, 调试过程中使用的依赖项均一致. 这里给出一些常见操作系统上的快速安装命令, 如果希望补充, 请参见README的"如何贡献"章节. | ||
|
|
||
| #### RedHat系 | ||
|
|
||
| ```bash | ||
| yum install sudo git bash screen vim aria2 curl tar zip unzip wget git | ||
| ``` | ||
|
|
||
| #### Debian系 | ||
|
|
||
| ```bash | ||
| apt-get install sudo git bash screen vim aria2 curl tar zip unzip wget git | ||
| ``` | ||
|
|
||
| #### ArchLinux系 | ||
|
|
||
| ```bash | ||
| pacman -S sudo git bash screen vim aria2 curl tar zip unzip wget git | ||
| ``` | ||
|
|
||
| ## 开发与测试环境 | ||
|
|
||
| 以root身份执行下方命令即可 | ||
|
|
||
| ```bash | ||
| git clone https://github.com/MemoryShadow/minecraftctl.git | ||
| git clone https://github.com/minecraftctl/I18N.git minecraftctl_i18n | ||
| ln -s `pwd`/minecraftctl_i18n/i18n `pwd`/minecraftctl/etc/i18n | ||
| cd minecraftctl | ||
| ln -s `pwd`/bin /opt/minecraftctl | ||
| ln -s `pwd`/etc /etc/minecraftctl | ||
| ln -s /opt/minecraftctl/minecraftctl /usr/bin/minecraftctl | ||
| ``` | ||
|
|
||
| minecraftctl 现在是由志愿者维护的项目, 我们欢迎且鼓励您加入我们. | ||
|
|
||
| 谢谢 :heart: :heart: :heart: | ||
|
|
||
| MemoryShadow |