mirror of
https://github.com/MCSManager/MCSManager.git
synced 2024-11-27 06:59:54 +08:00
50 lines
2.6 KiB
Markdown
50 lines
2.6 KiB
Markdown
## English 🌎
|
||
|
||
### Purpose
|
||
|
||
To prevent uncontrolled growth of features and wasted effort after submitting PRs that are not merged, these notices are hereby written.
|
||
|
||
### Submitting New Features
|
||
|
||
If you wish to submit a new feature via a Pull Request, please first open an issue to inform the developer @unitwk. After discussion, we will decide together whether the feature should be developed.
|
||
|
||
We will consider whether to merge this feature into the master branch from three perspectives: `scope of code impact`, `practicality of the feature`, and `estimated number of applicable users`.
|
||
|
||
Otherwise, unrestrained addition of features will inevitably lead to the continuous bloating of software functionality, which will sooner or later result in very serious security vulnerabilities.
|
||
|
||
### Iterating Old Features
|
||
|
||
Fixing or upgrading an existing feature, **without exceeding the responsibilities of the old feature**, **does not require opening an issue for discussion**. You can directly submit a Pull Request, and after testing and Code Review, it will be merged.
|
||
|
||
**Code in open-source projects often exists for several years or even decades. Due to differences in developer habits, implementation approaches, and code styles, we need some rules and constraints to ensure the long-term health of the code. Thank you for your understanding.**
|
||
|
||
### How to Contribute Code?
|
||
|
||
Please refer to the `Development` section in the README.md file.
|
||
|
||
<br />
|
||
|
||
## 中文 🌏
|
||
|
||
### 目的
|
||
|
||
为了防止功能无节制增长和提交 PR 之后未得到合并浪费工作精力，特此写下这些须知通告。
|
||
|
||
### 提交新功能
|
||
|
||
如果你想 `Pull Request` 一个新功能，请先开启一个 `issue` 告知开发者 @unitwk ，我们一起经过讨论之后，再决定这个功能是否应该开发。
|
||
|
||
我们会从`代码影响范围`，`功能实用性`和`估算的适用群体人数` 三个角度来考虑这个功能是否应该合并到 master 分支。
|
||
|
||
否则，无节制的新增功能必将导致软件功能不断臃肿，从而迟早会有一天会出现非常严重的安全漏洞。
|
||
|
||
### 迭代旧功能
|
||
|
||
修复或升级某个现有的功能，在**不超出旧功能的职责**情况下，**无需开 `issue` 进行讨论**，你可以直接提交 `Pull Request`，在经过测试和 `Code Review`后，都会给予合并。
|
||
|
||
**开源项目的代码通常会存在几年甚至十年以上，由于每个开发者习惯不同，实现思路不同，代码风格不同，所以我们需要有一定的规则约束来让代码长期健康的活下去，谢谢你的理解。**
|
||
|
||
### 如何贡献代码？
|
||
|
||
请阅读 README.MD 文件的 `Development` 段落。
|