#github #art #contributions #graph #commit #generate #repository

应用 git-shining

将年度GitHub贡献图转化为艺术作品

4个版本

0.2.2 2023年8月30日
0.2.1 2023年8月30日
0.2.0 2023年8月30日
0.1.0 2023年8月27日

#933开发工具

每月 21 次下载

MIT 许可证

97KB
700

git-shining:将GitHub贡献图转化为动态艺术

此程序通过按正确日期提交来将您的贡献图转化为艺术品。GitHub将自动扫描仓库并为您填充图表。

或者,如果您想看一个更直观的例子,请点击这里

限制条件

最好创建或使用一个临时账户来使用此功能;这不是为您的主要账户设计的。

  • 您在这一年中必须没有任何其他活动,包括拉取请求、问题评论等。
  • 您必须只有一个记录一年内提交的仓库,并且这些提交必须都与您的消息相关。
  • GitHub允许您将提交回溯到1970/1/1,因此如果您想利用这一点,请确保使用--origin选项。

用法

第一步是生成配置。您可以通过以下两种方式来完成:

git-shining generate-config <json|txt>

这将生成一个用于编辑的空白画布,格式为JSON或TXT(稍后还会介绍)。

或者

git-shining render-font <.otf or .ttf file> <message (be sure to quote)>

这将生成一个预填充的配置,其中消息以提供的字体渲染到画布上。

然后,您可以使用generate-repository命令生成一个仓库。请确保至少设置您想要获得提交认可的人的email字段,它必须直接映射到一个配置的GitHub电子邮件地址。

git-shining generate-repository -i bro.txt -e wearelegion@example.org -m "Sup Bro" /tmp/test.git

之后,您就可以创建并上传您的仓库。

如果您想从特定的日期开始生成仓库,请查看buildgenerate-repository--origin选项。

配置格式

配置有两种格式:JSON和TXT。

JSON是一个整数数组(0-10),用于确定图表中的阴影效果(通过提交更多来增加亮度)。它易于消费、处理和生成,但编辑起来稍微有些困难。

TXT是一个更易于手工编辑的格式。它是一个整齐排列的整数网格,您可以从0到A(在这里A代表10)设置阴影效果。

generate-config子命令可以生成这两种格式以供手工编辑,而render-font命令有选项可以修改目标配置输出。

故障排除

  • 如果您上传两次,必须完全删除旧仓库并重新创建。强制推送不会清除图。
  • 如果您想知道在推送到GitHub之前您的图将是什么样子,请尝试使用build子命令,它将生成一个HTML模拟图,您可以在浏览器中加载。您可以悬停在每个方块上以获取预期日期。

未来计划

  • 横幅和壁画功能

作者

专业版 [email protected]

依赖项

~14MB
~334K SLoC