feat: add playground #22
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
|
Overall readability score: 19.97/100 (🔴 -0.45)
View detailed metrics🟢 - Shows an increase in readability
Averages:
View metric targets
|
noon-dawg
reviewed
Jun 14, 2023
README.md
Outdated
| @@ -94,6 +94,7 @@ jobs: | |||
| | `build` | build the dist file. You are required to run this locally in order to build the dist before opening a PR. | | |||
| | `run:local:report` | Run the action on two local folders, for testing and development. The first argument is the old ("base branch") folder and the sedcond argument is the new ("head branch") folder. For example `yarn run:local:report ./test-data/old ./test-data/new` | | |||
| | `run:local:debugfile` | Show what the program parses from a single file, after stripping all non-wanted items from the file, and before rating the readability. For example `yarn run:local:debugfile ./test-data/new/test-document.md` | | |||
| | `playground:dev` | Open the playground in local development mode for testing readability scores | | |||
There was a problem hiding this comment.
I think the decrease in readability is because this sentence doesn't end with a period
There was a problem hiding this comment.
I added periods to them all and the score didn't change.
There was a problem hiding this comment.
I'm not sure what decreased the score then 😕
There was a problem hiding this comment.
Its a small amount of content so I think the sore can be sway easily by the addition or removal of a few lines.
noon-dawg
previously approved these changes
Jun 14, 2023
noon-dawg
approved these changes
Jun 15, 2023
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 local development playground which shows the various metric scores.
To run, make sure you
yarnand then runyarn playground:devChanges:
glob).