Improve documentation slightly

This commit is contained in:
Michael Wolf
2024-10-30 21:59:10 -06:00
parent e8771f1156
commit 44fd5a350f
2 changed files with 14 additions and 13 deletions

View File

@@ -8,8 +8,8 @@ following tools installed:
- [shfmt](https://github.com/mvdan/sh)
In general, code should pass shellcheck without warnings, be formatted with
shfmt (please use it with `-i 4`), and come with new tests and pass them when
relevant.
shfmt (please use it with `-i 4`), and when relevant come with new tests and
pass them.
If any of this causes you trouble, don't worry. Please submit your pull
request anyway and we can work on getting it up to snuff.
@@ -24,8 +24,8 @@ request anyway and we can work on getting it up to snuff.
- Be easy to configure.
- Be clearly documented. Remember that many programmers are working in
high-stress situations. Documentation that is incomplete, unclear, or cute
makes things even worse for them. Use English correctly and, to the
extent possible, unambiguously.
makes things even worse for them. Use English correctly and, to the extent
possible, unambiguously.
## Non-goals
@@ -47,7 +47,7 @@ request anyway and we can work on getting it up to snuff.
probably be more confusing than helpful but I'm not wedded to this
conclusion.
- Write a doctor command to identify potential issues (you'd probably run it
similarly to how you run the install script, but `s/install/doctor`).
similarly to how you run the install script, but `s/install/doctor/`).
- Create a nix setup that includes all the tools as fallbacks
- Cache file type sniffing results? How?