Skip to content

Commit b28fc79

Browse files
committed
some suggestions and minor changes
1 parent 245af80 commit b28fc79

File tree

3 files changed

+20
-7
lines changed

3 files changed

+20
-7
lines changed

src/overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ related initiatives:
77

88
- Creating the `rust-seq` stack: a collection of community-developed libraries
99
and tooling (written in Rust) that are collaboratively developed to provide a
10-
high-quality, symbiotic foundation for omics-based analysis tools.
10+
high-quality, synergistic foundation for omics-based analysis tools.
1111
- Developing asyncronous mechanisms for identifying gaps in the ecosystem and
1212
facilitating community discussion around those gaps (e.g., "what crates _need_
1313
to exist but don't yet?").

src/stack.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
# The `rust-seq` Stack
22

33
The `rust-seq` stack is developed in a distributed manner. This means that
4-
some crates will be available on the [`rust-seq` GitHub], while others will be
4+
some crates will be available on the [`rust-seq` GitHub], while others may be
55
available under different organizations.
66

7+
However, we will seek to have an up-to-date list of relevant crates related to
8+
the `rust-seq` effort within the [`rust-seq` registry].
9+
710
[`rust-seq` GitHub]: https://github.com/rust-seq
11+
[`rust-seq` registry]: https://github.com/rust-seq/registry

src/stack/values.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ The following are values for any crates adopted in the `rust-seq` stack.
55
## Correctness
66

77
Most fundamentally, software in the `rust-seq` stack is designed to produce
8-
correct results or error with reasonable error messages when producing correct
8+
correct results or to error with reasonable error messages when producing correct
99
results is not possible. We collectively believe that bioinformatics tools today
10-
are fragile and all too often either (a) silently fail or (b) return unhelpful
11-
information when failures occur. Eliminating these modes of failure in omics
10+
are unnecessarily fragile and all too often either (a) silently fail or (b) return
11+
unhelpful information when failures occur. Eliminating these modes of failure in omics
1212
development and analyses is one of the primary reasons the project was created.
1313

1414
To that end, correctness should be considered the highest priority of crates in
@@ -22,11 +22,15 @@ unlikely to be widely adopted and used. As such, there is a high emphasis on
2222
optimization and benchmarking for crates in the `rust-seq` stack. Changes that
2323
introduce regressions in performance are unlikely to be accepted (unless the
2424
case is sufficiently demonstrated that a new feature is worth the cost of a
25-
performance hit).
25+
performance hit). Likewise, if a `rust-seq` create is created to provide
26+
or mimic functionality that is provided in a library within some other language
27+
(e.g. C, C++, Go, etc.), it is expected, in general, that the `rust-seq`
28+
implementation will be similarly (or more) performant than the library
29+
providing this functionality in another language.
2630

2731
# Contributable
2832

29-
Crates in the `rust-seq` stack are designed to be contributed to be the
33+
Crates in the `rust-seq` stack are designed to be contributed to the
3034
community. Though one individual may carry the vision for a particular crate in
3135
the beginning, it should be possible for anyone to take a few hours to
3236
grok a crate's design, develop a set of improvements, and then submit those
@@ -45,6 +49,11 @@ crates necessitates many common practices, including:
4549
largely by enabling the [`missing_docs`],
4650
[`clippy::missing_docs_in_private_items`], and
4751
[`rustdoc::missing_doc_code_examples`] lints.
52+
- All crates are **freely-licensed** to enable them to be adopted within other
53+
projects and to be used in the broadest variety of contexts. Thus, while
54+
different crates may adopt different specific licenses (e.g. BSD, MIT, etc.),
55+
crates with commercial, "free for non-commercial use", and "viral copyleft"
56+
(e.g. GPL) licenses will not be considered barring extraordanary circumstances.
4857

4958
All of the above should be independently verified and readily reported by
5059
continuous integration processes on PRs to ensure that contributors can iterate

0 commit comments

Comments
 (0)