Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
db1d52b
Move current Drupal into ecosystem directory
shiftkey Oct 27, 2018
344e52b
Update default template to Drupal 8
shiftkey Oct 27, 2018
7af655e
add a better header to the old template
shiftkey Oct 27, 2018
663ff83
Move Magento v1 into ecosystem
shiftkey Oct 27, 2018
37ec8ba
add section about updated folder structure
shiftkey Oct 27, 2018
1980e4f
prettify things
shiftkey Oct 27, 2018
1abbddb
expanded new sections
shiftkey Oct 27, 2018
ded1dab
a bit more edits
shiftkey Oct 27, 2018
3641b16
tweaks to example template
shiftkey Oct 27, 2018
c440ae4
stub an example Vue gitignore template
shiftkey Oct 27, 2018
eda6ba5
rename ecosystem to community
shiftkey Oct 28, 2018
1ab24a3
add support for Nuxt.js
shiftkey Oct 28, 2018
05c5eac
add a template for Phoenix projects
shiftkey Oct 28, 2018
bd97b79
added community Pimcore template
shiftkey Oct 28, 2018
2055dc1
Added community template for ThinkPHP
shiftkey Oct 28, 2018
bbd34a4
add community Snap template
shiftkey Oct 28, 2018
d298644
added Hugo community template
shiftkey Oct 28, 2018
e67a985
Add community template for Red language
shiftkey Oct 28, 2018
8a2fae7
add templates for older JBoss versions
shiftkey Oct 28, 2018
991acca
add community template for KenticoCMS
shiftkey Oct 28, 2018
eff87b9
added community template for InforCRM
shiftkey Oct 28, 2018
7637178
add community template for Meteor
shiftkey Oct 28, 2018
213a053
added community template for PHP CodeSniffer
shiftkey Oct 28, 2018
e5c5a2b
add community template for Racket
shiftkey Oct 28, 2018
f29f404
add community template for LogTalk
shiftkey Oct 28, 2018
d9977d1
add community template for Cordova
shiftkey Oct 28, 2018
2277645
add community template for NW.js
shiftkey Oct 28, 2018
3352aa4
Merge branch 'master' into experiment-ecosystem-groupings
shiftkey Nov 9, 2018
9c47778
Update README.md
shiftkey Nov 22, 2018
b7dc63a
added bitrix community template
shiftkey Nov 22, 2018
e9883e5
update header for Drupal template
shiftkey Nov 22, 2018
f7c4f2e
line endings
shiftkey Nov 22, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 42 additions & 35 deletions Drupal.gitignore
Original file line number Diff line number Diff line change
@@ -1,39 +1,46 @@
# Ignore configuration files that may contain sensitive information.
sites/*/*settings*.php
sites/example.sites.php
# gitignore template for Drupal 8 projects
#
# earlier versions of Drupal are tracked in `community/Python/`

# Ignore paths that contain generated content.
files/
sites/*/files
sites/*/private
sites/*/translations
# Ignore configuration files that may contain sensitive information
/sites/*/*settings*.php
/sites/*/*services*.yml

# Ignore default text files
robots.txt
/CHANGELOG.txt
/COPYRIGHT.txt
/INSTALL*.txt
# Ignore paths that may contain user-generated content
/sites/*/files
/sites/*/public
/sites/*/private
/sites/*/files-public
/sites/*/files-private

# Ignore paths that may contain temporary files
/sites/*/translations
/sites/*/tmp
/sites/*/cache

# Ignore drupal core (if not versioning drupal sources)
/core
/modules/README.txt
/profiles/README.txt
/sites/README.txt
/sites/example.sites.php
/sites/example.settings.local.php
/sites/development.services.yml
/themes/README.txt
/vendor
/.csslintrc
/.editorconfig
/.eslintignore
/.eslintrc.json
/.gitattributes
/.htaccess
/autoload.php
/composer.json
/composer.lock
/example.gitignore
/index.php
/LICENSE.txt
/MAINTAINERS.txt
/UPGRADE.txt
/README.txt
sites/README.txt
sites/all/libraries/README.txt
sites/all/modules/README.txt
sites/all/themes/README.txt

# Ignore everything but the "sites" folder ( for non core developer )
.htaccess
web.config
authorize.php
cron.php
index.php
install.php
update.php
xmlrpc.php
/includes
/misc
/modules
/profiles
/scripts
/themes
/robots.txt
/update.php
/web.config
100 changes: 86 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,47 @@ the following resources are a great place to start:

## Folder structure

The files in the root directory are for `.gitignore` templates that are
project-specific, such as language or framework specific templates.
Global (operating system or editor specific) templates should go into the
[`Global/`](./Global) directory.
We support a collection of templates, organized in this way:

