This document contains tips, workflows, etc. for working within this repository.
Please note: these dependencies are for bovine development.
Users dependencies are specified in the README.
- Docker: only the daemon is required
- Rust stable toolchain: primary toolchain
- Rust nightly toolchain: secondary toolchain
- This is only used for formatting and external tooling.
bovinedoes not depend on nightly.
Building bovine should be possible on every tier one platform that Rust supports with no restriction on multi-platform development.
We use GNU/BSD make for automation, but it's entirely optional as nearly all commands ran are cargo commands.
This section contains design considerations when working within this repository.
At the moment, bovine does not leverage lib.rs since it's designed for application-use.
Moreover, many of the project's "would-be library contents" log errors and debug messages, which is often seen as an anti-pattern for libraries.
The Docker daemon can return errors that aren't user friendly in a CLI context.
They are entirely adequate for the daemon, but not for bovine.
By using the debug flag (bovine --debug), all daemon errors returned are logged.
Users can see both the daemon error(s) and the custom error(s) in this context.
This might encroach on poor design territory, but since bovine runs with non-persistent execution, the pros outweight the cons: clean UX is provided with the option to enable logging to see both errors.
Having said that, this design point is subject to change.
Executing cargo +nightly fmt within the repository should suffice for most users.
However, logging and printing requires manual review for style:
- logging (non-
INFO): log messages should start with lowercase letters and usually not end with punctuation - logging (
INFO): user messages intended for the user (INFO) are flexible in their style, but should start with uppercase letters when possible - printing: printing directly to
STDOUTorSTDERRis only permitted when re-printing a formatted log