docs: Update guidance on running tests#441
Merged
BrianJKoopman merged 2 commits intomainfrom Dec 9, 2025
Merged
Conversation
We were doing this because dependencies were hard to install, but now so3g is pip installable. And running tests within a container is potentially confusing to users.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
This update highlights the need for Docker and Docker Compose, as well as the need to build the Docker images, when running the tests.
This also drops the guidelines on running tests within containers, which was only really useful back when so3g/spt3g was difficult to install. Leaving this in is just potentially confusing to users.
Motivation and Context
Recent new users have pointed out that the tests do not run when strictly following the current instructions.
How Has This Been Tested?
Tested the updated procedure by strictly following the README in a clean Ubuntu 22.04 VM.
Types of changes
Checklist: