chore(docs): update contributing guidelines to include omnibor #2234
+11
−3
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While working on #2223, I found
omniboris required to run integration tests. This PR includes a script to install required testing toolsHowever, there are a few things I'd like to clear up before going further
doubts
README/CONTRIBUTING.md overlap
Both the README.md and CONTRIBUTING.md have information about contributions—some is overlapping and some is not. Would y'all be interested in any of these options?
Nix
Would y'all prefer updating the devenv.nix be
As of now, the integration test using omnibor fails in the nix devenv, and it seems like not an insignficant amount of work to add omnibor to the devenv.nix, though of course I could be missing something obvious since this is the first time I've used nix
From what little I know of nix, running an install script for something without a deterministic lockfile is not the preferred way to do things. For reference, omnibor-rs does not provide a
Cargo.lock. I have not checked if there is another deterministic build for this beyond directly downloading the artifactsTroubleshooting
I was unable to install omnibor via the devenv.nix
It did not seem that omnibor was already available to use like cargo-insta was https://search.nixos.org/packages?channel=25.11&query=omnibor-cli
Had trouble locally installing nix, so ran a dockerfile with the following configuration
After dropping into the shell with
devenv shelland running tests viacargo test, reproduced the integration test failuretest axolotlsay_basic ... FAILEDI got the git hash from the omnibor releases chore: Release omnibor-v0.7.0 · omnibor/omnibor-rs@80ff804 · GitHub
As mentioned above, no Cargo.lock complicates building from source
It seems possible to set different download URLs per OS and architecture but wanted to check in before spending too much time here