2016-12-20 31 views
2

我是新来的开发,并试图上传我已经工作到我的GitHub配置文件的小项目。这些项目不相互依赖。如何在GitHub中组织和分类小型项目?

我的问题是,他们中的一些是小型单文件项目。有点像我已经解决的迷你挑战。因此,我正在考虑将它们组合在一个名为“Python编程”的回购站中,例如。

这是一个很好的做法吗?

  • 如果是的话,我应该怎么去了解它的Git,和 我怎么能仍然显示为每个小项目的README文件。

  • 如果不是,您会推荐做什么?

+1

回购可以是任何东西,你需要它,您个人使用。将它们分成文件夹,每个文件夹都提供了自述文件(例如,您可以将它们与Gulp合并)。团队或合作者可以将其转变为与他们的偏好相对应的东西。那里没有硬性规定。 – Nevertheless

回答

2

GitHub将为您访问的每个文件夹呈现一个README文件,因此,当仅使用一个存储库时,一种解决方案是仍然为每个“子项目”创建一个子文件夹,因为它们可以有自己的README文件。

但在此之前走这样一条路,你应该想想,如果这些小项目实际上属于一起。最终,应该决定是将所有内容都放在同一个存储库中,还是要将其分割为多个存储库。

有些事情要考虑这一决定:

  • 如果项目不依赖于其他,是否还涉及另一个?例如,这些项目是Project Euler这样的更大规模编程挑战的一部分,您只是在收集所有解决方案?那么单个存储库可能更有意义。
  • 个别项目成长为更大的事物的机会是多少?许多事情开始很小,但最终可以成长为真正的东西,证明自己的存储库。那时,你甚至可能会让别人做出贡献。
  • 这些文件能够共享历史记录吗?这些文件在“完成”后甚至会被编辑?即这只是一个完成的东西的集合,还是他们实际上正在进行的实验?

最终,它归结为个人的选择。但是,GitHub作为存储库托管服务器,不应该推动您的决定。您应该在本地创建Git存储库,因为它对您有意义。如果这意味着你只有一个,那很好。如果这意味着你创造了很多,那也很好。

不幸的是,GitHub的UI是不是真的对小型一次性项目取得。存储库列表只是为了组织而已。如果你决定使用小型项目,我建议你在你的GitHub配置文件中添加一些用于分类的前缀,这样你就知道这是关于什么的。

一个很好的选择为一次性项目,尤其是当它只是一个(或几个)文件Gists。 Gist是作为共享代码片段的一种方式而诞生的,但是每个Gist实际上都是一个完整的Git存储库。当然,Gist不提供GitHub上的常用工具库(例如问题,拉取请求,维基)。但对于你所描述的,你可能不需要那些。然后,Gist是一种很好的方式来分享简单的东西,而无需将完整的存储库添加到您的配置文件。而且你还可以克隆它们(远程URL是[email protected]:/<gist-id>.git),并有充分的历史和多个文件的支持,如果你需要的。

+0

我是一名机械工程师,一年前决定自学软件开发。现在我正在寻找工作,我的朋友们建议我将所有项目都放在GitHub上作为一个投资组合。因此,组织较小项目的头痛。 但你的回答给了我很多的清晰。干杯! –

2

通常情况下,你会看到,回购的顶级中包含的README文件,也许setup.py和其他一些无关紧要的信息,也许tests文件夹。然后会有一个与repo共享名称的文件夹。该文件夹的内部是旨在成为模块/包/脚本的核心内容的代码。

这也是很平常看到不同的组织,特别是单文件的脚本非常小的项目。

对于您提到的具体情况,请做任何您喜欢的事情。你的建议听起来对我来说完全合理。我不想为我解决的所有挑战有单独的回购协议!

我通常使用一个gist为了微不足道的项目我并不想为回购协议,其中包括编码的挑战。所以我会提供这个选择。做任何你最适合的事情。