-
Notifications
You must be signed in to change notification settings - Fork 505
Description
English 🌏
Want to Develop a New Feature?
If you want to submit a Pull Request for a new feature, please first open an issue to inform the developer @yumao233 about your idea. We will discuss it together before deciding whether the feature should be developed.
We will evaluate the feature based on three aspects: code impact scope, feature utility, and estimated number of affected users to determine if it should be merged into the master branch.
Otherwise, unchecked addition of new features will inevitably lead to software bloat, which will sooner or later result in security vulnerabilities.
Want to Fix a BUG or Upgrade Feature?
For fixing or upgrading an existing feature, as long as it does not exceed the responsibilities of the original feature, you do not need to open an issue for discussion. You can directly submit a Pull Request, which will be merged after testing and Code Review.
Testing Process
You are responsible for the code you submit and must conduct reliable self-testing before submitting a PR.
We recommend providing multiple images or a video file to prove that your submitted code has passed testing.
Open-source project code often persists for years or even decades. Due to different developer habits, implementation approaches, and coding styles, we need certain rules to ensure the code remains healthy in the long term. Thank you for your understanding.
中文
你想开发一个新功能?
如果你想 Pull Request 一个新功能,请先开启一个 issue 告知开发者 @yumao233 你的想法 ,我们一起经过讨论之后,再决定这个功能是否应该开发。
我们会从 代码影响范围,功能实用性 和 估算的适用群体人数 三个角度来考虑这个功能是否应该合并到 master 分支。
否则,无节制的新增功能必将导致软件功能不断臃肿,从而迟早会有一天会出现安全漏洞。### 你想修复 BUG 或升级旧功能?
修复或升级某个现有的功能,在不超出旧功能的职责情况下,无需开 issue 进行讨论,你可以直接提交 Pull Request,在经过测试和 Code Review后,都会给予合并。
测试流程
你必须对你提交的代码负责,你必须要经过可靠的自测再提交PR。
我们建议你最好提供多张图片或一个视频文件来证明你提交的代码通过测试。
开源项目的代码通常会存在几年甚至十年以上,由于每个开发者习惯不同,实现思路不同,代码风格不同,所以我们需要有一定的规则约束来让代码长期健康的活下去,谢谢你的理解。