首页
/ GitHub Profile 3D Contrib 使用教程

GitHub Profile 3D Contrib 使用教程

2024-09-16 04:54:19作者:卓艾滢Kingsley

1. 项目介绍

GitHub Profile 3D Contrib 是一个 GitHub Action,用于在 GitHub 个人资料页面上生成一个 3D 贡献日历。这个日历展示了用户在 GitHub 上的贡献活动,并以 3D 图像的形式呈现。通过这个项目,用户可以更直观地展示自己的开源贡献,增强个人资料的视觉效果。

2. 项目快速启动

2.1 创建特殊仓库

首先,创建一个与你的 GitHub 用户名同名的仓库。例如,如果你的用户名是 octocat,则创建一个名为 octocat/octocat 的仓库。

2.2 创建工作流文件

在仓库中创建一个工作流文件,例如 github/workflows/profile-3d.yml,并添加以下内容:

name: GitHub-Profile-3D-Contrib

on:
  schedule:
    # 03:00 JST == 18:00 UTC
    - cron: "0 18 * * *"
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    name: generate-github-profile-3d-contrib
    steps:
      - uses: actions/checkout@v3
      - uses: yoshi389111/github-profile-3d-contrib@0.7.1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          USERNAME: ${{ github.repository_owner }}
      - name: Commit & Push
        run: |
          git config user.name github-actions
          git config user.email github-actions@github.com
          git add -A
          git commit -m "generated"
          git push

2.3 手动触发工作流

添加工作流后,可以通过 GitHub Actions 页面手动触发工作流。导航到 Actions -> GitHub-Profile-3D-Contrib -> Run workflow

2.4 添加生成的图像到 README

生成的 3D 贡献日历图像会保存在 profile-3d-contrib 目录下。将图像路径添加到你的 README.md 文件中,例如:

![3D Contribution Calendar](./profile-3d-contrib/profile-green-animate.svg)

3. 应用案例和最佳实践

3.1 应用案例

  • 个人开发者:通过 3D 贡献日历展示自己的开源贡献,提升个人资料的吸引力。
  • 开源项目维护者:在项目主页上展示核心贡献者的 3D 贡献日历,激励更多开发者参与项目。

3.2 最佳实践

  • 定期更新:设置工作流定时触发,确保贡献日历始终保持最新状态。
  • 自定义设置:通过 SETTING_JSON 环境变量自定义 3D 贡献日历的样式和内容。

4. 典型生态项目

  • GitHub Actions:本项目基于 GitHub Actions 实现自动化生成 3D 贡献日历。
  • GitHub Profile README:结合 GitHub Profile README,展示更多个人或项目信息。
  • GitHub Sponsors:通过展示贡献日历,吸引更多赞助者支持你的开源工作。

通过以上步骤,你可以轻松地在 GitHub 个人资料页面上添加一个炫酷的 3D 贡献日历,展示你的开源贡献。

登录后查看全文
热门项目推荐
相关项目推荐

项目优选

收起
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
281
567
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
465
378
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
14
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
358
37
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
56
128
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
104
187
CangjieMagicCangjieMagic
基于仓颉编程语言构建的 LLM Agent 开发框架,其主要特点包括:Agent DSL、支持 MCP 协议,支持模块化调用,支持任务智能规划。
Cangjie
571
40
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
350
252
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
93
246
ruoyi-airuoyi-ai
RuoYi AI 是一个全栈式 AI 开发平台,旨在帮助开发者快速构建和部署个性化的 AI 应用。
Java
100
28