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

Improve the "Gem development" section of README? #551

Closed
shouichi opened this issue Apr 4, 2022 · 2 comments · Fixed by #670
Closed

Improve the "Gem development" section of README? #551

shouichi opened this issue Apr 4, 2022 · 2 comments · Fixed by #670

Comments

@shouichi
Copy link
Contributor

shouichi commented Apr 4, 2022

It is instructed to run bin/setup but it does not always work (depends on the ruby version). For example, with ruby 3.1.x, it does not work because the matrix gem was removed. Instead bundle exec appraisal should be used.

https://github.com/bensheldon/good_job#gem-development

Also, it might be a good idea to move this entire section to "CONTRIBUTING file".

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors

Thank you.

@shouichi shouichi changed the title Improve Gem development section of README? Improve the "Gem development" section of README? Apr 4, 2022
@bensheldon
Copy link
Owner

@shouichi thank you for the feedback and suggestions! I'll work on improving this section.

@shouichi
Copy link
Contributor Author

shouichi commented May 2, 2022

Thank you! Feel free to close this when you think it's done 👍

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

Successfully merging a pull request may close this issue.

2 participants