Skip to content

Commit

Permalink
Merge pull request #303 from oaknational/fix/add-publishing-guidance-…
Browse files Browse the repository at this point in the history
…to-readme

fix: add further information to the README around the release and publishing workflow
  • Loading branch information
assadk88 authored Oct 3, 2024
2 parents ed6f9d7 + ad36f0e commit 61278a3
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ For components to be styled correctly they will need access to a theme, some glo
If you're using the Next.js App router your root layout should look something like:

```typescript
// layout.js
// layout.js
import { OakThemeProvider, oakDefaultTheme, OakGlobalStyle } from "@oaknational/oak-components";
import { Lexend } from "next/font/google";

Expand Down Expand Up @@ -61,6 +61,16 @@ We use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) an

Changes should go through a pull-request to `main` and require approval by at least 1 reviewer. You should seek reviews from a QA/designer/PM when necessary.

The release process is driven by the commit messages, following the [Conventional Commits standard](https://www.conventionalcommits.org/en/v1.0.0/#specification). The `@semantic-release/commit-analyzer` plugin will determine the type of release (major, minor, or patch) based on the commit message.

Here’s a summary of the commit types that trigger a release:

* Patch release (x.x.x): Commits that start with `fix:` or contain other conventional keywords indicating bug fixes.
* Minor release (x.x.0): Commits that start with `feat:` indicate a new feature but not a breaking change.
* Major release (x.0.0): Commits that contain `BREAKING CHANGE:` in their description, which indicates a breaking change that requires a major version bump.

Commit messages that begin with `chore`, `refactor` or `docs`, etc. will not trigger the release process.

## Testing components inside a host app like OWA

Sometimes it isn't enough to develop entirely inside Storybook and it might be necessary to try local changes inside a target app. You can do this with [yalc](https://github.com/wclr/yalc)
Expand Down

0 comments on commit 61278a3

Please sign in to comment.