GitHub 作品集的技巧
几周前,有两个人在 Twitter 上问我同样的问题:“我如何制作更好的投资组合?”
因为这不是我第一次遇到这个问题,所以我决定公开回答™️。
在开始之前,我想强调一点。拥有 GitHub 个人资料并非强制性的,也不应该成为强制性的。它只是“有则更好”。
质量重于数量
常见的 GitHub 个人资料如下:
这个人挑选了 6 个代码库并将它们固定下来。所有代码库都有 3 个提交,没有 readme 文件。这位开发者似乎尝试了很多东西,但没有什么特别突出的。如果招聘人员问你“你遇到了什么问题?你是如何解决的?”,你的回答会很有限。
别误会,尝试新事物本身没什么不好!我的 GitHub 个人资料上也有很多 Hello World 项目。不过,这些项目并没有被置顶。我只置顶那些我认为相关的。我知道招聘人员没时间看完我所有的项目。所以当我写这些的时候,我只有 5 个项目。
与其同时进行 6 个小项目,不如选择一个,然后完善它!
在公共场合学习
“除非它很完美,否则我不会把它放到 GitHub 上”
这句话出自一位我曾经共事过的资深开发人员。我觉得这样想很可惜。一般来说,害怕犯错的人最终什么都做不了。如果你看看 GitHub 上流行的仓库,你会发现它们大多数都远非完美。但这没关系!
而且,如果有一天有人检查你项目的 git log,发现你忘了一个括号/分号,我想他不会怪你。就算他怪你,对你来说也是好事。没人想和这种“有毒”的人一起工作。
总有事要做!
我曾经辅导过一个想在IT领域再培训的女孩。她给我看了她开发的小游戏。但她想找个新项目,因为她觉得这个项目已经“完蛋”了。
项目永远做不完。总有事要做……记住第一条建议:“质量重于数量”!
您可以做以下几件事...
添加 README.md
自述文件是项目的入口,也是人们首先会看到的内容!
我认为每个代码仓库都应该有一份。如果你不想让人们对你的项目感兴趣,可以添加一份,并写上“此处无内容”。
您的自述文件应该回答这些问题:
- 这个项目是关于什么的?(1-2 句话就足够了)。
- 如何安装?
- 如何使用它?
- 它看起来像什么?您可以添加屏幕截图或 gif 动画。
💡提示:您可以在Awesome README 存储库中获得一些启发。
做营销
如果你正在开发一款应用,一定要宣传一下!我有个前同事正在开发一款极简文本编辑器。他时不时会在社交媒体(Twitter、LinkedIn……)上发布关于他的产品和新功能的链接。他还在 ProductHunt/Reddit 上发布了他的产品。这些平台非常适合收集反馈!
💡提示: WhatsApp、Telegram 或 Discord 中也有较小的社区(即Party Corgi)。
添加更多功能
对于一个全新的项目来说,找到更多功能应该不是什么难事。如果你做过一些市场营销,或者向亲朋好友征求过反馈,你应该会有一些想法可以补充。
在某些时候,你可能会面临需要重新思考编写应用程序的方式的情况。这对你来说是一个好时机,因为这意味着你克服了“Hello World”阶段。有趣的问题通常出现在你的应用程序发展过程中。
还有...
- 使用工单/问题管理你的待办事项列表。如果你有几张工单,可以将它们分组到不同的类别:“bug”、“改进”……如果有人发现 bug 或有功能请求,他们很可能会在你的代码库中创建“问题”!另外,一个小提示:在开始任何新功能之前,请先修复所有 bug!
- 写测试!很多开发招聘人员在审查代码时喜欢看测试。你正在做的项目可能就是写测试的好机会!
- 添加持续集成 (CI)。每次添加代码时,机器人都会检查测试是否通过,以及是否存在死代码/疏忽/……您可以使用 TravisCI、GitHub Actions 等工具……
- 自动化部署。许多工具允许你在分支上部署应用
git push
。master
你可以查看 Netlify、GitHub/GitLab Pages、Vercel…… - 使您的应用具有可访问性 (a11y),以便残障人士可以使用您的应用。
- 使其适合移动设备(响应式网页设计),如果您觉得舒服,为什么不创建一个渐进式网页应用程序(PWA)呢?
- 把它变现?如果你认为自己正在解决别人遇到的问题,并且你也遇到过,那么你应该考虑变现。这个项目可能会给你一杯咖啡……甚至更多!
现在轮到你了。给我看看你超棒的 GitHub Profile!
欢迎通过Twitter (@_maxpou)或在下方评论区联系我!😎
最初发表于maxpou.fr。
鏂囩珷鏉ユ簮锛�https://dev.to/maxpou/tips-for-your-github-portfolio-1ffk