Skip to content

Commit 5b1021b

Browse files
committed
docs: add contributing guide and changelog
1 parent 295e0ed commit 5b1021b

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on Keep a Changelog.
6+
7+
## [0.1.0] - 2026-02-18
8+
9+
### Added
10+
11+
- Initial release of `@fictjs/react`.
12+
- Eager and resumable React island APIs: `reactify`, `ReactIsland`, `reactify$`.
13+
- Static loader API: `installReactIslands`.
14+
- React action bridging APIs: `reactAction$`, `reactActionFromQrl`.
15+
- Vite preset export: `fictReactPreset`.
16+
- CI pipelines for verification, E2E, and npm publish with provenance.

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
Thanks for contributing to `@fictjs/react`.
4+
5+
## Development Setup
6+
7+
1. Use Node.js 20+.
8+
2. Enable Corepack and install dependencies:
9+
- `corepack enable`
10+
- `pnpm install --ignore-workspace --lockfile-dir .`
11+
12+
## Local Validation
13+
14+
Run these before opening a PR:
15+
16+
- `pnpm lint`
17+
- `pnpm typecheck`
18+
- `pnpm test`
19+
- `pnpm test:it`
20+
- `pnpm build`
21+
22+
Optional browser checks:
23+
24+
- `pnpm test:e2e`
25+
26+
## Commit and PR Guidelines
27+
28+
- Keep commits focused and small.
29+
- Use clear commit messages.
30+
- Include tests for behavior changes.
31+
- Update docs when public APIs or workflows change.
32+
33+
## Release Notes
34+
35+
- This package is published from GitHub Actions via `.github/workflows/npm-publish.yml`.
36+
- npm publish uses provenance attestations.

0 commit comments

Comments
 (0)