Skip to content

Latest commit

 

History

History
67 lines (43 loc) · 3.08 KB

CONTRIBUTING.md

File metadata and controls

67 lines (43 loc) · 3.08 KB
Raw

Contributing

Running the project locally

govuk-frederic is a monorepo using yarn workspaces and lerna.

This is so that components can be published independently and applications can require different versions of a component if a breaking change is introduced in a version of a specific component. We are loosely following the structure that Jest uses.

As such, the build process for development is slightly more involved than an npm install:

  1. Install yarn

  2. Install dependencies, link packages, compile and start storybook:

yarn
yarn build
yarn start

Creating a new component

To create a new component:

  • yarn create-component -- MyNewComponent where MyNewComponent is the name of your new component.

This creates a folder named MyNewComponent in src/components with the component file (index.js), a basic render test (test.js), and a default story (stories.js). You will need to add this to src/stories/index.js to view it in storybook.

Unit testing

Unit testing follows similar patterns as Glamorous with Jest, utilising Jest snapshots, and Enzyme.

To run unit & eslint tests:

yarn test

To run & watch unit tests:

yarn test:unit

Opening a pull request

  • when adding a new component, include a screenshot of the component in the PR
  • when adding new components, try to keep 1 component per PR, unless there are unavoidable interdependencies
  • when fixing a visual issue, include a unit test or snapshot test that proves the issue, and include a screenshot of the component before and after in the PR
  • when fixing a functional issue, include a unit test that proves the issue (fails before PR is merged and succeeds after)

Releasing

In order to prepare a release:

  • ensure you have lerna installed globally (npm i -g lerna)
  • ensure you have hub installed (e.g. brew install hub)
  • run ./scripts/release.sh, you will be asked to choose a semver increment and, if this is the first time running hub, you will be asked for your GitHub credentials
  • you will also be asked for a title and description for the draft release, though this can be left blank and filled in on GitHub later
  • this will open a PR on GitHub and draft a release
  • merge the PR
  • once the PR is merged, open the draft release corresponding to the new version number on GitHub, change the target branch to master, check the title and description and then click Publish release.

When the tag is created, the CI server will automatically release to npm using lerna exec, see: