Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
hyoban committed Apr 12, 2024
1 parent 39f4cde commit ffc1e44
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ Run [release-it](https://github.com/release-it/release-it) with [pnpm](https://p

## Requirements

- [ ] use pnpm and set [packageManager](https://nodejs.org/api/packages.html#packagemanager) in `package.json` correctly. (So that GitHub Action can set up pnpm correctly)
- [ ] use [Conventional Commits](https://www.conventionalcommits.org) and follow [Semantic Versioning](https://semver.org). (So that it can provide recommended version in CI)
- [ ] prefer to add a `v` prefix to the tag name (e.g. `v1.2.3`). (So that it can handle pre-release GitHub release changelog correctly)
<details><summary>Use pnpm and set [packageManager](https://nodejs.org/api/packages.html#packagemanager) in `package.json` correctly.</summary>So that GitHub Action can set up pnpm correctly. You can manually select the pnpm version in the GitHub Action workflow file.</details>

<details><summary>Use [Conventional Commits](https://www.conventionalcommits.org) and follow [Semantic Versioning](https://semver.org).</summary>So that it can provide recommended version in CI. It's OK to not follow this rule if you manually decide the next version and disable GitHub release.</details>

<details><summary>Prefer to add a `v` prefix to the tag name (e.g. `v1.2.3`).</summary>So that it can handle pre-release GitHub release changelog correctly. It's OK to not follow this rule if you do not care about pre-release GitHub release changelog.</details>

## What it does

Expand Down

0 comments on commit ffc1e44

Please sign in to comment.