我应该如何构建我的Git存储库中的文件/目录？

Question

我刚刚开始使用GitHub。我已经设置了我的公钥，并在OSX上安装了git。我知道在大学学习的时候的命令等。

我想知道的是：大多数GitHub会员使用的是“常规”文件结构吗？我注意到很多人使用'src'，'test'等。有没有人有关于推荐文件结构的更多信息？

我猜想大多数开发人员都会为他们所有的项目使用相同的文件结构，因此他们看起来很相似。如果是这样的话，那么用于我的项目的最佳文件结构是什么？

我不希望用户因使用非常规文件结构而感到困惑。

Answer 1

您可以在github上找到某些项目类型的推荐目录结构，例如： Rails，Gems等，但不适用于Git本身。

Rails - http://guides.rubyonrails.org/command_line.html#rails-generate

Ruby gems - http://seattlerb.rubyforge.org/hoe/

Java - http://java.sun.com/blueprints/code/projectconventions.html

C - Folder structure for a C project

Answer 2

遵循特定编程语言社区所遵循的惯例。

在Perl中，我们通常遵循以下结构：

eg/       # example scripts
lib/      # for modules
scripts/  # scripts to use the modules
t/        # tests
CHANGES
LICENSE
README

Answer 3

从我的角度来看，每个GitHub项目（根据您的问题，您在那里都有一个仓库）应该具有：

1. 与CI服务器（Travis CI，Circle CI等）集成
2. 带有发布/拉出请求模板的.github文件夹（例如https://github.com/zold-io/zold/tree/master/.github）
3. .gitingore以避免意外提交的临时/本地文件
4. .gitattributes用于自定义Git存储库配置（更多https://git-scm.com/book/en/v2/Customizing-Git-Git-Attributes和https://git-scm.com/docs/gitattributes）
5. .rubycop.yml（如果是红宝石项目）
6. 将以下徽章添加到您的readme.md
   • 版本的红宝石宝石
   • 许可证详细信息
   • 每年提交活动以突出项目状态
   • 有关https://www.yegor256.com/2014/11/14/hits-of-code.html的HoC的更多信息
   • 最新版本的状态
   • 依赖状态（是否过时）
   • 显示依赖项的漏洞计数（如果有）
   • 作为代码质量标志

以上示例的项目：

• https://github.com/dgroup/docker-unittests（java）
• https://github.com/mattbrictson/gem（红宝石）