From 6a907b556732e94231ec92a75568dd879c07f2b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Ledentu?= Date: Thu, 14 May 2020 11:33:29 +0200 Subject: [PATCH] docs(readme): add contributing section in README --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 02c892a..38023fb 100644 --- a/README.md +++ b/README.md @@ -72,3 +72,18 @@ var YourComponent = Vue.extend({ ## Changelog See the GitHub [release history](https://github.com/jledentu/vue-finder/releases). + +## Contributing + +Pull requests are welcome! For major changes, please open an issue first to discuss what you would like to change. + +### Development scripts + +- `yarn build` to build the library +- `yarn test` to run the unit tests +- `yarn storybook` to run the [Storybook](https://github.com/storybookjs/storybook) in watch mode +- `yarn docs:dev` to run the [Vuepress](https://github.com/vuejs/vuepress) documentation in watch mode + +## License + +[MIT](https://choosealicense.com/licenses/mit/)