Update the README to reflect recent changes and added lint & test instructions #1005
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## staging #1005 +/- ##
========================================
Coverage 75.17% 75.17%
========================================
Files 55 55
Lines 1116 1116
========================================
Hits 839 839
Misses 277 277 ☔ View full report in Codecov by Sentry. |
DrumsnChocolate
approved these changes
Jan 19, 2025
|
|
||
| ## Installation | ||
|
|
||
| 1. Clone this repository | ||
| 1. Run the following commands: | ||
| 1. `bundle install` (might take a couple of minutes) | ||
| 1. `yarn` | ||
| 1. `yarn install` |
There was a problem hiding this comment.
Suggested change
| 1. `yarn install` | |
| 1. `yarn` |
just running yarn works fine for me. Did you run into actual issues or did you just assume the argument was missing here?
There was a problem hiding this comment.
no running yarn and running yarn install do the same thing, https://stackoverflow.com/questions/59265231/what-is-the-difference-between-yarn-and-yarn-install
however I think it is more clear what the command is doing if you write it in full.
Co-authored-by: Matteo Bronkhorst <[email protected]>
Co-authored-by: Matteo Bronkhorst <[email protected]>
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.
if there are any question about why the contents are altered please ask.
I removed the requirement of needing amber-API to log in because this will not be needed in the near future.
fixes #1004 and #910