@smg-automotive/example

To use this template create a new repository and select example-pkg from the template dropdown. Make sure to name your repository following <name>-pkg convention.

Things to do change when you use this repository as a template:

• [ ] replace example-pkg with the name of your package in this README
• [ ] update the @smg-automotive/example with the name of your package in package.json
• [ ] update repository and homepage sections in package.json to point to your GitHub repository
• [ ] ensure that Frontend team has the admin access to the repository
• [ ] ensure that the Bots team has write access to the repository (this is needed to release the package)
• [ ] provide usage examples in the README.md
• [ ] enable the project on circleci.com to build and test your package
• [ ] change the circleci status badge in this README to the new project
• [ ] develop an awesome package
• [ ] live long and prosper

example-pkg

Usage

npm install @smg-automotive/example

Development

npm run build

You can link your local npm package to integrate it with any local project:

cd smg-automotive-example-pkg
npm run build

cd <project directory>
npm link ../smg-automotive-example-pkg

Release a new version

New versions are released on the ci using semantic-release as soon as you merge into master. Please make sure your merge commit message adheres to the corresponding conventions.