Skip to content

Incorrect installation procedure? #27

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

Closed
phacks opened this issue Aug 22, 2022 · 2 comments · Fixed by #28
Closed

Incorrect installation procedure? #27

phacks opened this issue Aug 22, 2022 · 2 comments · Fixed by #28

Comments

@phacks
Copy link
Contributor

phacks commented Aug 22, 2022

Hey! Thanks for this project 🙌

I was looking into contributing to this gem (#4 would be a major improvement to our team’s DX), and got through the gem installation procedure listed in Development. Here are the issues or inconsistencies I saw:

  • bin/setup does not exist. Running bundle in the folder did install the required dependencies though!
  • bin/console does not exist. Is it something that you plan on adding to the gem, or should the documentation be updated to remove the mention?

Happy to open a PR to update the docs!

@kddnewton
Copy link
Member

Oh jeez. Yeah that's templated when you run bundle gem. If you wouldn't mind opening a PR, that'd be great!

It should say to set up dependencies you should run bundle install. You can also run bundle console to open a console if you want.

@phacks
Copy link
Contributor Author

phacks commented Aug 22, 2022

If you wouldn't mind opening a PR, that'd be great!

Will do!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants