Update template docs: remove dated Jest info, improve consistency between all 3, add GitHub Actions docs #706
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
- these have not had much attention compared to the main repo README
- and I actually forgot they existed for a bit
- Jest isn't run in watch mode by default and doesn't run tests related
to files changed since last commit by default either
- I'm not sure if the latter was ever a thing but the former was only
a thing temporarily
- don't want to have multiple references to versions that need to be
updated along with package.json changes
- these are for the most part wrapped by TSDX, so would only need to
know a version in an advanced use-case, where having to check the
package.json is not unreasonable
- we also try to keep up with latest, so if it's bleeding edge or not
shouldn't be impactful for too long
- e.g. will be upgrading to Rollup v2 soon enough, no one's even
requested it, so no need to add changing version in a few places
to maintenance burden
- also easy to forget to update and then have outdated/incorrect
docs
- same jive with permalink to PR -- if it's not already outdated, it's
likely to become outdated often
- reference Parcel's aliasing docs instead of PR that adds it
- basically `diff templates/react/README.md templates/react-with-storybook/README.md`
should only show the Storybook differences
- make code block annotation are consistent
- one had bash and shell and the other didn't
- also use txt instead of shell for file structure
- file structure isn't a shell command
- make `np` link consistent
- the React w/ Storybook README should say its with Storybook, not just
for plain React to be explicit
- these directions already exist in the "Commands" section, so no need to duplicate them - also consistently call it "example plaground" - and fix order and grammar in Storybook "Commands" section that references both
- welp, this never got updated when Actions were added
- those are far more detailed about various pieces than the basic one - basically just remove the React-specific pieces of the React one - substitute some references with non-React ones where applicable - also be more explicit about library use-case in each README
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.
These haven't gotten any attention in a while and I forgot they existed for a bit (I don't use
createmyself). Bring them up to speed:testscript doesn't run Jest in interactive mode #536