@royaloperahouse/chord 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 horacio.ayestaran
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,82 @@
+# Royal Opera House - Front End Design System
+
+Welcome to the Royal Opera House Front End Design System, `@roh-frontend/design-system`.
+
+This package is a library of UI components intended to be used in the ROH website.
+
+It uses React, TypeScript, TSDX and Storybook.
+
+## Commands
+
+The required package dependencies need to be insalled using `yarn`. Once ready you can issue the following:
+
+To run Lint on the package use:
+
+```bash
+yarn lint # you can also use the --fix option to perform automatic fixes
+```
+
+To run the unit tests (using Jest) use:
+
+```bash
+yarn test # you can also use the -u option to update snapshots if needed
+```
+
+To run the unit tests (using Jest) and store them for display in storybook use:
+
+```bash
+yarn test-storybook # you can also use the -u option to update snapshots if needed
+```
+
+To run storybook use:
+
+```bash
+yarn storybook
+```
+
+To build a static version of storybook use:
+
+```bash
+yarn build-storybook
+```
+
+This will create a static copy in `./storybook-static`, and there is an index.html page inside the core directory. This allows the site to be previewed directly in the git repository via serving pages (it needs to be configured for that branch).
+
+To build the package use:
+
+```bash
+yarn build
+```
+
+MORE INFO TO FOLLOW - PARTICULARLY FOR THE CI SETUP AND HOW PACKAGES ARE PUSHED.
+
+# Recommended Use of Package
+
+`TODO`
+
+# Processes to follow prior to commits
+
+Before a commit is made you need to do the following:
+
+- Make sure that you are in your own work branch (properly named, including the JIRA ticket number and a short description)
+- `yarn lint` - ensure that you are not introducing errors
+- `yarn test` - ensure that tests are running as expected
+- `yarn test-storybook` - Save the test results to for the static site
+- `yarn build-storybook` - Update the static site
+- Commit your changes in your branch locally
+
+Next, if you are ready to merge into the main development branch then:
+
+- _*ensure that you pull the latest changes from that branch into your new branch, resolving any merge conflicts that may arise*_
+- Commit any merge changes locally
+- Push your branch changes to the origin repo
+- Raise a Pull Request to merge back into the main development branch, AND ensure that the required reviewers are assigned.
+- The reviewers may raise issues, and once resolved, they will be responsible for performing the merge.
+
+### Example
+
+TODO
+
+### Bundle analysis
+
+Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `yarn size` and visulize it with `yarn analyze`.