docs: improve contribution guides #361
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
5ad6bbe to
b3059ef
Compare
dsharma-dc
approved these changes
Jan 20, 2025
Adds a nixos shell for local testing. This a headless vm with lvm installed and configured for testing, as well as being a single node k3s cluster. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Lint contributing doc Improve development setup guide, including the nixos-shell k3s docs Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
a102606 to
5fee227
Compare
Use cli arguments to control cleanup rather than using env variables which are more obscure. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
Rather than add static flags and use musl, do the same as zfs and disable cgo Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
bf28ed9 to
cfab0cc
Compare
Add test role label for easier cleanup Simplify jq command on cleanup Also improves test duration by using retry loop rather than hardcoded sleep. Signed-off-by: Tiago Castro <tiagolobocastro@gmail.com>
cfab0cc to
f4cd440
Compare
abhilashshetty04
approved these changes
Jan 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request template
Why is this PR required? What issue does it fix?:
I had a bit of trouble running the tests and getting them to pass recently.
We can improve things.
What this PR does?:
Improves on the existing documentation.
Facilitates testing with a no-frills ready-made vm.
Does this PR require any upgrade changes?:
No
Checklist:
<type>(<scope>): <subject>