.gitignore
模板集合
这是 GitHub 的 .gitignore
文件模板集合。我们使用这个列表来填充 GitHub.com 界面中创建新仓库和文件时可用的 .gitignore
模板选择器。
要了解 .gitignore
文件如何工作以及如何使用它们,以下资源是很好的起点:
- Pro Git 书中的 忽略文件章节。
- GitHub 帮助网站上的 忽略文件文章。
- gitignore(5) 手册页。
文件夹结构
我们支持以下方式组织的模板集合:
- 根文件夹包含常用模板,帮助人们开始使用流行的编程语言和技术。这些模板定义了一组有意义的规则,以帮助用户入门,并确保不会将不重要的文件提交到仓库中。
Global
文件夹包含可在不同情况下使用的各种编辑器、工具和操作系统的模板。建议您要么将这些添加到全局模板中,要么如果想永久使用它们,将这些规则合并到项目特定的模板中。community
文件夹包含其他流行语言、工具和项目的专门模板,这些模板目前不属于主流模板。当您决定采用某个框架或工具时,应将这些模板添加到项目特定的模板中。
什么是好的模板?
一个好的模板应包含一组规则,以帮助 Git 仓库与特定的编程语言、框架、工具或环境配合使用。
如果无法为这种情况精选一小组有用的规则,那么该模板就不适合这个集合。
如果模板主要是某个特定版本软件(例如 PHP 框架)安装的文件列表,它可以放在 community
目录下。有关更多详细信息,请参阅版本化模板。
如果您有一小组规则,或想支持一种不广泛使用的技术,但仍认为这对他人有帮助,请阅读专门模板部分了解更多详情。
如果模板重要且显眼,在开启拉取请求时请包含详细信息。我们可能不会立即接受它,但可以根据兴趣在稍后将其提升到根目录。
请也理解,我们无法列出所有曾经存在的工具。我们的目标是策划一个最常用和最有帮助的模板集合,而不是确保涵盖每个可能的项目。如果我们选择不包括您的语言、工具或项目,这并不意味着它不够出色。
贡献指南
我们很乐意您帮助我们改进这个项目。为了保持这个集合的高质量,我们要求贡献遵循以下指南。
-
提供应用程序或项目主页的链接。除非它非常流行,否则维护者可能不了解或不使用您的更改所适用的语言、框架、编辑器、应用程序或项目。
-
提供支持您所做更改的文档链接。最好是提及被忽略文件的当前、权威文档。如果没有可用的文档支持您的更改,请尽最大努力解释被忽略的文件用途。
-
解释为什么要进行更改。即使看起来不言而喻,也请花一两句话告诉我们为什么应该进行您的更改或添加。特别有帮助的是阐明为什么这个更改适用于所有使用相关技术的人,而不仅仅是您或您的团队。
-
请考虑更改的范围。如果您的更改是特定于某种语言或框架的,请确保将更改应用于该语言或框架的模板,而不是编辑器、工具或操作系统的模板。
-
请每个拉取请求只修改一个模板。这有助于将拉取请求和反馈集中在特定的项目或技术上。
总的来说,您越能帮助我们理解您所做的更改,我们就越有可能快速接受您的贡献。
版本化模板
某些模板在不同版本之间可能会有很大变化,如果您希望为这个仓库做出贡献,我们需要遵循以下特定流程:
- 根目录中的模板应该是当前支持的版本
- 根目录中的模板文件名不应包含版本(即"常青")
- 以前版本的模板应放在
community/
下 - 以前版本的模板应在文件名中嵌入版本,以便于阅读
这有助于确保用户获得最新版本(因为他们会使用根目录中的任何内容),同时帮助维护者支持仍在使用的旧版本。
专门模板
如果您有想贡献的模板,但它不太主流,请考虑将其添加到 community
目录下最适合它的文件夹中。
您的专门模板中的规则应该特定于框架或工具,任何额外的模板都应在模板头部的注释中提及。
例如,这个模板可能位于 community/DotNet/InforCRM.gitignore
:
# InforCRM(前身为 SalesLogix)的 gitignore 模板
# 网站:https://www.infor.com/product-summary/cx/infor-crm/
#
# 推荐:VisualStudio.gitignore
# 忽略自动生成的模型文件
ModelIndex.xml
ExportedFiles.xml
# 忽略部署文件
[Mm]odel/[Dd]eployment
# 强制包含门户 SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in
贡献工作流程
以下是我们建议您提出对这个项目进行更改的方式:
使用基于 Web 的界面进行更改也很好,它会自动帮您 fork 项目并提示您发送拉取请求。