Added a README to every directory. Closes #452

adam-lynch · adam-lynch · commit a4845dd4bf06 · 2017-05-28T21:51:16.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - If using the package programmatically and it's out of date, a message will be shown (this was always the case for the CLI).
+- There is now a README in every directory (with at least a single sentence summarizing the directory) to help with onboarding contributors.
 
 ### Changed
 
diff --git a/bin/README.md b/bin/README.md
@@ -0,0 +1,7 @@
+This directory contains CLI command handlers. 
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../CONTRIBUTING.md).
diff --git a/build/README.md b/build/README.md
@@ -0,0 +1,7 @@
+This directory contains all build-related scripts. 
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../CONTRIBUTING.md).
diff --git a/example/README.md b/example/README.md
@@ -0,0 +1,7 @@
+This directory contains an example project using nw-builder.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../CONTRIBUTING.md).
diff --git a/example/icons/README.md b/example/icons/README.md
@@ -0,0 +1,7 @@
+This directory contains app icons passed to nw-builder.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
diff --git a/example/nwapp/README.md b/example/nwapp/README.md
@@ -0,0 +1,7 @@
+This directory contains the actual example app code.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
diff --git a/example/nwapp/images/README.md b/example/nwapp/images/README.md
@@ -0,0 +1,7 @@
+Any images used within the example app are stored in this directory.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
diff --git a/lib/README.md b/lib/README.md
@@ -0,0 +1,7 @@
+This directory is where the real code is. See [index.js](index.js), the main / entry file.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../CONTRIBUTING.md).
diff --git a/test/README.md b/test/README.md
@@ -0,0 +1,7 @@
+This directory contains all scripts and more related to testing the app.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../CONTRIBUTING.md).
diff --git a/test/expected/README.md b/test/expected/README.md
@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
diff --git a/test/expected/oneOveriddenRestNot/README.md b/test/expected/oneOveriddenRestNot/README.md
@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/expected/osx-plist/README.md b/test/expected/osx-plist/README.md
@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/expected/platformOverrides/README.md b/test/expected/platformOverrides/README.md
@@ -0,0 +1,7 @@
+Files in this directory represent the expected outcomes for certain scenarios. Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/fixtures/README.md b/test/fixtures/README.md
@@ -0,0 +1,7 @@
+This directory contains all of our [test fixtures](https://en.wikipedia.org/wiki/Test_fixture).
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../CONTRIBUTING.md).
diff --git a/test/fixtures/manifest/README.md b/test/fixtures/manifest/README.md
@@ -0,0 +1,7 @@
+This directory contains all of our manifest-related [test fixtures](https://en.wikipedia.org/wiki/Test_fixture).
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/fixtures/nwapp/README.md b/test/fixtures/nwapp/README.md
@@ -0,0 +1,7 @@
+This directory contains example app related [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/fixtures/oneOveriddenRestNot/README.md b/test/fixtures/oneOveriddenRestNot/README.md
@@ -0,0 +1,7 @@
+This directory contains some [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/fixtures/osx-plist/README.md b/test/fixtures/osx-plist/README.md
@@ -0,0 +1,7 @@
+This directory contains some [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/fixtures/platformOverrides/README.md b/test/fixtures/platformOverrides/README.md
@@ -0,0 +1,7 @@
+This directory contains some [test fixtures](https://en.wikipedia.org/wiki/Test_fixture). Have a look over the tests to see how they're used.
+
+---
+
+## See something which could be improved?
+
+Great, see [CONTRIBUTING.md](../../../CONTRIBUTING.md).
diff --git a/test/nwBuilder.js b/test/nwBuilder.js
diff --git a/test/utils.js b/test/utils.js
@@ -89,7 +89,7 @@ test('generate and write a valid plist file', function (t) {
 test('getFileList', function (t) {
     t.plan(5);
 
-    utils.getFileList('./test/fixtures/nwapp/**').then(function(data) {
+    utils.getFileList(['./test/fixtures/nwapp/**', '!./test/fixtures/nwapp/README.md']).then(function(data) {
         t.equal(data.json, path.normalize('test/fixtures/nwapp/package.json'), 'figure out the right json');
         var expected = [{
             "src" : path.normalize("test/fixtures/nwapp/images/imagefile.img"),
@@ -123,7 +123,7 @@ test('getFileList', function (t) {
         t.equal(error, 'No files matching');
     });
 
-    utils.getFileList(['./test/fixtures/nwapp/**/*', '!./test/fixtures/nwapp/node_modules/**/*',  '!./test/fixtures/nwapp/javascript/**/*']).then(function(data) {
+    utils.getFileList(['./test/fixtures/nwapp/**/*', '!./test/fixtures/nwapp/node_modules/**/*',  '!./test/fixtures/nwapp/javascript/**/*', '!./test/fixtures/nwapp/README.md']).then(function(data) {
         var expected = [{
             "src" : path.normalize("test/fixtures/nwapp/images/imagefile.img"),
             "dest": path.normalize("images/imagefile.img")
