GitHub Profile 3D Contrib 使用教程

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 [e-mail]
          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 贡献日历，展示你的开源贡献。