Skip to content

Commit

Permalink
feat(doc/contribute): landscaping
Browse files Browse the repository at this point in the history
Landscaping, no content changes.
  • Loading branch information
alex3236 committed Oct 2, 2024
1 parent cdef03d commit 9fe1128
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 22 deletions.
24 changes: 13 additions & 11 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
**English** | [中文](CONTRIBUTING_cn.md)

# Contributing Guidelines
<div align="center">
<h1>✨<br/>Contributing Guidelines</h1>
</div>

We are truly honored and grateful for your willingness to contribute to this project.

Expand All @@ -12,9 +14,9 @@ _Italic contents are **suggestions**_, while the rest are **requirements**, both

We hope this guide can be a great starting point for you!

## Adding or modifying plugin?
## 🔧 Adding or modifying plugin?

### Is your plugin suitable for the catalogue?
### 🤔 Is your plugin suitable for the catalogue?

Do not submit plugins in a hurry. Before creating and submitting new plugins, consider the following questions:

Expand All @@ -24,7 +26,7 @@ Do not submit plugins in a hurry. Before creating and submitting new plugins, co
- _Is the plugin commonly applicable? Can new users have reasons to use your plugin? —— Do not submit self-use only or completely useless plugins_;
- _Is your project ready for public testing (beta)? —— If it is still in an early stage, wait until it is ready. We recommend to ensure that the plugin has an available release when submitting_.

### Attention to copyrights
### ⚖️ Attention to copyrights

Users submitting plugins to the plugin catalogue should be in one of the following capacities:
- Author, maintainer, or collaborator of the plugin;
Expand All @@ -40,15 +42,15 @@ If your plugin references or uses codes from other projects:
- **By submitting your plugin, you authorize everyone to download and use your plugin from Github Releases direct or indirectly, over and above the proprietary agreement (or license, if any)**;
- **Your submission PR may take longer to process**.

### Uniqueness and compatibility
### 🌟 Uniqueness and compatibility

