建站与 SEOGitHubREADMEGitHub Pages

学生如何把 GitHub 整理成可读的项目作品集

·Ronin.XI··

GitHub 作品集的目标不是展示提交数量，而是让陌生人在几分钟内回答三个问题：你做了什么、为什么这样做、现在能不能运行。

先只选三到五个项目

优先放这些项目：

  • 你能解释关键决策，不只是照着课程复制；
  • 有清晰输入、输出和完成状态；
  • 代码可以公开，且不包含密钥、私人数据或作业答案；
  • 最好有在线演示、截图或短视频；
  • README 能让别人复现核心流程。

把最能代表能力的仓库置顶。其余练习可以保留，但不必都当作品。

每个 README 回答七件事

  1. 项目解决什么具体问题；
  2. 当前可用功能和明确的未完成项；
  3. 演示链接或关键截图；
  4. 技术选择及其原因；
  5. 本地运行所需版本与命令；
  6. 环境变量只列名称和用途，不提交值；
  7. 你负责的部分、遇到的难点和后续改进。

一个可靠的启动段落比十几个徽章更有用：

npm install
npm run dev

如果项目需要数据库或外部 API，应提供 .env.example，并说明测试账号、种子数据或不可复现的限制。

提交前做安全检查

  • 搜索历史中是否出现 API key、邮箱、手机号或真实数据；
  • 确认许可证和第三方素材允许公开；
  • 删除构建产物、系统文件和大型二进制；
  • 从全新目录按 README 跑一遍；
  • 检查演示链接在未登录状态能否打开。

GitHub 页面适合作为技术证据，个人网站则适合组织叙事。需要发布入口时，继续看学生个人网站的最小上线方案。

如果 GitHub Education 已通过但 Student Developer Pack 或 Copilot Student 没有生效，先按GitHub 学生权益激活与续期排查确认账号和状态。