@@ -14,7 +14,8 @@ There are several ways to contribute to posixutils-rs:
14
14
3 . Test coverage: Integration tests, positive and negative, are complete, pass 100%
15
15
4 . Code coverage: Automated code coverage data indicates 100%
16
16
5 . Translated: All strings are internationalized, including common OS errors for common error cases.
17
- 6 . Audited: An external party has reviewed and tested for POSIX compliance.
17
+ 6 . Audited: An external party has reviewed and tested for correctness,
18
+ POSIX compliance, security, races and similar issues.
18
19
19
20
### Coding considerations
20
21
@@ -31,18 +32,24 @@ There are several ways to contribute to posixutils-rs:
31
32
2 . Ideal goal: ** Each utility should look like a standard Rust CLI program.**
32
33
Small, lightweight utility with command line processing,
33
34
core algorithm, and zero external crate dependencies.
34
- 3 . "only std" When an external crate is required, avoid mega-crates. Prefer std-only, or, tiny
35
- crates such as ` atty ` that perform a single, lightweight function.
35
+ 3 . "only std" When an external crate is required, avoid mega-crates. Prefer
36
+ std-only, or, tiny crates such as ` atty ` that perform a single,
37
+ lightweight function.
36
38
4 . Correctness, readability, performance, in that order.
37
- Code should be readable by unfamiliar developers.
38
- Avoid dense, uncommented code.
39
+ Code should be readable by unfamiliar developers. Avoid dense,
40
+ uncommented code.
39
41
40
- ### Testing and POSIX compliance goals
42
+ ### Testing, POSIX compliance and programmaticgoals
41
43
42
44
* All utilities should have tests.
43
45
* Only "quick" tests should be run automatically in ` cargo test `
44
- * Goal #1 : POSIX compliance
45
- * Goal #2 : Support the most popular Linux/BSD extesnsions
46
+ * Longer tests, or tests requiring root access, should be triggered
47
+ via special environment variables.
48
+ * POSIX compliance
49
+ * Support the most widely used GNU/BSD extensions
50
+ * If a system has an OS-specific feature that _ must_ be
51
+ exposed through a given utility, do so.
52
+ * Race-free userland. ` walker ` crate should be able to help.
46
53
47
54
### Testing and Bug Reporting
48
55
0 commit comments