Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CONTRIBUTING.md to specify starting Redis #134

Closed
seanprashad opened this issue Nov 10, 2019 · 3 comments · Fixed by #135
Closed

Update CONTRIBUTING.md to specify starting Redis #134

seanprashad opened this issue Nov 10, 2019 · 3 comments · Fixed by #135
Assignees
Labels
type: documentation (docs) Improvements or additions to documentation
Projects

Comments

@seanprashad
Copy link
Contributor

seanprashad commented Nov 10, 2019

My Node version is 12.12.0 and my operating system is Mac OS Catalina 10.15.1 (19B88).

As a new individual to telescope, I was trying to setup the project using the steps listed under Setup found here.

However, an error occurred after step 5 (5. Run npm test) which states that the able to add a job to the feed queue test failed due to connect ECONNREFUSED 127.0.0.1:6379.

After grepping the repo for the port 6379, I realized that I had not started the Redis container using docker-compose up -d docker-compose up -d redis. It would be great to include that command in our CONTRIBUTING.md docs before Run npm install.

@seanprashad
Copy link
Contributor Author

I'll be happy to submit a patch for this 🦧

@seanprashad
Copy link
Contributor Author

As these are unit tests, it might be helpful to use redis-mock to simulate a running instance of Redis to avoid this problem in the future.

@humphd
Copy link
Contributor

humphd commented Nov 10, 2019

#122 is related to this as well. A lot of people are stumbling on this. We should fix it in a few ways (docs, better error message, etc).

redis-mock is interesting. We could consider this, but we're already running Redis in CI, so it's not critical. Probably worth filing another issue on it at least. The work in #71 could likely benefit from it in testing as well.

@Reza-Rajabi Reza-Rajabi added this to Issue in Main via automation Nov 11, 2019
@Reza-Rajabi Reza-Rajabi moved this from Issue to To do in Main Nov 11, 2019
@humphd humphd added the type: documentation (docs) Improvements or additions to documentation label Nov 11, 2019
Main automation moved this from To do to Closed Nov 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation (docs) Improvements or additions to documentation
Projects
No open projects
Main
Closed
Development

Successfully merging a pull request may close this issue.

3 participants