- the root folder contains templates in common use, to help people get started
with popular programming languages and technologies. These define a meaningful
set of rules to help get started, and ensure you are not committing
unimportant files into your repository
- [`Global`](./Global) contains templates for various editors, tools and
operating systems that can be used in different situations. It is recommended
that you either [add these to your global template](https://help.github.com/articles/ignoring-files/#create-a-global-gitignore)
or merge these rules into your project-specific templates if you want to use
them permanently.
- [`community`](./community) contains specialized templates for other popular
languages, tools and project, which don't currently belong in the mainstream
templates. These should be added to your project-specific templates when you
decide to adopt the framework or tool.

## What makes a good template?

A template should contain a set of rules to help Git repositories work with a
specific programming language, framework, tool or environment.

If it's not possible to curate a small set of useful rules for this situation,
then the template is not a good fit for this collection.

If a template is mostly a list of files installed by a particular version of
some software (e.g. a PHP framework), it could live under the `community`
directory. See [versioned templates](#versioned-templates) for more details.

If you have a small set of rules, or want to support a technology that is not
widely in use, and still believe this will be helpful to others, please read the
section about [specialized templates](#specialized-templates) for more details.

If you believe your template is important and should be highly visible, please
add details about the impact of the technology when you open a pull request. We
may not accept it immediately, but we can promote it to the root at a later date
based on interest.

Please also understand that we can’t list every tool that ever existed.
Our aim is to curate a collection of the _most common and helpful_ templates,
not to make sure we cover every project possible. If we choose not to
include your language, tool, or project, it’s not because it’s not awesome.

## Contributing guidelines

Expand All @@ -39,29 +76,64 @@ high quality, we request that contributions adhere to the following guidelines.

- **Explain why you’re making a change**. Even if it seems self-evident, please
take a sentence or two to tell us why your change or addition should happen.
It’s especially helpful to articulate why this change applies to *everyone*
It’s especially helpful to articulate why this change applies to _everyone_
who works with the applicable technology, rather than just you or your team.

- **Please consider the scope of your change**. If your change is specific to a
certain language or framework, then make sure the change is made to the
template for that language or framework, rather than to the template for an
editor, tool, or operating system.

- **Please only modify *one template* per pull request**. This helps keep pull
- **Please only modify _one template_ per pull request**. This helps keep pull
requests and feedback focused on a specific project or technology.

In general, the more you can do to help us understand the change you’re making,
the more likely we’ll be to accept your contribution quickly.

If a template is mostly a list of files installed by a particular version of
some software (e.g. a PHP framework) then it's brittle and probably no more
helpful than a simple `ls`. If it's not possible to curate a small set of
useful rules, then the template might not be a good fit for this collection.
## Versioned templates

Please also understand that we can’t list every tool that ever existed.
Our aim is to curate a collection of the *most common and helpful* templates,
not to make sure we cover every project possible. If we choose not to
include your language, tool, or project, it’s not because it’s not awesome.
Some templates can change greatly between versions, and if you wish to contribute
to this repository we need to follow this specific flow:

- the template at the root should be the current supported version
- the template at the root should not have a version in the filename (i.e.
"evergreen")
- previous versions of templates should live under `community/`
- previous versions of the template should embed the version in the filename,
for readability

This helps ensure users get the latest version (because they'll use whatever is
at the root) but helps maintainers support older versions still in the wild.

## Specialized templates

If you have a template that you would like to contribute, but it isn't quite
mainstream, please consider adding this to the `community` directory under a
folder that best suits where it belongs.

The rules in your specialized template should be specific to the framework or
tool, and any additional templates should be mentioned in a comment in the
header of the template

For example, this template might live at `community/DotNet/InforCRM.gitignore`:

```
# gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml

# Ignore deployment files
[Mm]odel/[Dd]eployment

# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in
```

## Contributing workflow

Expand Down
15 changes: 15 additions & 0 deletions community/DotNet/InforCMS.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml

# Ignore deployment files
[Mm]odel/[Dd]eployment

# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in
64 changes: 64 additions & 0 deletions community/DotNet/Kentico.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
# gitignore template for using Kentico CMS
# website: http://www.kentico.com/
#
# Recommended template: VisualStudio.gitignore

# Include some Kentico folders excluded by Visual Studio rules
!CMS/CMSAdminControls/*/
!CMS/CMSModules/System/*/
!CMS/App_Data/CIRepository/**

# Kentico temporary/environment files
CMS/App_Data/AzureCache
CMS/App_Data/AzureTemp
CMS/App_Data/CMSModules/DeviceProfile/logFiftyOne.txt
CMS/App_Data/CMSModules/DeviceProfiles/logFiftyOne.txt
CMS/App_Data/CMSModules/WebFarm/webfarm.sync
CMS/App_Data/CMSTemp
CMS/App_Data/Persistent
CMS/CMSSiteUtils/Export
CMS/CMSSiteUtils/Import

# Ignore all smart search indexes, but not the other system folder contents
CMS/App_Data/CMSModules/SmartSearch/**
!CMS/App_Data/CMSModules/SmartSearch/*/
!CMS/App_Data/CMSModules/SmartSearch/_StopWords/**
!CMS/App_Data/CMSModules/SmartSearch/_Synonyms/**

## Kentico Starter Sites
# Starter site resource Files
CMS/App_Data/DancingGoat

# Starter site web templates
CMS/App_Data/Templates/CommunitySite
CMS/App_Data/Templates/CorporateSite
CMS/App_Data/Templates/DancingGoat
CMS/App_Data/Templates/EcommerceSite
CMS/App_Data/Templates/IntranetPortal
CMS/App_Data/Templates/PersonalSite

# Starter site app themes
CMS/App_Themes/CommunitySite
CMS/App_Themes/CorporateSite
CMS/App_Themes/EcommerceSite
CMS/App_Themes/IntranetPortal*
CMS/App_Themes/PersonalSite

# Starter site ASPX templates
CMS/CMSTemplates/CorporateSite

# Starter site media libraries
CMS/CommunitySite
CMS/CorporateSite
CMS/DancingGoat
CMS/EcommerceSite
CMS/IntranetPortal
CMS/PersonalSite

## Project specific ignores
# Sensitive settings
AppSettings.config
ConnectionStrings.config

# Project media libraries (recommend shared file storage)
# e.g. CMS/{SiteCodeName}
22 changes: 22 additions & 0 deletions community/Elixir/Phoenix.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# gitignore template for Phoenix projects
# website: http://www.phoenixframework.org/
#
# Recommended template: Elixir.gitignore

# Temporary files
/tmp

# Static artifacts
/node_modules
/assets/node_modules

# Since we are building assets from web/static,
# we ignore priv/static. You may want to comment
# this depending on your deployment strategy.
/priv/static/

# Installer-related files
/installer/_build
/installer/tmp
/installer/doc
/installer/deps
8 changes: 8 additions & 0 deletions community/Golang/Hugo.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# gitginore template for Hugo projects
# website: https://gohugo.io

# generated files by hugo
/public/

# executable may be added to repository
hugo.exe
19 changes: 19 additions & 0 deletions community/Java/JBoss4.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# gitignore for JBoss v4 projects

/server/all/data
/server/all/log
/server/all/tmp
/server/all/work
/server/default/data
/server/default/log
/server/default/tmp
/server/default/work
/server/minimal/data
/server/minimal/log
/server/minimal/tmp
/server/minimal/work

# Note:
# there may be other directories that contain *.xml.failed or *.war.failed files
/server/default/deploy/*.xml.failed
/server/default/deploy/*.war.failed
33 changes: 33 additions & 0 deletions community/Java/JBoss6.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# gitignore for JBoss v6 projects
#
# Note: to ensure empty directories remain part of the repository, like
# `/server/minimal/lib`, you should add an empty `.gitignore` or `.gitkeep` file
# to the directory - otherwise you may have issues when starting the service.

/server/all/data
/server/all/log
/server/all/tmp
/server/all/work
/server/default/data
/server/default/log
/server/default/tmp
/server/default/work
/server/minimal/data
/server/minimal/log
/server/minimal/tmp
/server/minimal/work
/server/jbossweb-standalone/data
/server/jbossweb-standalone/log
/server/jbossweb-standalone/tmp
/server/jbossweb-standalone/work
/server/standard/data
/server/standard/log
/server/standard/tmp
/server/standard/work
/server/default/deploy/*.jar.failed
/server/default/deploy/*.jar.dodeploy
/server/default/deploy/*.xml.failed
/server/default/deploy/*.xml.dodeploy
/server/default/deploy/*.war.failed
/server/default/deploy/*.war.dodeploy

10 changes: 10 additions & 0 deletions community/JavaScript/Cordova.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# gitignore template for the Cordova framework
# website: https://cordova.apache.org/
#
# Recommended template: Node.gitignore

# App platform binaries and built files
/platforms

# Optional to ignore plugin Git clones
#/plugins
12 changes: 12 additions & 0 deletions community/JavaScript/Meteor.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# gitignore template for the Meteor framework
# website: https://www.meteor.com/
#
# Recommended template: Node.gitignore

# protect api keys in setting json
settings-production.json
settings.json

# protect your mup.json settings
mup.json
mup.js
Loading