Skip to content

Commit

Permalink
readme: correct Contributing goal
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
jqnatividad committed Oct 15, 2023
1 parent d96c7c7 commit d615e79
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit d615e79

Please sign in to comment.