From d615e795d28ae041ed25d11d1f64a394c83981f2 Mon Sep 17 00:00:00 2001 From: Joel Natividad <1980690+jqnatividad@users.noreply.github.com> Date: Sun, 15 Oct 2023 17:21:24 -0400 Subject: [PATCH] `readme`: correct Contributing goal [skip ci] --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8cbc0922..bca176f22 100644 --- a/README.md +++ b/README.md @@ -325,7 +325,7 @@ Luau will also serve as the backbone of a whole library of **qsv recipes** - reu * **As Secure as Possible** - qsv is designed to be secure. It has no external runtime dependencies, and it's codebase is regularly audited for security vulnerabilities with automated DevSkim and "cargo audit" Github Actions workflows. It also has a [Security Policy](SECURITY.md). However, it does not use cryptographically secure random number generators as the performance penalty is too high and the qsv's use cases do not require it. (search for the codebase for *"//DevSkim: ignore DS148264"* to find instances where qsv uses a non-cryptographically secure random number generator) -* **As Easy to Contribute to as Possible** - qsv is designed to be easy to contribute to, with a focus on maintainability. It's architecture allows the easy addition of self-contained commands, the source code is heavily commented, the usage text is embedded, and there are helper functions that make it easy to create tests. See [Features](docs/FEATURES.md) for more info.See [Contributing](docs/CONTRIBUTING.md) for more info. +* **As Easy to Contribute to as Possible** - qsv is designed to be easy to contribute to, with a focus on maintainability. It's architecture allows the easy addition of self-contained commands gated by feature flags, the source code is heavily commented, the usage text is embedded, and there are helper functions that make it easy to create tests. See [Features](docs/FEATURES.md) and [Contributing](CONTRIBUTING.md) for more info. QuickSilver's non-goals are to be: * **As Small as Possible** - qsv is designed to be small, but not at the expense of performance, features, composability, portability, usability, security or maintainability. However, we do have a `qsvlite` variant that is ~13% of the size of `qsv` and a `qsvdp` variant that is ~12% of the size of `qsv`. Those variants, however, have reduced functionality.