-
Notifications
You must be signed in to change notification settings - Fork 0
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
Development Scripts & Docs #19
Merged
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
justwiebe
reviewed
Apr 4, 2024
justwiebe
reviewed
Apr 4, 2024
justwiebe
approved these changes
Apr 4, 2024
README.md
Outdated
Comment on lines
248
to
250
After cloning the repository, you'll need to install dependencies by running `yarn install`. | ||
|
||
Next, run `yarn setup` to setup the dummy Rails 7 app located inside the test directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this mention rake install
?
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.
This PR adds a few scripts & Rake tasks to aid local development & environment setup. It also adds documentation to the README regarding local development. Lastly, I removed the dummy app's
.node-version
&.ruby-version
artifacts as I don't believe they are necessary, but could add unnecessary friction when trying to setup a local environment. I could be wrong about that and I'm interested to hear if you have a different opinion on that matter.I did not bump the version because this does not impact the NPM package and I don't plan to publish a new tag or create a release.