Add contributing instructions to readme #763
Merged
Conversation
This file contains 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
mathieujobin
reviewed
Jun 6, 2022
| Since this gem does not have a Gemfile, you need to specify it in your shell with: | ||
|
|
||
| .. code:: shell | ||
| BUNDLE_GEMFILE='gemfiles/Gemfile.rails61' |
There was a problem hiding this comment.
Thank you for this. you're right, this is helpful for new people.
Maybe we should keep a default Gemfile, I recently removed it and honestly, I don't remember why it felt redundant.
but this is the correct way to specify the rails version you'd expect.
that said, these new code blocks don't show up when I try to view the file in rendered mode.
maybe we need to specify bash instead of shell ?
I'm not familiar with .rst format actually.
There was a problem hiding this comment.
it was a dead symlink after I moved the gemfiles 39af442
so I deleted it
|
Thank you for this patch |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I had some difficulty getting this project running since there isn't a Gemfile in the project, and I didn't see any contributing instructions. This PR adds some simple instructions for getting the test suite running to the Readme.
I do wonder why the Gemfile was removed and if the proper solution would be to add it back to the project.