@biohub/scatterplot 0.1.5 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +44 -0
- package/package.json +7 -2
package/README.md
CHANGED
|
@@ -492,6 +492,50 @@ npm run build # Build production bundle
|
|
|
492
492
|
npm run preview # Serve at http://localhost:4173
|
|
493
493
|
```
|
|
494
494
|
|
|
495
|
+
## Contributing
|
|
496
|
+
|
|
497
|
+
This project uses [Conventional Commits](https://www.conventionalcommits.org/) and [semantic-release](https://semantic-release.gitbook.io/) for automated versioning.
|
|
498
|
+
|
|
499
|
+
### Commit Format
|
|
500
|
+
|
|
501
|
+
```
|
|
502
|
+
type(scope): description
|
|
503
|
+
```
|
|
504
|
+
|
|
505
|
+
| Type | Description | Release |
|
|
506
|
+
|------|-------------|---------|
|
|
507
|
+
| `feat` | New feature | Minor (0.1.0 → 0.2.0) |
|
|
508
|
+
| `fix` | Bug fix | Patch (0.1.0 → 0.1.1) |
|
|
509
|
+
| `docs` | Documentation only | No release |
|
|
510
|
+
| `style` | Code style (formatting) | No release |
|
|
511
|
+
| `refactor` | Code refactoring | No release |
|
|
512
|
+
| `perf` | Performance improvement | Patch |
|
|
513
|
+
| `test` | Adding tests | No release |
|
|
514
|
+
| `chore` | Maintenance tasks | No release |
|
|
515
|
+
|
|
516
|
+
**Breaking changes:** Add `!` after type or include `BREAKING CHANGE:` in footer for major release (0.1.0 → 1.0.0).
|
|
517
|
+
|
|
518
|
+
```bash
|
|
519
|
+
feat!: redesign API
|
|
520
|
+
# or
|
|
521
|
+
feat: redesign API
|
|
522
|
+
|
|
523
|
+
BREAKING CHANGE: The `data` prop now requires typed arrays instead of Point[].
|
|
524
|
+
```
|
|
525
|
+
|
|
526
|
+
### Release Flow
|
|
527
|
+
|
|
528
|
+
This project uses [release-please](https://github.com/googleapis/release-please) for automated releases.
|
|
529
|
+
|
|
530
|
+
1. Merge PR to `main` with conventional commits
|
|
531
|
+
2. release-please automatically creates/updates a "Release PR" with:
|
|
532
|
+
- Updated `package.json` version
|
|
533
|
+
- Updated `CHANGELOG.md`
|
|
534
|
+
3. When ready to release, merge the Release PR
|
|
535
|
+
4. Merging triggers:
|
|
536
|
+
- GitHub Release creation
|
|
537
|
+
- npm publish with quality checks
|
|
538
|
+
|
|
495
539
|
## License
|
|
496
540
|
|
|
497
541
|
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@biohub/scatterplot",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "High-performance WebGL scatterplot component for React with pan/zoom and lasso selection",
|
|
6
6
|
"main": "./dist/scatterplot.umd.js",
|
|
@@ -42,7 +42,10 @@
|
|
|
42
42
|
],
|
|
43
43
|
"lint-staged": {
|
|
44
44
|
"*.{ts,tsx}": [
|
|
45
|
-
"
|
|
45
|
+
"biome check --write"
|
|
46
|
+
],
|
|
47
|
+
"*.json": [
|
|
48
|
+
"biome format --write"
|
|
46
49
|
]
|
|
47
50
|
},
|
|
48
51
|
"peerDependencies": {
|
|
@@ -51,6 +54,8 @@
|
|
|
51
54
|
},
|
|
52
55
|
"devDependencies": {
|
|
53
56
|
"@biomejs/biome": "^2.3.11",
|
|
57
|
+
"@commitlint/cli": "^20.4.1",
|
|
58
|
+
"@commitlint/config-conventional": "^20.4.1",
|
|
54
59
|
"@size-limit/preset-small-lib": "^12.0.0",
|
|
55
60
|
"@testing-library/react": "^16.3.0",
|
|
56
61
|
"@types/react": "^19.1.10",
|