Skip to content

Commit ae5d8c9

Browse files
committed
调整目录结构,统一远程调用地址
1 parent e65da97 commit ae5d8c9

9 files changed

+352
-84
lines changed

Development.md

+169
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
## **一、欢迎**
2+
3+
感谢你对 NodeScriptKit 的兴趣!本指南将帮助你快速上手开发流程,提交代码并参与项目建设。无论你是修复 Bug、添加功能还是完善文档,我们都欢迎你的贡献。
4+
5+
6+
## **二、环境搭建**
7+
8+
9+
### **前置条件**
10+
11+
12+
13+
* **操作系统**:Linux(推荐 Debian、Ubuntu、CentOS 或 Alpine)。
14+
* **权限**:需要 root 权限运行脚本。
15+
* **工具**
16+
* `bash`:核心脚本语言。
17+
* `curl``wget`:用于下载外部资源。
18+
* `git`:用于版本控制。
19+
20+
21+
### **获取代码**
22+
23+
克隆仓库:
24+
25+
```
26+
git clone [email protected]:NodeSeekDev/NodeScriptKit.git
27+
cd NodeScriptKit
28+
```
29+
30+
31+
32+
### **安装依赖**
33+
34+
运行以下命令安装基本依赖:
35+
36+
```
37+
apt update && apt install -y curl wget git # Debian/Ubuntu
38+
yum install -y curl wget git # CentOS
39+
apk add curl wget git # Alpine
40+
```
41+
42+
## **三、代码结构**
43+
44+
45+
* **主文件**`nodescriptkit.sh`(假设为你的脚本文件名)。
46+
* **核心功能**
47+
* `display_menu`:主菜单入口。
48+
* `sys_info`:系统信息查询。
49+
* `tcp_tune`:TCP 参数优化。
50+
* 更多模块见脚本注释。
51+
* **外部资源**:部分功能依赖在线脚本(如 `bbr.sh`)。
52+
53+
54+
## **四、开发规范**
55+
56+
57+
### **命名规则**
58+
59+
60+
61+
* **函数名**:小写加下划线,如 `get_system_info`
62+
* **变量名**:清晰描述用途,如 `ipv4_address`
63+
* **颜色变量**:使用现有定义,如 `RED``GREEN`
64+
65+
具体可阅读脚本 <示例代码>
66+
67+
68+
### **代码风格**
69+
70+
* **缩进**:使用 2 或 4 个空格(保持一致)。
71+
* **注释**:关键功能需添加简要说明,例如:
72+
73+
74+
* **函数名**:小写加下划线,如 `get_system_info`
75+
* **变量名**:清晰描述用途,如 `ipv4_address`
76+
* **颜色变量**:使用现有定义,如 `RED``GREEN`
77+
78+
具体可阅读脚本 <示例代码>
79+
80+
81+
### **代码风格**
82+
* **缩进**:使用 2 或 4 个空格(保持一致)。
83+
* **注释**:关键功能需添加简要说明,例如:
84+
85+
```
86+
# 获取系统运行时间
87+
runtime=$(cat /proc/uptime | awk ...)
88+
```
89+
错误处理:使用 danger、success 等函数提示用户:
90+
91+
```
92+
success "执行成功!"
93+
danger "请以 root 权限运行脚本!"
94+
```
95+
96+
### **提交要求**
97+
98+
* **单一目的**:每个 PR 解决一个问题或添加一个功能。
99+
* **提交信息**
100+
* 格式:`[类别] 描述`,如 `[Fix] 修复 IPv6 获取失败问题`
101+
* 类别可选:`[Feat]`(新功能)、`[Fix]`(修复)、`[Docs]`(文档)等。
102+
103+
## **五、开发流程**
104+
105+
### **1. Fork 与分支**
106+
107+
1) Fork 仓库。
108+
109+
2). 创建功能分支,如:
110+
111+
```
112+
git checkout -b feature/add-database-tool
113+
```
114+
115+
### **2. 修改与测试**
116+
117+
- 基于<示例代码>规范,编辑脚本,添加或优化功能。
118+
119+
- 本地测试:
120+
121+
```
122+
nsk
123+
```
124+
125+
- 示例:运行 检查系统信息是否正常输出。
126+
- 实机测试:参考 <测试方法>
127+
128+
### **3. 提交代码**
129+
130+
1. 提交更改:
131+
132+
```
133+
git add .
134+
git commit -m "[Feat] 添加数据库管理工具"
135+
```
136+
137+
2. 推送到远程:
138+
139+
```
140+
git push origin feature/add-database-tool
141+
```
142+
143+
### **4. 提交 Pull Request**
144+
145+
- 在 GitHub 上创建 PR,描述你的改动和测试结果。
146+
- 等待维护者审核。
147+
148+
149+
## **六、测试方法**
150+
151+
* **环境**:建议使用虚拟机(如 VirtualBox)或 VPS。
152+
* **步骤**
153+
1. 运行完整脚本,检查菜单功能。
154+
2. 测试特定模块,如 `nsk -> 选择分类,测试最终结果符合预期`
155+
3. 检查错误日志,确保无异常退出。
156+
* **兼容性**:在不同系统(Debian、CentOS)上验证
157+
158+
159+
## **七、已知问题**
160+
* 部分功能依赖网络,可能因连接问题失败。
161+
162+
该部分逐步补充...
163+
164+
165+
## **八、获取帮助**
166+
167+
* **社区**:加入 [Telegram 频道](https://t.me/NodeSelect) 或 GitHub Discussions。
168+
169+
让我们一起让 NodeScriptKit 更强大!

Rules.md

+118
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
## **一、介绍**
2+
3+
NodeScriptKit 是一个面向 VPS 和独立服务器用户的开源脚本工具集,旨在通过一键式脚本简化系统管理、网络测试和性能优化。我们致力于为用户提供高效、易用的工具,同时欢迎社区成员共同完善项目。
4+
5+
当前,我们正在扩展功能并提升稳定性,需要更多热情的贡献者加入。如果你对 Linux 系统管理、脚本开发或社区建设感兴趣,欢迎成为 NodeScriptKit 的一员!
6+
7+
8+
## **二、承诺**
9+
10+
作为 NodeScriptKit 社区的成员、贡献者和负责人,我们致力于为每个人提供一个开放、友好、包容和尊重的工作环境,不论其年龄、性别、种族、国籍、技术水平或其他特征。
11+
12+
我们相信,多元化的视角和协作精神是推动项目发展的核心动力。
13+
14+
为了实现这一目标,我们承诺在社区互动中遵循以下原则,并期待所有参与者共同遵守。
15+
16+
17+
## **三、行为准则**
18+
19+
20+
### **期待的行为**
21+
22+
我们鼓励以下行为,以营造积极的社区氛围:
23+
24+
25+
26+
* **尊重与包容**:尊重他人的意见、经验和贡献,即使存在分歧。
27+
* **协作精神**:积极分享知识,协助他人解决问题。
28+
* **建设性反馈**:提供清晰、有帮助的建议,推动项目改进。
29+
* **友善沟通**:使用礼貌和鼓励的语言,避免攻击性或贬低性言辞。
30+
* **责任感**:对自己的贡献负责,确保代码和文档的质量。
31+
32+
33+
### **不可接受的行为**
34+
35+
以下行为在 NodeScriptKit 社区中是不被容忍的:
36+
37+
38+
39+
* **骚扰与歧视**:针对个人或群体的辱骂、威胁、歧视性言论或任何形式的骚扰。
40+
* **恶意行为**:故意提交破坏性代码、散布虚假信息或干扰社区运作。
41+
* **人身攻击**:针对他人的外貌、能力或身份进行负面评论。
42+
* **不当内容**:发布色情、暴力或其他不适当的内容。
43+
* **违反隐私**:未经同意泄露他人的个人信息。
44+
45+
46+
## **四、贡献规范**
47+
48+
49+
### **如何参与**
50+
51+
52+
53+
* **代码贡献**:通过 Pull Request 提交代码,遵循 中的规范。
54+
* **问题反馈**:在 Issue 页面报告 Bug 或提出建议,提供详细描述。
55+
* **文档完善**:改进使用说明、翻译内容或补充示例。
56+
* **社区讨论**:通过指定的沟通渠道(如 nodeseek 指定的帖子)参与交流。
57+
58+
59+
### **审核与合并**
60+
61+
62+
63+
* 所有贡献将由维护者审核,确保符合项目目标和技术标准。
64+
* 我们鼓励贡献者在提交前自测代码,并附上必要的说明。
65+
66+
67+
## **五、执行与监督**
68+
69+
70+
### **报告问题**
71+
72+
如果您发现任何违反公约的行为,请通过以下方式报告:
73+
74+
* **GitHub**:在仓库的 Issue 页面提交(可匿名)。
75+
* 请提供具体细节(如时间、事件描述、相关链接),以便我们调查。
76+
77+
78+
### **处理流程**
79+
80+
81+
82+
* **调查**:维护团队将对报告进行保密审查,必要时联系相关方。
83+
* **措施**:根据情况采取警告、临时禁言或永久移除等措施。
84+
* **透明性**:在不泄露隐私的前提下,公布处理结果。
85+
86+
87+
### **后果**
88+
89+
违反公约者可能面临以下后果:
90+
91+
92+
93+
* 删除不当内容。
94+
* 暂停或禁止参与社区。
95+
* 在严重情况下,报告给相关平台(如 GitHub )。
96+
97+
98+
## **六、适用范围**
99+
100+
本公约适用于所有与 NodeScriptKit 项目相关的活动,包括但不限于:
101+
102+
103+
104+
* GitHub 仓库(Issue、PR、Discussions 等)。
105+
* 社区沟通渠道(如 Telegram、Nodeseek)。
106+
* 项目相关的线上活动。
107+
108+
109+
## **七、致谢**
110+
111+
本公约参考了[ Contributor Covenant](https://www.contributor-covenant.org/),并根据 NodeScriptKit 社区的实际情况进行了调整。
112+
113+
感谢所有为社区建设贡献力量的成员!
114+
115+
参与的小伙伴,会将您的贡献,书写在感谢榜中保存,用以感谢您的贡献。
116+
117+
118+
让我们共同努力,打造一个卓越的 NodeScriptKit 社区!

modules.d/000-menu.toml

-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ sub_menus = [
66
"test_tool", #测试工具
77
"system_reinstall", #重装系统
88
"system_manage", #系统管理
9-
"hardware_info", #硬件信息
109
"network_tools", #网络工具
1110
"security_tools", #安全工具
1211
"app_deployment", #应用部署

modules.d/020-test_tool.toml

+54-18
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,24 @@ node_quality = "bash <(curl -sL run.NodeQuality.com)"
66
fusion_test = "bash <(curl -sL bash.spiritlhl.net/ecs)"
77
#IP质量
88
ip_quality = "bash <(curl -sL IP.Check.Place)"
9-
#网络质量
10-
network_quality = "bash <(curl -sL Net.Check.Place)"
119

12-
#yabs
13-
yabs = "bash <(curl -sL yabs.sh)"
14-
#benchmark
15-
bench = "bash <(curl -sL bench.sh)"
16-
#superbench
17-
super_bench = "bash <(curl -sL git.io/superbench.sh)"
18-
#supertrace
19-
super_trace = "bash <(curl -sL raw.githubusercontent.com/oooldking/script/master/supertrace.sh)"
10+
network_quality = "bash <(curl -sL Net.Check.Place)" #网络质量
11+
yabs = "bash <(curl -sL yabs.sh)" #yabs
12+
bench = "bash <(curl -sL bench.sh)" #benchmark
13+
super_bench = "bash <(curl -sL git.io/superbench.sh)" #superbench
14+
super_trace = "bash <(curl -sL raw.githubusercontent.com/oooldking/script/master/supertrace.sh)" #supertrace
15+
unlock_test = "bash <(curl -sL Media.Check.Place)" #解锁检测
16+
return_route = "bash <(curl -sL raw.githubusercontent.com/zhanghanyun/backtrace/main/install.sh)" #回程路由
17+
nws_sh = "bash <(curl -sL nws.sh)" #nws
2018

21-
#解锁检测
22-
unlock_test = "bash <(curl -sL Media.Check.Place)"
23-
#回程路由
24-
return_route = "bash <(curl -sL raw.githubusercontent.com/zhanghanyun/backtrace/main/install.sh)"
25-
26-
#nws
27-
nws_sh = "bash <(curl -sL nws.sh)"
2819

20+
#硬件类测试
21+
dedicated_benchmark = "bash <(curl -sL git.io/ceshi)"
22+
disk_write_test = "bash <(curl -sL raw.githubusercontent.com/NodeSeekDev/NodeScriptKit/refs/heads/main/shell_scripts/hardware_info/disk_test.sh)"
23+
lemon_bench_full="bash <(curl -sL raw.githubusercontent.com/LemonBench/LemonBench/main/LemonBench.sh) --full"
24+
lemon_bench_fast="bash <(curl -sL raw.githubusercontent.com/LemonBench/LemonBench/main/LemonBench.sh) --fast"
25+
unix_bench = "bash <(curl -sL github.com/teddysun/across/raw/master/unixbench.sh)"
26+
memory_check = "bash <(curl -sL raw.githubusercontent.com/uselibrary/memoryCheck/main/memoryCheck.sh)"
2927

3028
[[menus]]
3129
id = "test_tool"
@@ -42,6 +40,13 @@ sub_menus = [
4240
"return_route",
4341
"super_trace",
4442
"nws_sh",
43+
44+
'dedicated_benchmark',
45+
'lemon_bench_full',
46+
'lemon_bench_fast',
47+
'unix_bench',
48+
'disk_write_test',
49+
'memory_check',
4550
]
4651

4752
[[menus]]
@@ -97,4 +102,35 @@ script = "super_trace"
97102
[[menus]]
98103
id = "nws_sh"
99104
title = "综合测速"
100-
script = "nws_sh"
105+
script = "nws_sh"
106+
107+
[[menus]]
108+
id = "dedicated_benchmark"
109+
title = "独服基准脚本"
110+
script = "dedicated_benchmark"
111+
112+
[[menus]]
113+
id = "disk_write_test"
114+
title = "硬盘写入测试"
115+
script = "disk_write_test"
116+
117+
[[menus]]
118+
id = "memory_check"
119+
title = "超售测试"
120+
script = "memory_check"
121+
122+
123+
[[menus]]
124+
id = "lemon_bench_full"
125+
title = "LemonBench[完整版]"
126+
script = "lemon_bench_full"
127+
128+
[[menus]]
129+
id = "lemon_bench_fast"
130+
title = "LemonBench[快速版]"
131+
script = "lemon_bench_fast"
132+
133+
[[menus]]
134+
id = "unix_bench"
135+
title = "UnixBench"
136+
script = "unix_bench"

0 commit comments

Comments
 (0)