- Plugin name and ID should not be **too similar** to other plugins;
_As a reference, a quantification standard is: the [Levenshtein Distance](https://en.wikipedia.org/wiki/Levenshtein_distance) between the lowercase name and ID of your plugin and other's should not be less than 3_
- Explicitly declare required plugins and/or Python packages in corresponding fields
_Mind if your plugin uses specific interfaces in new versions of MCDR, declare the MCDR version as necessary_;
- Make sure that your plugin works properly on target platforms.

### Write plugin information correctly
### ✒️ Write plugin information correctly

**Create or edit `plugin_info.json` as described in [documentation](https://docs.mcdreforged.com/en/latest/plugin_dev/plugin_catalogue.html).**

Expand All @@ -57,32 +59,32 @@ If your plugin references or uses codes from other projects:
- **Plugin ID must be consistent at all places**;
- **`description` and `introduction` fields should provide correctly, at least in one language**;

### Introduce your plugin properly
### 📢 Introduce your plugin properly

A good and detailed introduction is one of the conditions for becoming an excellent plugin.

- In the README or documentation, explain the plugin's functions, features, usage, etc. in detail;
- In the `description`, briefly summarise what the plugin does in one sentence;
- Introduce the plugin's features in the `introduction`, or direct reference it to the README file.

### One PR for one thing
### 🔂 One PR for one thing

- When adding plugins, please submit multiple plugins in separate PRs;
- When modifying plugins, changes to the same fields in multiple plugins by the same author can be combined in one PR;
- When deleting plugins, multiple plugins of the same author can be combined in one PR.

### Wait patiently after submitting
### Wait patiently after submitting

After submitting a PR, catalogue maintainers will review your plugin asap. They will base their response on the results of automatic checks, this guide, and their personal judgment. If they can not make a decision, your PR may be assigned to a higher-level maintainer. During this process, you can choose whether or not to accept their suggestions (if any). Those suggestions may help your plugin merge more smoothly into the catalogue.

### Be careful when releasing
### 📦 Be careful when releasing

**Refer to the [documentation](https://docs.mcdreforged.com/en/latest/plugin_dev/plugin_catalogue.html#release) when releasing plugin versions.**

- **The Release must be tagged in correctly**, otherwise the catalogue will not be able to get that version;
- Upload the packaged plugin (`.mcdr` or `.pyz`) as an asset.

## Contributing to scripts or workflows?
## 🛠️ Contributing to scripts or workflows?

- It is recommended to create an Issue first, describing the problem or request, and then create the PR associated with it;
- All changes should be merged into the `master` branch.
Expand Down
24 changes: 13 additions & 11 deletions CONTRIBUTING_cn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
[English](CONTRIBUTING.md) | **中文**

# 贡献指南
<div align="center">
<h1>✨<br/>贡献指南</h1>
</div>

我们非常荣幸并感激您愿意为本项目做出贡献。

Expand All @@ -12,9 +14,9 @@ _斜体部分属于**建议**_,其余属于**要求**,均作为您开发过

希望这份指南能成为您的良好起点!

## 添加或修改插件?
## 🔧 添加或修改插件?

### 插件适合入库吗?
### 🤔 插件适合入库吗?

不要急于求成。在创作并提交新插件之前,思考如下问题:

Expand All @@ -24,7 +26,7 @@ _斜体部分属于**建议**_,其余属于**要求**,均作为您开发过
- _插件泛用性是否足够?是否有足够的理由让新用户选择你的插件?——不要将仅供自用或完全不实用的插件提交到插件库_
- _你的项目准备好进入公众测试(Beta)阶段了吗?——如果它还处于早期版本,请先将其完善。我们建议您在提交时保证插件已有一个可用 Release_

### 版权意识很重要
### ⚖️ 版权意识很重要

为保证提交正确,我们希望您能符合以下身份之一:
- 插件的作者、维护者或是被授权的协作者;
Expand All @@ -40,15 +42,15 @@ _斜体部分属于**建议**_,其余属于**要求**,均作为您开发过
- **通过提交您的插件至插件库,您在专有协议或许可之外(如果有),授予任何实体直接或间接地从 Github Releases 下载和使用您插件的权利**
- **您的提交请求可能需要更长的处理时间**

### 前置工作要注意
### 🌟 前置工作要注意

- 插件名称和 ID 不要与其他插件**太过相似**
_作为参考,一种量化标准为:转为小写的插件名称和 ID 与其他插件相应字段的 [莱文斯坦距离](https://zh.wikipedia.org/wiki/%E8%90%8A%E6%96%87%E6%96%AF%E5%9D%A6%E8%B7%9D%E9%9B%A2) 不应小于 3_
- 在相应字段中显式声明前置插件和 Python 包,
_留意你的插件是否是用了新版本 MCDR 特有的接口,按需声明 MCDR 版本_
- 确保你的插件在目标平台上可以正常工作。

### 插件信息要写对
### ✒️ 插件信息要写对

**按照 [文档](https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/plugin_catalogue.html) 中的说明创建或编辑 `plugin_info.json`**

Expand All @@ -57,32 +59,32 @@ _斜体部分属于**建议**_,其余属于**要求**,均作为您开发过
- **插件 ID 必须在各个环节保持一致;**
- **`description``introduction` 字段应当正确,至少提供一种语言。**

### 插件介绍要写好
### 📢 插件介绍要写好

良好且详细的介绍是成为优秀插件的条件之一。

- 在 README 或文档中,详细阐释插件的环境要求、功能、特征、用法等;
-`description` 中用一句话简单概括插件的作用;
-`introduction` 中介绍插件的特点,或直接指向 README 文件。

### 一个 PR 一件事
### 🔂 一个 PR 一件事

- 添加插件时,请将多个插件分开 PR;
- 修改插件时,相同作者多个插件的相同字段修改可以合并在一个 PR 中;
- 删除插件时,相同作者的多个插件可以合并在一个 PR 中。

### 交了 PR 别着急
### 交了 PR 别着急

提交 PR 后,插件库维护者将尽快审酌您的插件。他们将根据自动检查结果、该指南和个人判断,给出相应的反馈。如果他们无法做出决定,您的 PR 可能交予上一级维护者处理。在这一过程中,您可以自行决定是否采纳他们的建议(如果有)。这些建议可能帮助您的插件更加顺畅地并入插件库。

### 发版本时要小心
### 📦 发版本时要小心

**参照 [文档](https://docs.mcdreforged.com/zh-cn/latest/plugin_dev/plugin_catalogue.html#release) 发布插件版本。**

- **Release Tag 必须正确填写**,否则插件库无法获取版本地址;
- 将打包插件(`.mcdr``.pyz`)作为附件上传。

## 贡献脚本或工作流?
## 🛠️ 贡献脚本或工作流?

- 建议先创建 Issue,描述问题或需求,再创建与之关联的 PR;
- 所有修改应当合并到 `master` 分支。
Expand Down

0 comments on commit 9fe1128

Please sign in to comment.