Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@agilgur5
Copy link
Collaborator

@agilgur5 agilgur5 commented May 3, 2020

These haven't gotten any attention in a while and I forgot they existed for a bit (I don't use create myself). Bring them up to speed:

agilgur5 added 6 commits May 3, 2020 01:28
- 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
Copy link
Collaborator Author

@agilgur5 agilgur5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant