0

0

Golang项目的Readme与License规范_打造高质量开源包

P粉602998670

P粉602998670

发布时间:2026-03-15 16:14:49

|

578人浏览过

|

来源于php中文网

原创

go.mod 中 license 字段非法且会被自动删除,真正起作用的是根目录的 LICENSE 或 LICENSE.md 文件;import 路径必须与 go.mod 的 module 声明严格一致;go list -json 的 License 字段不可靠,需人工核对文件内容。

golang项目的readme与license规范_打造高质量开源包

Go module 的 go.mod 里 license 字段没用,别白填

Go 官方工具链(go listgo mod graph)完全不读取 go.mod 中的 license 字段,它甚至不是 Go module 的合法字段——填了会被 go mod tidy 自动删掉。真正起作用的是项目根目录下的 LICENSELICENSE.md 文件,且文件名必须全大写或带标准后缀(.md / .txt),否则 go list -json 返回的 License 字段为空。

  • GitHub 和 pkg.go.dev 都依赖文件系统中真实存在的 LICENSE 文件来识别协议,不是靠解析 go.mod
  • 如果用 MIT 等常见协议,建议直接用 curl -s https://raw.githubusercontent.com/spdx/license-list-data/master/text/MIT.txt > LICENSE 下载官方原文,避免手写漏掉“above copyright notice”等关键句
  • 双协议(如 MIT/Apache-2.0)要合并进一个 LICENSE 文件,并在首行注明:SPDX-License-Identifier: MIT OR Apache-2.0

README.md 里 import path 必须和 go.mod module 值一致

用户复制粘贴 import 语句失败,90% 是因为 README 写的路径和 go.mod 第一行的 module 声明不一致。Go 不允许 import 路径与 module 名不同,也不支持重定向。

  • 检查方式:运行 go list -m,输出必须和 README 里的 import "xxx" 完全匹配(包括大小写、斜杠方向)
  • 常见坑:github.com/username/repogithub.com/username/repo/v2 是两个独立 module,v2+ 必须在 go.mod 中声明为 module github.com/username/repo/v2,且 import 时也必须带 /v2
  • 如果项目支持多版本(如 v1/v2 并存),README 每个版本的示例 import 要分开写清楚,不能只写主干路径

go list -json 输出的 License 字段不可信,得看文件内容

go list -json 返回的 License 字段只是启发式猜测(比如扫描文件头注释里的 “MIT” 字样),不是权威来源。实际合规审查时,它可能把代码里某行注释误判为许可证,也可能漏掉嵌套子模块的独立 LICENSE 文件。

In3D
In3D

把真人变成化身,创建逼真且可自定义的虚拟角色

下载
  • 运行 go list -json -m all | jq -r '.License' 看到空或乱码?先确认根目录是否存在 LICENSE,再检查是否被 .gitignore 忽略了
  • 子模块(如 /cmd/foo)若含独立 LICENSE,go list 不会自动合并,需人工核对;Go module 机制本身不递归管理子目录许可证
  • CI 中建议加一步校验:test -f LICENSE || (echo "ERROR: missing LICENSE file" >&2; exit 1)

README 里不要写 “go get github.com/xxx/yyy”

go get 在 Go 1.16+ 默认只用于包安装(go install),且已弃用直接拉取未带版本的 main 包。现在用户要装 CLI 工具,正确命令是 go install github.com/xxx/yyy@latest,否则会报错 go get: installing executables with 'go get' in module mode is deprecated

立即学习go语言免费学习笔记(深入)”;

  • 如果项目提供二进制发布(GitHub Releases),README 优先推荐 curl | shbrew install,比 go install 更稳定
  • 必须用 go install 时,明确写出版本标签:go install github.com/xxx/yyy@v1.2.3,避免 @latest 导致 CI 缓存污染
  • 别在 README 里教用户 go get -u —— 它会升级所有依赖,大概率破坏兼容性
事情说清了就结束。最常被忽略的其实是 LICENSE 文件编码:必须是 UTF-8 无 BOM,Windows 记事本另存时默认带 BOM,会导致某些扫描工具识别失败。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
golang如何定义变量
golang如何定义变量

golang定义变量的方法:1、声明变量并赋予初始值“var age int =值”;2、声明变量但不赋初始值“var age int”;3、使用短变量声明“age :=值”等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

211

2024.02.23

golang有哪些数据转换方法
golang有哪些数据转换方法

golang数据转换方法:1、类型转换操作符;2、类型断言;3、字符串和数字之间的转换;4、JSON序列化和反序列化;5、使用标准库进行数据转换;6、使用第三方库进行数据转换;7、自定义数据转换函数。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

247

2024.02.23

golang常用库有哪些
golang常用库有哪些

golang常用库有:1、标准库;2、字符串处理库;3、网络库;4、加密库;5、压缩库;6、xml和json解析库;7、日期和时间库;8、数据库操作库;9、文件操作库;10、图像处理库。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

356

2024.02.23

golang和python的区别是什么
golang和python的区别是什么

golang和python的区别是:1、golang是一种编译型语言,而python是一种解释型语言;2、golang天生支持并发编程,而python对并发与并行的支持相对较弱等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

214

2024.03.05

golang是免费的吗
golang是免费的吗

golang是免费的。golang是google开发的一种静态强类型、编译型、并发型,并具有垃圾回收功能的开源编程语言,采用bsd开源协议。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

410

2024.05.21

golang结构体相关大全
golang结构体相关大全

本专题整合了golang结构体相关大全,想了解更多内容,请阅读专题下面的文章。

510

2025.06.09

golang相关判断方法
golang相关判断方法

本专题整合了golang相关判断方法,想了解更详细的相关内容,请阅读下面的文章。

201

2025.06.10

golang数组使用方法
golang数组使用方法

本专题整合了golang数组用法,想了解更多的相关内容,请阅读专题下面的文章。

1519

2025.06.17

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

69

2026.03.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Go 教程
Go 教程

共32课时 | 6.2万人学习

Go语言实战之 GraphQL
Go语言实战之 GraphQL

共10课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号