Skip to content

Commit 484bc74

Browse files
committed
chore: update README
1 parent ea63894 commit 484bc74

1 file changed

Lines changed: 2 additions & 26 deletions

File tree

README.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,9 @@ pnpm install
99
pnpm dev
1010
```
1111

12-
## Commit Conventions
12+
## Contributing
1313

14-
This repo enforces [Conventional Commits](https://www.conventionalcommits.org/) via a git hook. Every commit message must follow:
15-
16-
```
17-
type(scope): description
18-
```
19-
20-
Allowed types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`.
21-
22-
## Formatting
23-
24-
Prettier runs automatically on staged files before each commit via `simple-git-hooks` and `pretty-quick`. No manual formatting step needed.
25-
26-
To format the entire project manually:
27-
28-
```bash
29-
pnpm format
30-
```
31-
32-
## Releases
33-
34-
Production releases are fully automated with [release-please](https://github.com/googleapis/release-please). On every push to `main`, release-please opens (or updates) a release PR that bumps the version and generates a changelog. Merging that PR triggers a build and publishes to npm with provenance.
35-
36-
## Preview Releases
37-
38-
Every pull request automatically publishes a preview package via [pkg-pr-new](https://github.com/nicolo-ribaudo/pkg-pr-new). An install link is posted as a PR comment so you can test changes before merging.
14+
See [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow, commit conventions, and release process.
3915

4016
## License
4117

0 commit comments

Comments
 (0)