diff --git a/superset-frontend/temporary_superset_ui/superset-ui-plugins-deckgl/README.md b/superset-frontend/temporary_superset_ui/superset-ui-plugins-deckgl/README.md index 46c20014f8..e8f52c5ce7 100644 --- a/superset-frontend/temporary_superset_ui/superset-ui-plugins-deckgl/README.md +++ b/superset-frontend/temporary_superset_ui/superset-ui-plugins-deckgl/README.md @@ -18,60 +18,10 @@ Current master: https://superset-ui-plugins-deckgl.netlify.com |--|--| | [@superset-ui/legacy-preset-chart-deckgl](https://github.com/apache-superset/superset-ui-plugins-deckgl/tree/master/packages/superset-ui-legacy-preset-chart-deckgl) | [![Version](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-deckgl.svg?style=flat-square)](https://img.shields.io/npm/v/@superset-ui/legacy-preset-chart-deckgl.svg?style=flat-square) | -### Development +## Contribution and development guide -[lerna](https://github.com/lerna/lerna/) and [yarn](https://yarnpkg.com) are used to manage versions and dependencies between -packages in this monorepo. - -``` -superset-ui/ - lerna.json - package.json - ... - packages/ - package1/ - package.json - ... - src/ - test/ - ... - lib/ - esm/ - ... - ... -``` - - - -### Installation - -1. clone this repo -2. have yarn install package dependencies and manage the symlinking between packages for you - -```sh -git clone ...superset-ui-plugins-deckgl && cd superset-ui-plugins-deckgl -yarn install -yarn build -``` - -### Builds, linting, and testing - -Each package defines its own build config, linting, and testing. You can have lerna run commands -across all packages using the syntax `yarn run test` (or `yarn run test:watch` for watch mode) from the root `@superset-ui-plugins-deckgl` directory. - -* [Using Storybook](https://github.com/apache-superset/superset-ui/blob/master/docs/storybook.md) - You can test your components independently from Superset app. -* [Debugging Superset plugins in Superset app](https://github.com/apache-superset/superset-ui/blob/master/docs/debugging.md) - Sometimes something went wrong and you have to do it. - -### Committing - -This repository follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) guideline for commit messages and has a `commitlint` hook which will require you to have the valid commit message before committing. You can use `npm run commit` to help you create a commit message. - -### Publishing - -**Prerequisite:** You'll need an [npmjs.com](https://npmjs.com) account that is part of the `@superset-ui` organization. - -1. Make sure you're logged in to NPM from your shell. Run `npm login` if necessary. -2. To make the release, run `yarn run release` and follow the prompts. +Please read the [contributing guidelines](https://github.com/apache-superset/superset-ui/blob/master/CONTRIBUTING.md) which include development environment setup +and other things you should know about coding in this repo. ### License