Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .github/workflows/create-release-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ on:
required: false
default: ""

permissions:
contents: read
pull-requests: write

jobs:
create-release-pr:
runs-on: ubuntu-latest
Expand Down
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,25 @@ This project uses [Conventional Commits](https://www.conventionalcommits.org/).

Commits are enforced via commitlint + husky.

## Git Workflow

```
feature branch → PR to dev → merge to dev
(when ready to release)
dev → PR to main → merge to main
semantic-release runs
(version bump + npm publish)
```

### Branch Strategy

- **`main`** - Production branch. Merges trigger releases.
- **`dev`** - Development branch. All feature PRs target this branch.
- **Feature branches** - Create from `dev`, name like `feat/my-feature` or `fix/my-fix`.

## Pull Request Process

1. Fork the repo and create your branch from `dev`
Expand All @@ -44,6 +63,13 @@ Commits are enforced via commitlint + husky.
4. Submit a PR to `dev` branch
5. PRs are squash-merged to keep history clean

### Creating a Release

Maintainers can trigger a release by:
1. Go to **Actions** → **Create Release PR**
2. Click **Run workflow**
3. Merge the generated PR from `dev` → `main`

## Code Style

- TypeScript with strict mode
Expand Down