Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 932 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 932 Bytes

Contributing to react-loading-skeleton

Contributions are welcome.

Development

  1. yarn install
  2. yarn setup — setup precommit hook
  3. Check for type errors: yarn tsc
  4. Run Rollup: yarn build
  5. Run tests: yarn test
  6. Run ESLint: yarn lint
  7. Run Storybook: yarn storybook

Publishing

  1. Make sure that the CI workflow succeeded.
  2. Increment version in package.json.
  3. (If production release) Add a git tag in the format v1.0.0.
  4. Commit and push. Remember to push tags as well with git push --tags.
  5. yarn npm publish or yarn npm publish --tag next. The prepack script will automatically do a clean and build.
  6. (If production release) Create a new release in GitHub.

Test Projects Repository

There are some test projects that use react-loading-skeleton in the react-loading-skeleton-test-projects repository.