Skip to content

Contributing Guide

OneOhCloud edited this page Sep 23, 2025 · 1 revision

Contributing Guide

感谢你对本项目的关注与贡献!
为了保证项目的稳定性、健壮性,以及良好的用户体验,请在提交 PR 或功能请求前阅读以下指南。

我们欢迎的 PR

  • 稳定性改进
  • 健壮性提升
  • Bug 修复

这类 PR 可以直接提交。

功能请求流程

如果你希望添加新功能,请 先提交 Issue 进行讨论
在我们评估功能的必要性后,再由你开发会更合适,避免浪费你的宝贵时间。

功能接受标准

✅ 我们欢迎的功能

  1. 普适性功能

    • 面向非计算机专业用户的高频需求
    • 不额外增加学习成本与操作步骤
  2. 进阶功能

    • 面向计算机专业用户的高频需求(例如:旁路由、自定义配置等)
    • 可以适度增加学习成本与操作步骤
    • 将放置在 开发者页面 中,以开关形式提供,不会出现在普通用户的常用界面

❌ 我们不会接受的功能

  • 极小众、过度定制化、自娱自乐或异想天开的需求
  • 涉及 sing-box 内核代码修改 的功能
  • 即使代码完成度很高,我们也不会接受此类 PR

感谢理解与支持!
让我们一起让本项目更加稳定、易用和可持续发展 🚀

Clone this wiki locally