GitHub贡献导入工具

这个工具帮助用户从私有Git仓库或非GitHub托管的公共仓库导入贡献到GitHub。

<p style="margin: 20px" align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/7ff8803f-3b81-4e57-bdfc-4179120c2cd0.png" /> </p>

工作原理

最简单的情况下，这个工具会将源Git仓库的所有提交复制到一个模拟Git仓库。每个复制的提交会报告相同的提交日期，但不会复制原始代码，也不会复制提交信息。

<p style="margin: 20px" align="center"> <img src="https://yellow-cdn.veclightyear.com/835a84d5/416a2656-d486-4e5d-ab22-f6502e465b18.png" /> </p>

相反，贡献导入工具会创建模拟代码来报告源仓库中使用的编程语言。

你还可以使用多个源Git仓库来报告来自几个私有Git仓库的活动。

原因

GitHub展示了用户的贡献统计。这个功能存在几个值得讨论的原因。

此外，这种机制只奖励在GitHub维护的仓库上工作的开发者。

考虑到GitHub无可否认的流行程度，使用其他平台的开发者处于劣势。实际上，越来越多的开发者在简历中提及他们的GitHub贡献。同样，招聘人员可能使用GitHub来寻找人才。

在更极端的情况下，一些开发者决定抵制GitHub的锁定系统，并开发了可以用虚假提交改变GitHub贡献图的工具：Rockstar和GitHub虚荣文本就是很好的例子。

相反，GitHub贡献导入工具旨在生成一个整体上真实的活动概览。

关于这个项目的其他好教程

• Rajan Joshi的我如何恢复我的Git贡献
• Daniel Mai的从Bitbucket导入贡献到GitHub

如何使用

首先确保你安装了pipenv。之后，按以下方式安装所有依赖并在虚拟环境中启动一个shell：

cd contributions-importer-for-github
pipenv install
pipenv shell

贡献导入工具是为开发者设计的。没有UI，也没有简单的命令行工具。这个工具可以通过编写一个简单的Python脚本来使用：

import git
from git_contributions_importer import *

repo = git.Repo("path/to/your/private/repo")
mock_repo = git.Repo("path/to/your/mock/repo")

importer = Importer([repo], mock_repo)
importer.set_author('email@domain.com')

importer.import_repository()

模拟仓库文件夹可以是一个空的Git仓库，也可以是一个已经有其他提交的仓库。

保护你的私有仓库

贡献导入工具有一些功能来保护你的私有代码。

掩盖真实的提交时间

importer.set_commit_time_max_past(value)

提交可以向过去偏移的最大时间量。值以秒为单位。

每个文件的最大更改次数

importer.set_max_changes_per_file(max_amount)

每个文件的最大更改次数。默认情况下，对于每个更改（代码行的更改、添加或删除），都会更改一行模拟代码。相反，set_max_changes_per_file()会限制在极端情况下生成的模拟代码数量，例如更改了太多行代码（如SQL数据库转储）。默认值为5。

将多个更改合并为一个

importer.set_collapse_multiple_changes_to_one(true)

允许导入工具将几行更改合并为每次提交每种文件类型只有一行。这有助于避免文件大小过度增长。默认设置为True。

每次提交的最大更改次数

importer.set_commit_max_amount_changes(max_amount)

一次提交可以有的最大更改次数（代码行的更改、添加或删除）。在GitHub中，有很多更改的提交是不利的。很可能这些大型提交本可以分成许多小的提交。了解如何计算贡献的GitHub用户倾向于进行多次较小的提交，而在私有仓库中，这可能不是必要的，尤其是在较小的团队中。默认值为-1，表示没有限制。

最大向后时间

importer.set_changes_commits_max_time_backward(max_amount)

如果使用了set_commit_max_amount_changes()，一个提交可能会被分割。在这种情况下，这个值决定了这些提交可以向过去延伸多长时间。这个想法是，一个大型提交可能由几个本可以在不同提交中提交的功能组成。这些更改会在实际真实提交之前的某个时间点。时间以秒为单位，默认为4天（在较简单的项目中很好，每周都有一个"备份"提交）。

忽略日期之前

importer.set_ignore_before_date(value)

导入工具将忽略此日期之前的所有提交（从1970-01-01 UTC开始的秒数）

仅最后一次提交

importer.set_start_from_last(false)

导入工具将从mock_repo获取最后提交的日期，并忽略此日期之前的所有提交。如果设置了ignore_before_date，将忽略最后一次提交和ignore_before_date中较晚日期之前的所有提交。对于增量导入很有用。

设置作者

importer.set_author(email)

要分析的作者。如果未设置，将导入任何作者的提交。作者以电子邮件形式给出。如果作者使用不同的电子邮件，这也可以是一个数组。

保留提交信息

importer.set_keep_commit_messages(value)

导入工具将保留原始提交信息，而不是模拟的信息。默认情况下，此标志设置为False。

贡献

代码风格

关于缩进和空格等代码风格，请遵循源代码中已经使用的约定。

提交拉取请求

• 创建一个新分支，请不要直接在你的master分支上工作。
• 为你想要做的更改添加失败的测试。
• 修复问题。
• 确保编写的测试不再失败，其他测试也是如此。
• 更新文档以反映任何更改。
• 推送到你的fork并提交拉取请求。

许可

MIT许可证

版权所有 (c) 2018 Miro Mannino

特此免费授予任何获得本软件副本和相关文档文件（"软件"）的人不受限制地处理本软件的权利，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售本软件副本的权利，以及允许向其提供本软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在本软件的所有副本或实质性部分中。

本软件按"原样"提供，不提供任何明示或暗示的保证，包括但不限于对适销性、特定用途适用性和非侵权性的保证。在任何情况下，作者或版权持有人均不对任何索赔、损害或其他责任负责，无论是在合同诉讼、侵权诉讼或其他诉讼中，还是由软件或软件的使用或其他交易引起的或与之相关的责任。