Skip to content

Commit 309d9aa

Browse files
committed
clearer and less subtly-ableist language in README
1 parent a9c4b62 commit 309d9aa

File tree

1 file changed

+18
-13
lines changed

1 file changed

+18
-13
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,22 +39,26 @@ they're the greatest. I'm not going to do that.
3939

4040
### <i lang="it">tutti i gusti, sono gusti</i>
4141

42+
Software testing is a software and user experience design challenge
43+
that balances on the intersection of many conflicting demands.
44+
4245
Node-tap is based on [my](http://izs.me) opinions about how a test
4346
framework should work, and what it should let you do. I do _not_ have
44-
any opinion about whether or not you share those opinions.
47+
any opinion about whether or not you share those opinions. If you do
48+
share them, you will probably enjoy this test library.
4549

4650
1. **Test files should be "normal" programs that can be run
4751
directly.**
4852

4953
That means that it can't require a special runner that
5054
puts magic functions into a global space. `node test.js` is a
51-
perfectly reasonable way to run a test, and it ought to function
55+
perfectly ok way to run a test, and it ought to function
5256
exactly the same as when it's run by the fancy runner with
5357
reporting and such. JavaScript tests should be JavaScript
5458
programs; not english-language poems with weird punctuation.
5559

56-
2. **Test output should be sensibly connected to the structure of the
57-
test file.**
60+
2. **Test output should be connected to the structure of the
61+
test file that is easy to determine.**
5862

5963
That means not unnecessarily deferring test functions
6064
until `nextTick`, because that would shift the order of
@@ -86,12 +90,12 @@ any opinion about whether or not you share those opinions.
8690
5. **Test reporting should be separate from the test process, included
8791
in the framework, and enabled by default for humans.**
8892

89-
The [raw test output](http://www.node-tap.org/tap-format/) should be machine-parseable and
90-
human-intelligible, and a separate process should consume test
91-
output and turn it into a [pretty summarized
92-
report](http://www.node-tap.org/reporting/).
93-
This means that test data can be stored and parsed later, dug into
94-
for additional details, and so on. Also: nyan cat.
93+
The [raw test output](http://www.node-tap.org/tap-format/) should
94+
be machine-parseable and human-intelligible, and a separate process
95+
should consume test output and turn it into a [pretty summarized
96+
report](http://www.node-tap.org/reporting/). This means that test
97+
data can be stored and parsed later, dug into for additional
98+
details, and so on. Also: nyan cat.
9599

96100
6. **Writing tests should be easy, maybe even fun.**
97101

@@ -104,7 +108,7 @@ any opinion about whether or not you share those opinions.
104108

105109
That being said, if the you returns a Promise, or use a DSL that
106110
throws a decorated error, then the test framework should Just Work
107-
in a way that is reasonable.
111+
in a way that helps a human being understand the situation.
108112

109113
7. **Tests should output enough data to diagnose a failure, and no
110114
more or less.**
@@ -138,8 +142,9 @@ any opinion about whether or not you share those opinions.
138142

139143
Babel and Webpack are lovely and fine. But if your code doesn't
140144
require compilation, then I think your tests shouldn't either.
141-
Tap is extremely [promise-aware](http://www.node-tap.org/promises/), but works on any
142-
version of Node.js back to v0.10.
145+
Tap is extremely
146+
[promise-aware](http://www.node-tap.org/promises/), but works on
147+
any version of Node.js back to v0.10.
143148

144149
Software testing should help you build software. It should be a
145150
security blanket and a quality ratchet, giving you the support to

0 commit comments

Comments
 (0)