You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-11Lines changed: 12 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -101,9 +101,9 @@ from the main (upstream) repository:
101
101
102
102
### <a id="unit-tests"></a>Unit Tests
103
103
104
-
Unit tests are located under the [spec directory](/spec). Unit tests over synchronous operators and operations
105
-
can be written in a standard [jasmine](http://jasmine.github.io/) style. Unit tests written against any
106
-
asynchronous operator should be written in [Marble Test Style outlined in detail here](docs/writing-marble-tests.md).
104
+
Unit tests are located under the [spec directory](/spec). Unit tests over synchronous operators and operations
105
+
can be written in a standard [jasmine](http://jasmine.github.io/) style. Unit tests written against any
106
+
asynchronous operator should be written in [Marble Test Style outlined in detail here](docs/writing-marble-tests.md).
107
107
108
108
Each operator under test must be in its own file to cover the following cases:
109
109
@@ -114,7 +114,7 @@ Each operator under test must be in its own file to cover the following cases:
114
114
- Never ending sequences
115
115
- Early disposal in sequences
116
116
117
-
If the operator accepts a function as an argument from the user/developer (for example `filter(fn)` or `zip(a, fn)`),
117
+
If the operator accepts a function as an argument from the user/developer (for example `filter(fn)` or `zip(a, fn)`),
118
118
then it must cover the following cases:
119
119
120
120
- Success with all values in the callback
@@ -135,19 +135,19 @@ testing techniques.
135
135
- DO add performance tests that you feel are missing from other operators
136
136
- DO add additional performance tests for all worthy code paths. If you develop an operator with special handling for scalar observables,
137
137
please add tests for those scenarios
138
-
138
+
139
139
140
140
#### <a id="macro"></a>Macro
141
-
141
+
142
142
[Macro performance tests](perf/macro) are best written for scenarios where many object instance allocations (or deallocations) are occuring. Operators
143
-
that create a lot of child subscriptions, or operators that emit new objects like Observables and Subjects are definitely worth creating
143
+
that create a lot of child subscriptions, or operators that emit new objects like Observables and Subjects are definitely worth creating
144
144
macro performance tests for.
145
145
146
-
Other scenarios formacro performance testing may include common end-to-end scenarios from real-world apps. If you have a situationin your
146
+
Other scenarios formacro performance testing may include common end-to-end scenarios from real-world apps. If you have a situationin your
147
147
app where you feal RxJS is performing poorly, please [submit and issue](/ReactiveX/RxJS/issues) and include a minimal code example showing
148
148
your performance issues. We would love to solve perf for your real-world problems and add those tests to our perf test battery.
149
149
150
-
Macro performance tests can be run by hosting the root directory with any web server (we use [http-server](https://www.npmjs.com/package/http-server)),
150
+
Macro performance tests can be run by hosting the root directory with any web server (we use [http-server](https://www.npmjs.com/package/http-server)),
0 commit comments