Skip to content

Commit 59f3320

Browse files
committed
Add FAQ regarding core values
1 parent 2d2b58c commit 59f3320

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

FAQ.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
> Common answers to common questions.
66
77
- [Why use this project?](#why-use)
8+
- [What are the project's core values?](#core-values)
89
- [Why numeric computing in JavaScript?](#numeric-computing-in-javascript)
910
- [Why not use R, Python, or Julia?](#other-languages)
1011
- [Why not exclusively use native add-ons?](#native-add-ons)
@@ -66,6 +67,22 @@ This project
6667

6768
* * *
6869

70+
<a name="core-values"></a>
71+
72+
### What are the project's core values?
73+
74+
- **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.
75+
- **Rigor**: development should be rigorous. High quality code is expected, and authors are expected to strive for excellence.
76+
- **Robustness**: implementations should demonstrate an exhaustive understanding of how they can fail.
77+
- **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.
78+
- **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.
79+
80+
<!-- </faq-question> -->
81+
82+
<!-- <faq-question> -->
83+
84+
* * *
85+
6986
<a name="numeric-computing-in-javascript"></a>
7087

7188
### Why numeric computing in JavaScript?

0 commit comments

Comments
 (0)