@royaloperahouse/chord 0.2.6-a → 0.3.3-RD-7154-font-setup-changes

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# CHANGELOG
+
+## [0.3.3 - BEING PREPARED]
+-   Added AnchorTapBar Component
+-   Added Accordion Component
+-   Added Card Component
+
+## [0.3.0]
+-   Design system project renamed and moved to chord
+
+## [0.2.0]
+-   public NPM Library 
+
+## [0.1.0]
+-   Initial version

package/README.md

@@ -1,68 +1,99 @@
-# Royal Opera House - chord 
+# Royal Opera House - Front End Design System
 
-Welcome to the Royal Opera House library components  `@royaloperahouse/chord`.
+Welcome to the Royal Opera House Front End Design System, `@royaloperahouse/chord`.
 
 This package is a library of UI components intended to be used in the ROH website.
 
+It uses React, TypeScript, TSDX and Storybook.
 
-## Install
+## 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
-    npm i --save @royaloperahouse/chord
+yarn lint # you can also use the --fix option to perform automatic fixes
 ```
+
+To run the unit tests (using Jest) use:
+
 ```bash
-    yarn add @royaloperahouse/chord
+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
 ```
 
-## Usage
+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).
 
-```javascript
-import {
-  Footer, GlobalStyles, ThemeProvider, ThemeType,
-} from '@royaloperahouse/chord';
+To build the package use:
 
+```bash
+yarn build
 ```
-## Sample
-
-```javascript
-
-import {
-  Footer, GlobalStyles, ThemeProvider, ThemeType,
-} from '@royaloperahouse/chord';
-
-
-const App = ({ children }: InnerProps): React.ReactElement => (
-  <ErrorBoundary>
-    <ThemeProvider theme={ThemeType.Core}>
-      <GlobalStyles />
-      <Wrapper>
-        <Header />
-        <GlobalStyle />
-        <HealthBanner />
-        <ErrorBoundary>
-          <Content>
-            {children}
-          </Content>
-        </ErrorBoundary>
-        <LiveChat />
-      </Wrapper>
-      <Footer data={footerData} />
-    </ThemeProvider>
-  </ErrorBoundary>
-);
 
+To release a new version.
+
+Release will be published in npm (NPM_TOKEN will be required)
+Storybook will be pushed to bitbucket. *** Push will be done Ensure you don't have things pendint to push
+
+```bash
+ NPM_ROH_TOKEN={NPM_TOKEN} RELEASE_VERSION={RELEASE_VERSION} yarn publish-release
 ```
 
-## Components
 
-Editorial, Footer, GlobalStyles, Grid, GridItem, Heading, Icon, Navigation, PeopleListing, PrimaryButton, PromoWithTitle, SecondaryButton, SectionSplitter, SectionTitle, Sponsorship, TertiaryButton, TextOnly, ThemeProvider, TypeTags
+MORE INFO TO FOLLOW - PARTICULARLY FOR THE CI SETUP AND HOW PACKAGES ARE PUSHED.
+
+# Recommended Use of Package
+
+The package is deployed to NPM, and can be installed using yarn or npm:
+
+```bash
+    npm i --save @royaloperahouse/chord
+```
+```bash
+    yarn add @royaloperahouse/chord
+```
+
+# 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:
 
-## Types
+- _*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.
 
-ThemeType
+### Example
 
+There is an example implementation in the example folder. Alternatively there are also integration examples in storybook. Make sure to keep these updated so as to showcase the current components available.
 
-## Documentation
+### Bundle analysis
 
-See Storybook as a reference
+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`.