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: README.md
+5-1Lines changed: 5 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -520,6 +520,10 @@ You can set an optional different URL if needed or specify that your DOM uses a
520
520
521
521
## 4.4 Submitting your implementation
522
522
523
+
Please take a look at https://github.com/krausest/js-framework-benchmark/wiki/Process-for-merging-a-pull-request for informations how pull requests are merged.
524
+
525
+
526
+
523
527
Contributions are very welcome. Please use the following rules:
524
528
525
529
- Name your directory frameworks/[keyed|non-keyed]/[FrameworkName]
@@ -531,7 +535,7 @@ Contributions are very welcome. Please use the following rules:
531
535
- Webdriver-ts must be able to run the perf tests for the contribution. This means that all buttons (like "Create 1,000 rows") must have the correct id e.g. like in vanillajs. Using shadow DOM is a real pain for webdriver. The closer you can get to polymer the higher the chances I can make that contribution work.
532
536
- Don't change the ids in the index.html, since the automated benchmarking relies on those ids.
533
537
- Please push only files in your framework folder (not index.html or results.json)
534
-
- **Please make sure your implementation is validated by the test tool.** cd to webdriver-ts and invoke it with `npm run isKeyed [keyed|non-keyed]/[FrameworkName]`. It'll print an error if your framework behaves other as specified. It'll print a big ERROR explaining if it isn't happy with the implementation. Some common errors include:
538
+
- **Please make sure your implementation is validated by the test tool.** cd to the root directory and perform a check `npm run rebuild-ci [keyed|non-keyed]/[FrameworkName]`. It'll print an error if your framework doesn't build, the benchmark can't be run or behaves other as specified. It'll print a big ERROR explaining if it isn't happy with the implementation. Some common errors include:
535
539
- Your package.json is missing some required fields
536
540
- Incorrect classification (Keyed/NonKeyed)
537
541
- You have gzipped files in /dist (unfortunately the web server prefers these when they exist)
0 commit comments