Whosthere 开发者指南项目结构、测试规范与开源贡献流程完整解析【免费下载链接】whosthereLocal Area Network discovery tool with an interactive Terminal User Interface (TUI) written in Go. Discover, explore, and understand your LAN in an intuitive way. Knock Knock.. whos there? 项目地址: https://gitcode.com/gh_mirrors/wh/whosthere想参与开源却不知从何下手本文将带你快速上手Whosthere——一款用 Go 编写的局域网LAN发现工具它通过交互式终端界面TUI帮助你在家庭网络中轻松发现设备。读完这篇 Whosthere 开发者指南你将掌握其项目结构、测试规范与开源贡献流程三大核心能力。一、项目结构速览Go TUI 网络扫描器怎么组织的Whosthere 采用典型的 Go 项目分层结构核心思想是internal/与pkg/职责分离目录职责关键文件main.go程序入口注入版本信息后调用命令入口cmd.Executeinternal/cmd/CLI 命令定义TUI、scan、daemon、versionroot.go、scan.gointernal/core/配置、状态、输出、日志等核心逻辑config.go、engine_builder.gointernal/ui/TUI 界面视图、组件、主题app.go、dashboard.gopkg/discovery/可复用的发现引擎ARP/mDNS/SSDP 扫描器 子网遍历engine.go、doc.go分层设计的巧妙之处pkg/discovery/被设计为一个独立可复用的库——你可以在 doc.go 中直接读到它的公开用法文档。项目甚至用了一个测试来强制约束这一边界dependency_boundary_test.go 会在测试阶段扫描所有导入一旦发现pkg/discovery反向依赖了仓库其他内部包测试就会失败。 学习建议阅读 engine_builder.go 可以看到配置如何被组装成扫描引擎——这是理解配置 → 核心 → UI数据流的最佳入口。二、测试规范如何编写可信赖的 Go 测试运行测试的官方姿势项目的 Makefile 定义了完整的开发流程测试命令值得背诵make test # 等价于 go test -v -cover -race -timeout120s -parallel10 ./...四个参数各有讲究-race启用竞态检测器网络扫描器是多协程重灾区这是必选项-cover输出覆盖率保证改动有测试兜底-timeout120s防止死锁导致测试永久挂起-parallel10多包并行执行加速反馈值得借鉴的测试实践单元测试就近放置几乎每个.go文件都有同名_test.go例如 arp_test.go、config_test.go平台隔离的测试替身ARP 缓存读取按操作系统拆分实现如 linux_cache_reader.go各配一个 stub 文件方便在非目标平台跑测试集成/压力测试单独命名engine_stress_test.go、engine_lifecycle_test.go 覆盖了引擎的启动、停止与高负载场景测试辅助工具集中管理pkg/discovery/internal/testkit/ 提供共享的测试构造器避免重复代码断言统一使用 testifyrequire/assert让失败信息清晰可读。三、开源贡献流程从提 Issue 到发版1️⃣ 获取代码并本地构建git clone https://gitcode.com/gh_mirrors/wh/whosthere cd whosthere make buildMakefile 还提供make lintgolangci-lint mdformat、make fmtgofmt mdformat、make release-clean本地快照发布等目标一条make all可跑完完整质量检查。2️⃣ 提交前必须通过的 CI 检查CI 定义在 .github/workflows/ci.yaml在Linux、macOS、Windows 三平台矩阵上执行✅go test -race全量测试✅ golangci-lint 静态检查✅go build构建验证提交代码前建议在本地先跑make fmt make lint make test与 CI 保持一致避免推送后返工。3️⃣ Issue 与 PR 规范Bug 报告使用 .github/ISSUE_TEMPLATE/bug_report.md 模板需附whosthere version输出、复现步骤与日志功能建议使用 .github/ISSUE_TEMPLATE/feature_request.md 模板重要改动先讨论README 明确要求——实现较大变更前请先在 Issue 中发起讨论见 README.md 的 Contributing 部分4️⃣ 版本发布打了 Tag 就能发版发布流程由 .github/workflows/release.yaml 自动化推送符合vX.Y.Z格式的 Git Tag 后自动触发 GoReleaser 构建多平台二进制并生成 Release 页面。版本号、commit 号通过-ldflags注入 main.go 中的变量你无需关心发布细节。5️⃣ 小而美的贡献切入点对新手友好的起点添加主题在 internal/ui/theme/theme.go 中新增配色README 明确欢迎此类 PROUI 数据库更新项目提供了 scripts/update-oui.sh 脚本刷新厂商库修复 Bug从带bug标签的 Issue 入手小改动、高价值总结Whosthere 结构清晰、测试严谨、CI/CD 自动化完善是学习Go 网络工具开发与开源协作流程的优质范本。建议按读 doc.go → 改一个小主题 → 跑通make test→ 提交首个 PR的路径完成你的第一次贡献。Knock knock——现在轮到你在网络世界中登场了 【免费下载链接】whosthereLocal Area Network discovery tool with an interactive Terminal User Interface (TUI) written in Go. Discover, explore, and understand your LAN in an intuitive way. Knock Knock.. whos there? 项目地址: https://gitcode.com/gh_mirrors/wh/whosthere创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 Whosthere 开发者指南：项目结构、测试规范与开源贡献流程完整解析
Whosthere 开发者指南项目结构、测试规范与开源贡献流程完整解析【免费下载链接】whosthereLocal Area Network discovery tool with an interactive Terminal User Interface (TUI) written in Go. Discover, explore, and understand your LAN in an intuitive way. Knock Knock.. whos there? 项目地址: https://gitcode.com/gh_mirrors/wh/whosthere想参与开源却不知从何下手本文将带你快速上手Whosthere——一款用 Go 编写的局域网LAN发现工具它通过交互式终端界面TUI帮助你在家庭网络中轻松发现设备。读完这篇 Whosthere 开发者指南你将掌握其项目结构、测试规范与开源贡献流程三大核心能力。一、项目结构速览Go TUI 网络扫描器怎么组织的Whosthere 采用典型的 Go 项目分层结构核心思想是internal/与pkg/职责分离目录职责关键文件main.go程序入口注入版本信息后调用命令入口cmd.Executeinternal/cmd/CLI 命令定义TUI、scan、daemon、versionroot.go、scan.gointernal/core/配置、状态、输出、日志等核心逻辑config.go、engine_builder.gointernal/ui/TUI 界面视图、组件、主题app.go、dashboard.gopkg/discovery/可复用的发现引擎ARP/mDNS/SSDP 扫描器 子网遍历engine.go、doc.go分层设计的巧妙之处pkg/discovery/被设计为一个独立可复用的库——你可以在 doc.go 中直接读到它的公开用法文档。项目甚至用了一个测试来强制约束这一边界dependency_boundary_test.go 会在测试阶段扫描所有导入一旦发现pkg/discovery反向依赖了仓库其他内部包测试就会失败。 学习建议阅读 engine_builder.go 可以看到配置如何被组装成扫描引擎——这是理解配置 → 核心 → UI数据流的最佳入口。二、测试规范如何编写可信赖的 Go 测试运行测试的官方姿势项目的 Makefile 定义了完整的开发流程测试命令值得背诵make test # 等价于 go test -v -cover -race -timeout120s -parallel10 ./...四个参数各有讲究-race启用竞态检测器网络扫描器是多协程重灾区这是必选项-cover输出覆盖率保证改动有测试兜底-timeout120s防止死锁导致测试永久挂起-parallel10多包并行执行加速反馈值得借鉴的测试实践单元测试就近放置几乎每个.go文件都有同名_test.go例如 arp_test.go、config_test.go平台隔离的测试替身ARP 缓存读取按操作系统拆分实现如 linux_cache_reader.go各配一个 stub 文件方便在非目标平台跑测试集成/压力测试单独命名engine_stress_test.go、engine_lifecycle_test.go 覆盖了引擎的启动、停止与高负载场景测试辅助工具集中管理pkg/discovery/internal/testkit/ 提供共享的测试构造器避免重复代码断言统一使用 testifyrequire/assert让失败信息清晰可读。三、开源贡献流程从提 Issue 到发版1️⃣ 获取代码并本地构建git clone https://gitcode.com/gh_mirrors/wh/whosthere cd whosthere make buildMakefile 还提供make lintgolangci-lint mdformat、make fmtgofmt mdformat、make release-clean本地快照发布等目标一条make all可跑完完整质量检查。2️⃣ 提交前必须通过的 CI 检查CI 定义在 .github/workflows/ci.yaml在Linux、macOS、Windows 三平台矩阵上执行✅go test -race全量测试✅ golangci-lint 静态检查✅go build构建验证提交代码前建议在本地先跑make fmt make lint make test与 CI 保持一致避免推送后返工。3️⃣ Issue 与 PR 规范Bug 报告使用 .github/ISSUE_TEMPLATE/bug_report.md 模板需附whosthere version输出、复现步骤与日志功能建议使用 .github/ISSUE_TEMPLATE/feature_request.md 模板重要改动先讨论README 明确要求——实现较大变更前请先在 Issue 中发起讨论见 README.md 的 Contributing 部分4️⃣ 版本发布打了 Tag 就能发版发布流程由 .github/workflows/release.yaml 自动化推送符合vX.Y.Z格式的 Git Tag 后自动触发 GoReleaser 构建多平台二进制并生成 Release 页面。版本号、commit 号通过-ldflags注入 main.go 中的变量你无需关心发布细节。5️⃣ 小而美的贡献切入点对新手友好的起点添加主题在 internal/ui/theme/theme.go 中新增配色README 明确欢迎此类 PROUI 数据库更新项目提供了 scripts/update-oui.sh 脚本刷新厂商库修复 Bug从带bug标签的 Issue 入手小改动、高价值总结Whosthere 结构清晰、测试严谨、CI/CD 自动化完善是学习Go 网络工具开发与开源协作流程的优质范本。建议按读 doc.go → 改一个小主题 → 跑通make test→ 提交首个 PR的路径完成你的第一次贡献。Knock knock——现在轮到你在网络世界中登场了 【免费下载链接】whosthereLocal Area Network discovery tool with an interactive Terminal User Interface (TUI) written in Go. Discover, explore, and understand your LAN in an intuitive way. Knock Knock.. whos there? 项目地址: https://gitcode.com/gh_mirrors/wh/whosthere创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考