Skip to content

Commit 767e5ff

Browse files
committed
Add CONTRIBUTING.md
1 parent e9777c1 commit 767e5ff

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to react-loading-skeleton
2+
3+
Contributions are welcome.
4+
5+
## Development
6+
7+
1. `yarn install`
8+
2. `yarn setup` — setup precommit hook
9+
3. Check for type errors: `yarn tsc`
10+
4. Run Rollup: `yarn build`
11+
5. Run tests: `yarn test`
12+
6. Run ESLint: `yarn lint-all`
13+
14+
## Publishing
15+
16+
1. Make sure that the CI workflow succeeded.
17+
2. Increment version in `package.json`.
18+
3. (If production release) Add a git tag in the format `v1.0.0`.
19+
4. Commit and push. Remember to push tags as well with `git push --tags`.
20+
5. `yarn npm publish` or `yarn npm publish --tag next`. The `prepack` script will automatically do a clean and build.
21+
6. (If production release) Create a new release in GitHub.
22+
23+
## Test Projects Repository
24+
25+
There are some test projects that use `react-loading-skeleton` in the
26+
[react-loading-skeleton-test-projects](https://github.com/srmagura/react-loading-skeleton-test-projects)
27+
repository.

0 commit comments

Comments
 (0)