OpenMMLab 贡献者成长体系教程
  • OpenMMLab 贡献者成长地图
  • 活动
    • 超级视客营
    • MMSIG任务领取指南
  • 通用贡献者教程(建设中)
    • 开源协议学习(建设中)
    • 环境配置(建设中)
      • Windows 环境配置
      • Github Codespaces 云 Linux 环境
      • Windows WSL 环境配置
      • Ubuntu 20.04 环境配置(建设中 2)
      • ubuntu docker 环境配置
    • 熟悉 GitHub/Git(建设中)
    • 代码规范
    • 文档类贡献指南(建设中)
      • MMSIG 文档贡献指南 (建设中)
      • 算法库文档贡献指南 (建设中)
    • Type Hints 贡献指南(建设中)
    • 单元测试贡献指南(建设中)
    • 源码阅读及调试技巧(建设中)
  • 算法库贡献者教程(建设中)
    • Playground(建设中)
    • MMEngine(建设中)
      • 新 Config 适配贡献指南
    • MMCV(建设中)
      • Transform 数据增强贡献指南
      • 算子贡献指南(建设中)
    • MMPreTrain(建设中)
      • 骨干网络贡献指南(建设中)
      • 自监督算法贡献指南(建设中)
    • MMDetection(建设中)
    • MMYOLO(建设中)
    • MMDetection3D(建设中)
    • MMOCR (建设中)
    • MMSegmentation(建设中)
      • 贡献一个标准格式的数据集
      • 贡献一个数据集加载方式(建设中)
    • MMPose (建设中)
    • MMEditing(建设中)
    • MMDeploy (建设中)
由 GitBook 提供支持
在本页
  • 1. 什么是开源协议
  • 版权
  • 2. 如何选择开源协议
  • 3. 如何使用开源协议
  • 具体操作示例
  • 4. 日常Q&A
  • 5. 参考材料

这有帮助吗?

在GitHub上编辑
  1. 通用贡献者教程(建设中)

开源协议学习(建设中)

上一页MMSIG任务领取指南下一页环境配置(建设中)

最后更新于1年前

这有帮助吗?

1. 什么是开源协议

版权

什么文件中需标注版权信息

根据具体情况如何标注版权信息

  1. 文件中的所有代码均由 OpenMMLab 内部同学或社区同学实现

需添加 OpenMMLab 版权声明

# Copyright (c) OpenMMLab. All rights reserved.
  1. 文件中的所有代码均拷自第三方库且无明显修改

需添加第三方库版权声明。注意:无明显修改包括但不限于没有重构代码结构、没有优化代码性能、没有修复代码漏洞。例如,只做了少量的变量名重命名不属于明显修改。

  • 如果第三库有提供版权信息,可直接复制

# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved
# Copied from
  • 如果没有提供版权信息,可以使用以下模板

# Copyright (c) Github URL
# Copied from xxx
  1. 文件中的所有代码均拷自第三方库且对第三方库有明显修改

添加 OpenMMLab 版权声明,并注明 Modified from

// Copyright (c) OpenMMLab. All rights reserved.
// Modified from xxx
  1. 文件中包含 OpenMMLab 内部同学或社区同学实现的代码和第三方库的代码并无明显修改第三方库代码

Copyright 可以叠加,第三方库的写法参照第 2 点

# Copyright (c) OpenMMLab. All rights reserved.
# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved

...

# 可以在离第三库最近的地方注明 Copied from xxx
# Copied from xxx
  1. 文件中包含 OpenMMLab 内部同学或社区同学实现的代码和第三方库的代码且对第三方库代码做了明显修改

有两种情况,第三方库有版权要求、第三方库无版权要求

  • 第三方库有版权要求

# Copyright (c) OpenMMLab. All rights reserved.
# Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved

# 可以在离第三库最近的地方注明 Modified from xxx
# Modified from xxx
  • 第三方库无版权要求

添加 OpenMMLab 版权声明,并在离第三方库最近的地方注明 Modified from xxx

# Copyright (c) OpenMMLab. All rights reserved.

# 可以在离第三库最近的地方注明 Modified from xxx
# Modified from xxx
  • 协议

ICLA & CCLA

2. 如何选择开源协议

  • 开源协议种类

  • 选择恰当的协议

一图解释:

  • license的兼容性

  1. 兼容有方向性,宽松协议兼容于严格协议。

  2. 典型不兼容场景:Apache 2.0 与 GPL v2不兼容;GPL v2与GPL v3不兼容。具体操作示例

3. 如何使用开源协议

具体操作示例

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在文件列表上方,使用添加文件下拉菜单,单击创建新文件。

  1. 在文件名字段中,输入 LICENSE。

  2. 在文件名字段的右侧,单击选择许可证模板。

  1. 在页面左侧的“向您的项目添加许可证”下,查看可用的许可证,然后从列表中选择许可证:Apache 2.0 。

  1. 单击审核并提交。

  1. 单击提交新文件。

