From 77ed834639c9b7e262a046fd9df5eadf085f2658 Mon Sep 17 00:00:00 2001 From: rhyswfbowles Date: Fri, 9 Oct 2020 01:19:55 +0100 Subject: [PATCH 1/3] fix: Updating CONTRIBUTING guide to include correct script references --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c4e151..3866479 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,6 +33,7 @@ - Make sure `npm test` passes. (see [development setup](#development-setup)) - If adding new feature: + - Add accompanying test case. - Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it. @@ -41,6 +42,7 @@ - Add appropriate test coverage if applicable. ### Work Step Example + - Fork the repository from [nicolasbeauvais/vue-social-sharing](https://github.com/nicolasbeauvais/vue-social-sharing) ! - Create your topic branch from `master`: `git branch my-new-topic origin/master` - Add codes and pass tests ! @@ -59,13 +61,13 @@ After cloning the repo, run: ### Commonly used NPM scripts # watch and serve with hot reload unit test at localhost:8080 - $ npm run dev + $ npm run storybook # lint source codes $ npm run lint # run unit tests in browser (firefox/safari/chrome) - $ npm run test:unit + $ npm run test # build all dist files, including npm packages $ npm run build @@ -73,7 +75,9 @@ After cloning the repo, run: # run the full test suite, include linting $ npm test + # render an example page with all the buttons + $ npm run example + There are some other scripts available in the `scripts` section of the `package.json` file. The default test script will do the following: lint with ESLint -> unit tests with coverage -> e2e tests. **Please make sure to have this pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally beforehand. - From a73d23f2922fd833995f431b81ea749232bc25ce Mon Sep 17 00:00:00 2001 From: rhyswfbowles Date: Fri, 9 Oct 2020 01:34:01 +0100 Subject: [PATCH 2/3] fix: remove duplicated script reference --- CONTRIBUTING.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3866479..3b341ce 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,9 +66,6 @@ After cloning the repo, run: # lint source codes $ npm run lint - # run unit tests in browser (firefox/safari/chrome) - $ npm run test - # build all dist files, including npm packages $ npm run build From bdf644abfb2abc099d6a047b75ea6b4436f8d183 Mon Sep 17 00:00:00 2001 From: Nicolas Beauvais <2951704+nicolasbeauvais@users.noreply.github.com> Date: Sat, 10 Oct 2020 13:35:25 +0200 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3b341ce..b48ab6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,19 +60,19 @@ After cloning the repo, run: ### Commonly used NPM scripts - # watch and serve with hot reload unit test at localhost:8080 + # Run Storybook to experiment with the library $ npm run storybook - # lint source codes + # Lint source codes $ npm run lint - # build all dist files, including npm packages + # Build all dist files, including npm packages $ npm run build - # run the full test suite, include linting - $ npm test + # Run the full test suite, include linting + $ npm run test - # render an example page with all the buttons + # Render an example page with all the buttons $ npm run example There are some other scripts available in the `scripts` section of the `package.json` file.