Files
v2ray_simple/CONTRIBUTING.md

2.3 KiB
Raw Blame History

学习本作理念

代码的理念就是极简!这也是本项目名字由来!

根据 奥卡姆剃刀原理,不要搞一大堆复杂机制,最简单的能实现的代码就是最好的代码。

想要为本作贡献的同学,要学习本作的这些理念,并能够贯彻你的代码。

不够极简或者解释不够清晰的代码我们将会进行淘汰或修正。

所有issue和 PR 尽量用中文

所有issue和 PR 尽量用中文

本项目不考虑应用 i18n. 这是本项目的强制约定。

以后可以考虑 "zh i18n", 以中文作为基础 然后翻译到别的语言。

所发的PR是有优先级的

随着项目不断扩大,一些对不同成分的优化会有不同的优先级

重要性按如下顺序排列:

  1. 代理问题如果直接就导致无法代理或者闪退这是重大bug必须立即在下一个beta版本修复
  2. 协议是否有bug、程序是否有安全问题、内存泄漏问题等这个也很重要。必须在下一个正式版本修复
  3. 原作功能补充
  4. 新功能添加
  5. 代码优化、代码结构性问题。这个因为结构性问题比较复杂,需要慢慢实现,慢慢改
  6. 编译优化,这个是低优先级,而且也是很好处理的。
  7. 安装教程、一键脚本、安卓客户端等。这个有时间再说,最低优先级。安装教程我也有一份 install.md ,不定时更新。

对于一些人的PR我会做出一些指导有时并给予临时性修复。我的临时修改只是一种指导性含义作为PR的原作者你需要自己维护自己代码的质量要理解我的临时修改不能当作最终修改要自己想出最完善的修改。

我们每个人都是有日常生活的,能照顾本项目已经很不错了,不要指望什么都能想到,也不要指望不犯错 ,我们要互相包容,做到自己最好,多写代码,少进行没有意义的指责。

github action

每push一次进行一次test

每发布一个release进行一次 build_release

build_release 会编译适当数量的 目标平台 可执行文件。

如需要更多平台的编译文件,可以手动执行 build_release_extra, 它会要求你输入一个tag然后它会为该tag的代码 编译出额外平台的 可执行文件。