ps:如果您正在为现有项目做出贡献或对其进行扩展,那么继续使用该项目的许可证几乎总是最容易的。要查找其许可证,请查找名为LICENSEor的文件COPYING,然后浏览项目的README. 如果找不到许可证,请询问maintainer。

  • 整段copy

  • 局部重用代码

可在代码最开始的地方加上license字段

4. 日常Q&A

A1:apache2.0没有传染性,兼容有方向性,宽松协议兼容于严格协议,是允许其它项目基于我们的协议进行修改的;与此同时,在支持新模型的时候对开源协议要谨慎,第三方开发者基于OpenMMLab做的开源项目,是可以自由选择的,跟我们apache 2.0的协议不冲突,像nvidia基本上所有的算法开源repo都是禁止商用的,但如果我们参考了这样的开源项目的代码来支持某个算法的话,是不能直接用apache 2.0协议的,除非是我们完全重写了一遍,没有使用他们repo里的代码。

5. 参考材料

软件的许可方式大致可分为(闭源)与(开源)。其主要区别在授予用户的有所不同。(开源 ≠ 免费≠ 毫无限制地使用)开源授权是电脑软件和其他产品的一种授权类型,此种授权允许其源码、蓝图、或设计基于明文规定或明示条件下,被所有人使用、修改或分享。这允许最终用户和商业公司审查和修改源代码、蓝图或设计,以满足他们自己的定制、好奇心或故障排除需求。开源协议是开源软件生态系统的基础,可以促进软件的协同开发。license有其两面性,既授予权利,同时要求履行义务:声明、开源。

CLA / ICLA 是 Contributor License Agreement 的缩写,是对 license 的法律性质补充,由法务制定,用以明确法律义务;一般分为公司级(CCLA)和个人级别的 ICLA,CCLA 即某公司代表签署 CLA 后可代表该公司所有员工都签署了该 CLA,而个人级别 CLA 只代表个人认可该 CLA,公司签署 CCLA 后,个人贡献仍需签署ICLA。CLA 可根据具体行情况进行适当调节,公司或组织可自行定义:比如阿里做了相应的本土化:

目前,国际公认的开源许可证共有。它们的共同特征是,都允许用户免费地使用、修改、共享源码,但是都有各自的使用条件。但如果一种开源许可证没有任何使用条件,连保留作者信息都不需要,那么就等同于放弃版权了。这时,软件可以直接声明进入"公共领域"(public domain)。

最自由,任何人都可以售卖我的软件,甚至可以用我的名字促销。 和 协议也很自由,跟 MIT 的区别分别是不允许用作者本人名义促销和保护作者版权。 族最严格,对代码的修改部分也必须是 GPL 的,同时基于 GPL 代码而开发的代码也必须按照 GPL 发布,而 MPL ,也就是 Public License 就温和一些,如果后续开发的代码中添加了新文件,同时新文件中也没有用到原来的代码,那么新文件可以不必继续沿用 MPL 。

总结:严格程度: v3.0> 2.0> v3.0> 2.0> 3> (点击可查看license具体详情)

在页面底部,输入简短、有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“。

在提交消息字段下方,决定是将提交添加到当前分支还是新分支。如果您当前的分支是默认分支,您应该选择为您的提交创建一个新分支,然后创建一个拉取请求。有关更多信息,请参阅“。

如果您在 GitHub.com 上有多个电子邮件地址与您的帐户相关联,请单击电子邮件地址下拉菜单并选择要用作 Git 作者电子邮件地址的电子邮件地址。此下拉菜单中仅显示经过验证的电子邮件地址。如果您启用了电子邮件地址隐私,则<username>@users.noreply.github.com是默认提交作者电子邮件地址。有关更多信息,请参阅“。

可以在代码目录下放置原始codebase的license文件大多数人将他们的许可证文本放在存储库根目录中名为LICENSE.txt(或LICENSE.md或LICENSE.rst)的文件中;。

Q1:基于 MMSegmentation 开发的 SegFormer 使用的 Liscense 是不允许商用的(),但是 OpenMMLab 复现后写的是 apache 2.0 (可以商用),所以应该按照哪一种协议呢?

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

专属软件
自由开源软件
权利
Alibaba Open Source Individual CLA
80多种
MIT
BSD
Apache
GPL
Mozilla
GPL
Mozilla
LGPL
Apache
BSD
MIT
创建具有多个共同作者的提交”
创建新的拉取请求”
设置您的提交电子邮件地址”
这是 Hubot 的一个例子
https://github.com/NVlabs/SegFormer#license
https://choosealicense.com/
https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
https://opensource.com/resources/what-open-source
https://opensource.org/faq
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository
https://dwheeler.com/essays/floss-license-slide.html
https://www.apache.org/licenses/contributor-agreements.html#clas
https://www.apache.org/licenses/cla-faq.html#cclas-not-required