Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: add further information to the README around the publishing workflow #303

Merged
merged 1 commit into from
Oct 3, 2024
Merged

fix: add further information to the README around the publishing workflow #303

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion README.md
View file
Open in desktop
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