存储库中的练习/示例代码

时间:2011-02-14 09:20:41

标签: version-control project-hosting

假设我在一些开源项目托管服务(例如Google CodeGit hubSourceforge中托管项目,将示例/练习代码放在存储库中是一种很好的做法我曾经学过这项技术?例如,在开发应用程序时,我可能会开发一些示例来学习JUnitRegex等等。我也可以将它们放在存储库中吗?它会混淆我的存储库的访问者吗?

3 个答案:

答案 0 :(得分:1)

您应该只编辑开发/运行项目所需的内容 任何其他文件集可以位于其自己的存储库中(例如,对于git,例如 submodule ),如果需要,可以从主项目中引用。
这样,您仍然可以在主项目结帐中看到这些文件(如果包含子模块),但您也可以在没有任何额外文件的情况下获取主项目。

答案 1 :(得分:1)

您不应将样本峰值放入项目的主存储库中。您可能会对项目的构建过程(甚至代码本身)产生负面影响。我的上一个项目有大约50个子项目/团队,花了将近24小时从头开始构建整个项目;这是一个怪物。添加每个人的示例代码会使这种构建更糟糕。这应该被认为是一种不好的做法。

关于创建子模块的先前答案将是处理此问题的更好方法。

答案 2 :(得分:1)

我不会将测试样本放在与您的实际项目相同的存储库中 但IMO在自己的存储库中发布它们并没有错。

我喜欢测试其他人制作的样品。如果这对我来说是一个新主题,我发现我可以理解其他人的测试样本,这个样本比已经熟悉该主题的人更好地学习了一个完整的项目。