0.0.354 • Published 1 year ago

great-white-shark-cf-ui v0.0.354

Weekly downloads
-
License
MIT
Repository
-
Last release
1 year ago

Great White Shark CF UI

To get this package, make sure you turn on bhinneka vpn

Install tunggal & great white shark cf ui complete with peer dependency, if you are using npm:

npm install tunggal great-white-shark-cf-ui --registry http://verdaccio.bhinnekalocal.com

or yarn:

yarn add tunggal great-white-shark-cf-ui --registry http://verdaccio.bhinnekalocal.com

Requirement

Peer Dependencies: react, react-dom, @emotion/core, @emotion/styled
Nodejs: v11.10.1
NPM: 6.7.0
Yarn: 1.17.3

Install Dependencies

yarn install

Run Tests

yarn test

Run Coverage Tests (Make sure its keep in >90):

yarn test --coverage

How to Contribute

The following is a set of guidelines for contributing to Great White Shark CF UI. Please spend several minutes reading these guidelines before you create an issue or pull request.

Sending a Pull Request

The core team is monitoring for pull requests. We will review your pull request and either merge it, request changes to it, or close it with an explanation.

Before submitting a pull request, please make sure the following is done:

  1. Fork the repository and create your branch from master.
  2. Make sure you using our vscode workspace to enable our basic config for editor and please install our recommended extensions.
  3. Run yarn install or just yarn in the repository root.
  4. If you've fixed a bug or added code that should be tested, add tests!
  5. Ensure the test suite passes (npm run test). Tip: yarn test TestName is helpful in development.
  6. Run yarn test -u to update the jest snapshots and commit these changes as well (if there are any updates).

Sending a Pull Request to Great White Shark CF UI Repository with commit message format [gws-cf-ui] commit message.

Development Workflow

After cloning Tunggal, run yarn install or just yarn to fetch its dependencies. Then, you can run several commands:

  1. yarn start runs Great White Shark CF UI Storybook website locally.
  2. yarn test runs the complete test suite.
  3. yarn test-reset remove all snapshot (if needed).
  4. yarn build to build Great White Shark CF UI to be a package.
  5. yarn build-storybook to build Great White Shark CF UI Storybook for production.
  6. yarn build-publish to build and publish Great White Shark CF UI to Bhinneka Verdaccio (Internal NPM registry)
  7. yarn scan to run scan for sonarcube (sonarcube installed needed)

Copyright Notice

Copyright © 2020 PT Bhinneka Mentari Dimensi

NOTICE:

All Information contained herein is, and remains the property of PT Bhinneka Mentari Dimensi and its suppliers, if any. The intellectual and technical concepts contained herein are proprietary to PT Bhinneka Mentari Dimensi and its suppliers and maybe covered by Republic of Indonesia and Foreign Patents, patents in process, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from PT Bhinneka Mentari Dimensi