代码共享的最佳/不良做法？[关闭]

我越探索Github，就越喜欢它。我真的很喜欢编码如何变得更加社会化。

我很好奇程序员在共享代码时应避免任何不良做法。在命名不良做法时，代码共享的最佳做法是什么？

例如：

单个回购包含多个名为“ MiscProjects”的脚本/项目是否是不好的做法？顾名思义，此存储库是其他小脚本和项目的集合。这可能类似于程序员在其本地存储上组织项目的方式，但是对于代码共享而言可能不是最佳选择吗？

也许如果完成了良好的自述文件/文档，那会更好吗？还是只要有据可查，有什么用吗？

尽管没有“坏习惯”一成不变，但与其他版本控制系统一样，也有约定。

您的Git仓库应尽可能小。如果您来自CVS / SVN模块，那么通常有一个结构化的单一存储库，该存储库可以由多个项目的多个存储库组成。该Git的方法是为每一个项目拆分这些并有独立的Git回购协议。原因如下：

• 对于较小的仓库，Git 更快。
• 由于其设计，每个操作都会影响整个仓库。如果仅在其中一个项目上进行操作，那么对必需项目执行Git操作效率很低。

一如既往，文档是必须的。当人们精于阅读代码时，没人愿意解释代码的任何比他们更需要。对于那些参与（或希望参与）项目的人来说，使用顶级自述文件描述项目和Git存储库的结构始终是一件好事。

GitHub上的大多数项目都符合约定。使用它们作为如何构建未来项目的示例。