Skip to content
This repository was archived by the owner on Feb 7, 2024. It is now read-only.

Commit b0fe043

Browse files
committed
Add CONTRIBUTING.md
1 parent 2b55759 commit b0fe043

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

CONTRIBUTING.md

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Thanks for contributing!
2+
3+
## Development
4+
5+
### Installing dependencies
6+
7+
```bash
8+
npm install
9+
```
10+
11+
### Demo
12+
13+
You can run the demo locally by simply doing `npm start`; this will start the demo at `http://localhost:3000`.
14+
15+
### Linting
16+
17+
Before commiting any changes, be sure to do `npm run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make. You can also run `npm run lint-fix` to fix most common lint errors automatically.
18+
19+
## Releasing a new version to NPM (only for project administrators):
20+
21+
1. Run `npm version patch` (or `minor`, `major` as appropriate) to lint and build the `lib` and `umd` directories.
22+
2. Run `npm publish` and publish to NPM if all is well.
23+
3. Run `git push && git push --tags`

0 commit comments

Comments
 (0)