chore(test): Add README.me, CONTRIBUTOR update #3569

Merged
merged 7 commits into from Dec 27, 2016

Projects

None yet

3 participants

@TheLarkInn
Member
TheLarkInn commented Dec 24, 2016 edited

This PR adds a README.md inside of our test suite.

What kind of change does this PR introduce?

Repo Documentation
Did you add tests for your changes?

If relevant, link to documentation update:
N/A

Summary
People seem to not quite yet understand how to add tests and work through the test suite in the webpack code. I think a small rundown will benefit the quality of tests and PR's submitted.

Does this PR introduce a breaking change?

Other information

@TheLarkInn TheLarkInn chore(test): Add README.me, CONTRIBUTOR update
a413aab
CONTRIBUTING.md
@@ -48,7 +48,7 @@ your pull request should be accepted quickly.
Some things that will increase the chance that your pull request is accepted:
-* Write tests
+* [Write tests](./test/README.m`d)
@Equinox
Equinox Dec 24, 2016

I don't think the "`" was intended here.

@TheLarkInn
TheLarkInn Dec 24, 2016 Member

Certainly not!! Thanks

TheLarkInn added some commits Dec 24, 2016
@TheLarkInn TheLarkInn Update CONTRIBUTING.md
4645f39
@TheLarkInn TheLarkInn Update README.md
3cbaff2
@Equinox
Equinox commented Dec 24, 2016 edited

@TheLarkInn There are a few small errors (one missing "`", a spelling error): is it better to point them out now or PR a correction after merge?

(Sorry for asking this here. btw)

@TheLarkInn
Member

Yes please feel free and mark them!!

TheLarkInn added some commits Dec 24, 2016
@TheLarkInn TheLarkInn Update README.md
c5c4692
@TheLarkInn TheLarkInn Update README.md
aab1de5
test/README.md
+#### configCases (`ConfigTestCases.test.js`)*
+If you are trying to solve a bug which is reproducible when x and y properties are used together in a config, then configCases is the place to be!!!!
+
+In addition to an `index.js`, these configCases require a `webpack.config.js` is located inside of your test suite. This will run this specific config through `webpack` just as you were building individually. They will use the same loading/bundling techniqe of your `it()` tests, however you now have a more specific config use cases that you can write even before you start coding.
@Equinox
Equinox Dec 24, 2016

techniqe > technique

test/README.md
+
+
+## Footnotes
+* webpack's parser supports the use of ES2015 features like arrow functions, harmony exports, etc. However as a library we follow NodeJS's timeline for dropping older versions of node. Because of this we expect your tests on Travis to pass all the way back to NodeJS v0.12; Therefore if you would like specific tests that use these features to be ignored if they are not supported, then you should add a `test.filter.js` file. This allows you to import the syntax needed for that test, meanwhile ignoring it on node versions (during CI) that don't support it. webpack has a variety of hel exapmles you can refer to if you are just starting out. See the `./helpers` foler to find a list of the verion
@Equinox
Equinox Dec 24, 2016

hel > help
foler > folder
verion > version(s?).

@TheLarkInn
TheLarkInn Dec 24, 2016 Member

Thank you very much, I admittedly was very sleepy when I pushed this so I'm grateful for the extra spelling checks.

test/README.md
+In addition to an `index.js`, these configCases require a `webpack.config.js` is located inside of your test suite. This will run this specific config through `webpack` just as you were building individually. They will use the same loading/bundling techniqe of your `it()` tests, however you now have a more specific config use cases that you can write even before you start coding.
+
+#### statsCases (`Stats.test.js`)
+Stats cases are similar to configCases except specifically focusing on the `expected` output of your stats. Instad of writing to the console, however the output of stats will be written to disk.
@Equinox
Equinox Dec 24, 2016

Instad > Instead

@TheLarkInn TheLarkInn Update README.md
Corrected spelling mistakes, made footnotes readable.
b6f15c8
@TheLarkInn TheLarkInn ci(flake): update suspect test format to fix broken ci build
86f25b8
@TheLarkInn TheLarkInn merged commit e8cb875 into master Dec 27, 2016

8 of 9 checks passed

coverage/coveralls Coverage decreased (-0.2%) to 91.463%
Details
codecov/changes No unexpected coverage changes found.
Details
codecov/patch Coverage not affected when comparing 8bc25f6...86f25b8
Details
codecov/project 91.28% (+0.00%) compared to 8bc25f6
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details
licence/cla Contributor License Agreement is signed.
Details
@TheLarkInn TheLarkInn deleted the feature/test_contrib_ branch Dec 27, 2016
@nkzawa nkzawa added a commit to nkzawa/webpack that referenced this pull request Dec 29, 2016
@TheLarkInn @nkzawa TheLarkInn + nkzawa chore(test): Add README.me, CONTRIBUTOR update (#3569)
* chore(test): Add README.me, CONTRIBUTOR update. Adds a README.md file to test directory to aid contributors in how to add tests.
a99b99f
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment