gh_mirrors/sq/square.github.io项目贡献指南：如何添加新的开源项目

【免费下载链接】square.github.io A simple, static portal which outlines our open source offerings. 项目地址: https://gitcode.com/gh_mirrors/sq/square.github.io

在开源社区中，每一个贡献都能让项目更加完善和强大。本文将为你提供一份详细的指南，帮助你轻松为gh_mirrors/sq/square.github.io项目添加新的开源项目，让更多有价值的项目被大家发现和使用。

准备工作：克隆项目仓库

要开始贡献，首先需要将项目仓库克隆到本地。打开终端，输入以下命令：

git clone https://gitcode.com/gh_mirrors/sq/square.github.io

克隆完成后，进入项目目录，你就可以开始后续的操作啦！

第一步：添加项目图片（可选但推荐）

为了让新添加的开源项目在展示页面更加吸引人，建议为项目添加一张合适的图片。项目中专门设有存放项目图片的目录：repo_images/。

你需要准备一张分辨率大于600x300的图片，将其命名为项目名称加上.jpg后缀，例如项目名称为“my-project”，则图片命名为“my-project.jpg”。然后将图片复制到repo_images目录下。这样，在生成页面时，项目图片就能正常显示啦。

第二步：修改repos.json文件

项目的核心配置文件之一是repos.json，新的开源项目信息需要添加到这个文件中。

打开repos.json文件，你会看到其中有“repos”和“custom”两个主要部分。

添加到“repos”部分

如果要添加的项目是Square组织下的标准项目，直接在“repos”对象中添加键值对。键为项目名称，值为项目所属的分类数组。例如：

"my-project": ["JavaScript", "Web"]

这里的分类可以是项目相关的技术领域，如“Android”“iOS”“Java”“Go”等。

添加到“custom”部分

如果项目不是Square组织下的，或者需要自定义更多信息（如 homepage、description 等），则需要添加到“custom”数组中。例如：

{
  "name": "my-custom-project",
  "homepage": "https://my-project-homepage.com",
  "html_url": "https://gitcode.com/my/project",
  "description": "这是一个自定义项目的描述",
  "categories": ["Python", "Data Science"]
}

第三步：运行generate.py生成新页面

完成repos.json文件的修改后，需要运行generate.py脚本来生成新的index.html页面。

在终端中执行以下命令：

python generate.py

generate.py脚本会读取repos.json中的配置信息，从GitHub获取项目详情（如果是Square组织的项目），并根据index.mustache模板生成新的index.html文件。

第四步：提交并推送更改

所有修改完成后，就可以将更改提交到本地仓库，并推送到远程仓库啦。依次执行以下命令：

git add .
git commit -m "Add new open source project: [项目名称]"
git push origin main

常见问题解决

图片不显示怎么办？

首先检查图片是否放在了repo_images目录下，文件名是否与项目名称一致且以.jpg结尾。如果确认无误，可以检查generate.py脚本中第96行代码，确保图片路径判断正确。

项目信息未更新？

可能是generate.py脚本没有成功运行，或者GitHub API请求受限。可以查看终端中的运行日志，看是否有错误信息。如果是未登录状态，GitHub API有请求频率限制，可以尝试登录后再运行脚本。

通过以上步骤，你就能成功为gh_mirrors/sq/square.github.io项目添加新的开源项目啦。赶快行动起来，把你发现的优秀开源项目分享给更多人吧！ 🚀

【免费下载链接】square.github.io A simple, static portal which outlines our open source offerings. 项目地址: https://gitcode.com/gh_mirrors/sq/square.github.io