Performance & Readability > Benchmarks

danielbankhead · Mar 16, 2017 · 1ec9dd5 · 1ec9dd5
1 parent 9fa1d3a
commit 1ec9dd5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 7 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,8 +4,12 @@
 
 - Search before filing an issue or pull request
 - Feel free to take a try at [FUTURE.md](FUTURE.md)
-- Create tests and benchmarks for new features.
+- Create tests for new features.
   - If you need help we can work through this during the PR process, but it will take additional time.
+- When it comes to performance vs readability the following order is preferred:
+  - performance gains greater than 5%
+  - code readability
+  - performance gains less than 5%
 - Run tests before making proposed changes (we use [pre-commit](https://www.npmjs.com/package/pre-commit) to automate this step)
 - You must agree to the [Developer's Certificate of Origin](http://developercertificate.org) (found below).
 

diff --git a/FUTURE.md b/FUTURE.md
@@ -2,11 +2,6 @@
   - examples/
     - add a few examples
 
-  - benchmark/
-    - should save (as JSON?) and compare existing results in [data/benchmark/](data/benchmark/)
-    - compare based on time w/ diff by percent
-    - run each command an appropriate amount of times
-
   - parse JSON results
     - `results.json`
 

diff --git a/package.json b/package.json
@@ -46,7 +46,6 @@
   "nyc": {
     "branches": 100,
     "exclude": [
-      "benchmark",
       "dev"
     ],
     "functions": 100,