aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarl Suster <carl@contraflo.ws>2015-03-01 12:53:03 +1100
committerCarl Suster <carl@contraflo.ws>2015-03-01 12:53:03 +1100
commit69fef749cb58953eb1091c36b88882dd19e50096 (patch)
treec23fe1f1c54b651fe1873f24d11d3de84aea92fc
parenteaeed89430318d8b04bc4734bd07190aaaeb29bd (diff)
downloadgitignore-reduce-noise.tar.gz
gitignore-reduce-noise.zip
Add an explanation to reduce PHP framework clutterreduce-noise
-rw-r--r--CONTRIBUTING.md5
-rw-r--r--README.md5
2 files changed, 10 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 91543ab4..1b94f6cb 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -28,6 +28,11 @@ high quality, we request that contributions adhere to the following guidelines.
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.
+
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
diff --git a/README.md b/README.md
index 14042e94..684a1abf 100644
--- a/README.md
+++ b/README.md
@@ -53,6 +53,11 @@ high quality, we request that contributions adhere to the following guidelines.
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.
+
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