VPP Portal Frontend Shared Library
This library contains any components, services or helpers that can be shared amongst the VPP Portal frontend microsites. If you think something should or could be shared please have a discussion with the team and add it to the library. See the Contribution Guide.
Before the VPP team has a dependency resolution platform like Artifactory in place we will use CodeCommit to serve the package.
Usage
Installation
yarn add git+ssh://git-codecommit.ap-southeast-2.amazonaws.com/v1/repos/vpp-portal-frontend-shared-library
If you want a specific version specify the tag like so;
yarn add git+ssh://git-codecommit.ap-southeast-2.amazonaws.com/v1/repos/vpp-portal-frontend-shared-library#v0.0.2
Contribution Guide
When contributing to the shared library try to keep your PR commits squashed to 1 commit message. Write the message in imperative tense. Describe what the commit does to the repository i.e.
adds NavBar component or fixes a build bug - test coverage threshold was set to 200%.
Release process
When changes are merged into master, the build system will look at the package.json file for the version field. It will then attempt to tag the repository with the version and push the tag to the remote.