diff --git a/README.md b/README.md index 19692f5..f643b25 100644 --- a/README.md +++ b/README.md @@ -1198,14 +1198,11 @@ If you would like to help develop a suggested feature follow these steps: - Fork this repo - Install dependencies with `$ yarn` -- Auto-build files as you edit with `$ yarn run watch` -- Implement your changes to files in the `src/` directory -- Run the React Story locally with `$ yarn run docs` -- View changes as you edit `docs/src` +- Link `react-table` locally with `$ yarn link` +- Auto-build files as you edit with `$ yarn start` +- Implement your changes and tests to files in the `src/` directory +- In any example directory, link to the local `react-table` with `$ yarn link react-table` +- Follow example directions for running. Usually just `$ yarn && yarn start` +- Document your changes in the root `README.md` +- To stage a commit, run `yarn commit` - Submit PR for review - -#### Package Utilities - -- `$ yarn run watch` Watches files and builds via babel -- `$ yarn run docs` Runs the storybook server -- `$ yarn run test` Runs the test suite diff --git a/package.json b/package.json index 7953f2f..2b25b6e 100644 --- a/package.json +++ b/package.json @@ -18,7 +18,7 @@ "module": "dist/index.es.js", "jsnext:main": "dist/index.es.js", "scripts": { - "commit": "git-cz", + "commit": "git commit", "test": "is-ci 'test:ci' 'test:dev'", "test:dev": "jest --watch", "test:ci": "jest",