docs: Add section on running tests to contributing guide #953
Conversation
CONTRIBUTING.md
Outdated
|
|
||
| Refinery tests require a local instance of Redis to execute. A simple way to run this is using Docker: | ||
|
|
||
| `docker run --name refinery-redis -p 6379:6379 -d redis` |
There was a problem hiding this comment.
This assumes that you have docker installed and the daemon is running, and that you've got an image for redis. And you get exactly the same result as if you had installed and run redis. Like, docker didn't actually do anything for you here and added a bunch of friction to the process.
Personally, I installed redis using brew, and it runs in the background all the time. Or I could run it on demand.
I'm not anti-docker, but I do think it adds friction, and I'm not sure what it brings to the table here. In any case, if we're going to say this, we should probably also include how to get an appropriate image.
There was a problem hiding this comment.
Sure, if you feel we don't need to hand-hold readers with getting redis setup I'm good to remove the docker suggestion.
Do you feel there's value in demonstrating how tests are expected to be run, with the caveat of requiring redis be available?
There was a problem hiding this comment.
I do think there's value in demonstrating testing, and I think it's worth telling people they need redis. I was only questioning why you were running redis in docker instead of standalone.
Maybe we just say "Tests require a local installation of redis. See here for how to get it running. "
There was a problem hiding this comment.
Updated to refer to external docs for installing redis 👍🏻
Which problem is this PR solving?
Adds a section to the contributing guide to show to execute tests locally.
Short description of the changes
.tools-versionfile that sets the expected golang version to 1.21.1