Skip to content

Commit

Permalink
Add FAQ regarding core values
Browse files Browse the repository at this point in the history
  • Loading branch information
kgryte committed Dec 29, 2017
1 parent 2d2b58c commit 59f3320
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
> Common answers to common questions.
- [Why use this project?](#why-use)
- [What are the project's core values?](#core-values)
- [Why numeric computing in JavaScript?](#numeric-computing-in-javascript)
- [Why not use R, Python, or Julia?](#other-languages)
- [Why not exclusively use native add-ons?](#native-add-ons)
Expand Down Expand Up @@ -66,6 +67,22 @@ This project

* * *

<a name="core-values"></a>

### What are the project's core values?

- **Thoroughness**: implementations should be thorough, including testing, benchmarking, and documentation. Algorithms should be researched, studied, and measured. Taking shortcuts is not acceptable. Attention to detail is highly prized. Code should be written well the first time.
- **Rigor**: development should be rigorous. High quality code is expected, and authors are expected to strive for excellence.
- **Robustness**: implementations should demonstrate an exhaustive understanding of how they can fail.
- **Approachability**: user-facing APIs and underlying implementations should be approachable. Interfaces should embrace simplicity. Source code should use the simplest primitives. Documentation should be abundant.
- **Integrity**: all aspects of the project--documentation, testing, benchmarking, implementations, tooling--should form a consistent and coherent whole. Code should be of one voice and reflect a single purpose: to write high quality software.

<!-- </faq-question> -->

<!-- <faq-question> -->

* * *

<a name="numeric-computing-in-javascript"></a>

### Why numeric computing in JavaScript?
Expand Down

0 comments on commit 59f3320

Please sign in to comment.