Halomaple / styleguide

Teleopti styleguide

Teleopti styleguide

Development

1. Fork the main repo https://github.com/Teleopti/styleguide.git to <your_github_username>/styleguide
2. Clone your repo to local git clone https://github.com/<your_github_username>/styleguide.git
3. npm ci or npm install to install dependencies
4. npm start to build and watch
5. npm run devServer to mount styleguide on http://localhost:3000
6. Make your changes with test covered (important!)
7. Copy the generated files to WFM\node_modules\teleopti-styleguide and verfiy the changes on WFM (important!)
8. Submit a pull request from your repo to => Teleopti/styleguide main repo with your improvements.

Sync your repo with latest Teleopti/styleguide

1. git remote add upstream https://github.com/Teleopti/styleguide.git
2. git fetch upstream (please make sure you have commit your local changes before running this)
3. git merge upstream/master
4. git push

Deploy release to npm & github pages

1. Bump suitable semver version in package.json
   • Preferably submit and merge a pull request with the version change
2. Tag the commit
   • Tag with v1.5.0 if the version is 1.5.0
3. Push the tag to master
   • git push origin v1.5.0

If you have any mentionable changes then draft a new GitHub release with the same tag and a list of changes.