|
1 | 1 | # Contributing Guide |
2 | 2 |
|
| 3 | +Thank you for your interest and contribution to this project! |
| 4 | +To ensure the stability, robustness, and good user experience of this project, please read the following guidelines before submitting a PR or feature request. |
| 5 | + |
| 6 | +## Accepted PRs |
| 7 | +- Stability improvements |
| 8 | +- Robustness enhancements |
| 9 | +- Bug fixes |
| 10 | + |
| 11 | +PRs of these types can be submitted directly. |
| 12 | + |
| 13 | +## Feature Request Process |
| 14 | +If you want to propose a new feature, please **open an Issue for discussion first**. |
| 15 | +After we evaluate whether the feature is necessary, you can start development. This helps avoid wasting your valuable time. |
| 16 | + |
| 17 | +## Feature Acceptance Criteria |
| 18 | + |
| 19 | +### ✅ Welcomed Features |
| 20 | +1. **General-purpose features** |
| 21 | + - High-frequency needs for non-technical users |
| 22 | + - No additional learning cost or extra steps required |
| 23 | + |
| 24 | +2. **Advanced features** |
| 25 | + - High-frequency needs for technical users (e.g., bypass routing, custom configurations) |
| 26 | + - Moderate increase in learning cost or steps is acceptable |
| 27 | + - Provided as toggles in the **Developer Page**, not shown in regular user-facing interfaces |
| 28 | + |
| 29 | +### ❌ Features We Do Not Accept |
| 30 | +- Very niche, overly customized, self-entertaining, or whimsical requests |
| 31 | +- Features that involve modifications to the **sing-box core code** |
| 32 | +- Even with highly polished code, such PRs will not be accepted |
| 33 | + |
| 34 | +--- |
| 35 | + |
| 36 | + |
| 37 | +Thank you for your understanding and support! |
| 38 | +Let’s work together to make this project more stable, user-friendly, and sustainable 🚀 |
| 39 | + |
| 40 | +--- |
| 41 | + |
| 42 | + |
| 43 | +# 贡献指南 |
| 44 | + |
3 | 45 | 感谢你对本项目的关注与贡献! |
4 | 46 | 为了保证项目的稳定性、健壮性,以及良好的用户体验,请在提交 PR 或功能请求前阅读以下指南。 |
5 | 47 |
|
|
8 | 50 | - 健壮性提升 |
9 | 51 | - Bug 修复 |
10 | 52 |
|
11 | | -这类 PR 可以直接提交。 |
| 53 | +以上类型的 PR 可以直接提交。 |
12 | 54 |
|
13 | 55 | ## 功能请求流程 |
14 | 56 | 如果你希望添加新功能,请 **先提交 Issue 进行讨论**。 |
15 | | -在我们评估功能的必要性后,再由你开发会更合适,避免浪费你的宝贵时间。 |
| 57 | +在我们评估功能的必要性后,再由你开发会更合适,避免浪费你的宝贵时间。 |
16 | 58 |
|
17 | 59 | ## 功能接受标准 |
18 | 60 |
|
|
31 | 73 | - 涉及 **sing-box 内核代码修改** 的功能 |
32 | 74 | - 即使代码完成度很高,我们也不会接受此类 PR |
33 | 75 |
|
| 76 | + |
34 | 77 | --- |
35 | 78 |
|
36 | 79 | 感谢理解与支持! |
37 | | -让我们一起让本项目更加稳定、易用和可持续发展 🚀 |
| 80 | +让我们一起让本项目更加稳定、易用和可持续发展 🚀 |
| 81 | + |
0 commit comments