Skip to content

Commit 0550b05

Browse files
committed
docs: add release process and commit format guidelines to CONTRIBUTING.md
1 parent 57fcff7 commit 0550b05

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,56 @@ Documentation is crucial for our project. You can help by:
125125
- List any breaking changes
126126
- Mention dependencies added/removed
127127

128+
## Release Process
129+
130+
SuperDoc uses automated semantic-release. No manual version bumps needed.
131+
132+
### How It Works
133+
134+
**Branches:**
135+
136+
- `main` → Preview releases (`@next` tag)
137+
- `release/vX.Y` → Stable releases (`@latest` tag)
138+
139+
**Your commits control versions:**
140+
141+
| Commit | Version Change | Example |
142+
| ----------------- | -------------- | ------------------------- |
143+
| `fix:` | Patch (0.0.X) | `fix: resolve cursor bug` |
144+
| `feat:` | Minor (0.X.0) | `feat: add PDF export` |
145+
| `feat!:` | Major (X.0.0) | `feat!: new API format` |
146+
| `docs:`, `chore:` | No change | `docs: update README` |
147+
148+
### Commit Format
149+
150+
Follow [Conventional Commits](https://www.conventionalcommits.org/):
151+
152+
```bash
153+
feat(editor): add table support
154+
fix: resolve memory leak
155+
feat!: change document format
156+
157+
BREAKING CHANGE: New format required
158+
```
159+
160+
### Creating Releases
161+
162+
**Preview (automatic):** Every merge to `main``0.17.0-next.1, next.2...`
163+
164+
**Stable (manual trigger):**
165+
166+
```bash
167+
git checkout -b release/v0.17
168+
git push origin release/v0.17
169+
# Automatically publishes 0.17.0
170+
```
171+
172+
**Hotfix:** Fix directly on release branch → auto publishes patch
173+
174+
### Testing
175+
176+
Run dry-run to preview: `npx semantic-release --dry-run --no-ci`
177+
128178
## Style Guidelines
129179

130180
### JavaScript

0 commit comments

Comments
 (0)