讲师中心 微信公众号
AI工具推荐 视频效率加速

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

雨明同学_6763

雨明同学_6763

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

|

638人浏览过

|

来源于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 list、go mod graph)完全不读取 go.mod 中的 license 字段,它甚至不是 Go module 的合法字段——填了会被 go mod tidy 自动删掉。真正起作用的是项目根目录下的 LICENSE 或 LICENSE.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/repo 和 github.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 文件。

Golang Uber Dig
Golang Uber Dig

使用 uber-go/dig 在 Golang 中实现依赖注入——基于反射容器,提供 Provide/Invoke、dig.In/dig.Out 参数与结果对象,支持命名依赖等

下载
  • 运行 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 | sh 或 brew 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工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

3689

2023.06.20

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2468

2023.07.25

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

1400

2023.08.02

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

1338

2023.08.09

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

1436

2023.09.05

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2378

2023.09.20

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

3960

2023.09.20

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

18755

2023.09.22

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

20

2026.11.05

热门下载

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

精品课程

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn