cetec-design-system 0.0.47-0 → 1.0.0

package/README.md

@@ -6,6 +6,7 @@ A React component library built with TypeScript and Panda CSS for the Cetec-ERP
   - [Development](#development)
     - [Setup](#setup)
     - [Commands](#commands)
+  - [Standards](#standards)
   - [Architecture](#architecture)
     - [Key Principles](#key-principles)
   - [Working with Components](#working-with-components)
@@ -35,19 +36,37 @@ npm install
 # Development
 npm run dev                  # Start Vite dev server with Panda CSS watch mode
 npm run storybook           # Start Storybook on port 6006
+npm run playroom            # Start Playroom on port 9000
 
 # Building
 npm run build               # Build for distribution (runs Panda codegen + Vite build)
 npm run storybook:build     # Build Storybook for deployment
+npm run playroom:build      # Build Playroom for deployment (dist/playroom)
 
 # Code Quality
 npm run lint                # Run ESLint
+npm run lint:fix            # Run ESLint with autofix
+npm run typecheck           # Run TypeScript type checking
+npm run validate            # Run lint + typecheck
+npm run validate:full       # Run validate + production build
+npm run doctor              # Run react-doctor + storybook doctor
 npm run prepare             # Run Panda CSS codegen (runs automatically after npm install)
 
 # Icons
 npm run generate-sprite     # Generate SVG sprite from icon source files
 ```
 
+## Standards
+
+Canonical standards now live in `standards/`:
+
+- `standards/components/` - component API, composition, Floating UI, Storybook conventions
+- `standards/recipes/` - recipe naming/registration and token-only styling
+- `standards/lint/` - baseline lint rules, custom design-system lint rules, rollout workflow
+- `standards/index.yml` - index of all standards documents
+
+If this README and `standards/` ever conflict, treat `standards/` as the source of truth.
+
 ## Architecture
 
 This design system is built on **Panda CSS** with a strict tokens-first approach:
@@ -156,7 +175,12 @@ Packages are published from the repo root with `dist` included in the published
 
 ### Contributing
 
-- **Release Labels**: PRs must have a release label (major, minor, patch, or release) to trigger a release
+- **Workflow trigger**: Every push to `main` runs the release workflow.
+- **Publishing behavior**: A merged change that resolves to a releasable bump publishes a prerelease by default. Add the `release` label to graduate that merge to a stable `latest` release.
+- **Version bump labels**: Use `major`, `minor`, or `patch` to control the semver bump.
+- **Default bump**: If the merged PR has no Auto semver label, Auto defaults the head change to `patch`.
+- **No-release labels**: `internal`, `documentation`, `tests`, and `dependencies` do not publish on their own.
+- **Skip label**: Use `skip-release` to prevent publishing.
 - **Changelog**: Auto-generated based on PR labels and titles
 - **PR Titles**: Must follow our defined format for Auto release automation:
 
@@ -197,12 +221,23 @@ Packages are published from the repo root with `dist` included in the published
 
 ### Release Labels
 
-- `major` - Breaking changes (💥 Breaking Change)
-- `minor` - New features (🚀 Enhancement)
-- `patch` - Bug fixes (🐛 Bug Fix)
-- `skip-release` - No version bump
-- `internal` - Internal changes (🏠 Internal)
-- `documentation` - Documentation updates (📝 Documentation)
+- `major` - Major version bump (💥 Breaking Change)
+- `minor` - Minor version bump (🚀 Enhancement)
+- `patch` - Patch version bump (🐛 Bug Fix)
+- `release` - Graduate the publish from prerelease to stable `latest`
+- `skip-release` - Do not publish a release
+- `internal` - Internal changes only (🏠 Internal)
+- `documentation` - Documentation updates only (📝 Documentation)
+- `tests` - Test-only changes (🧪 Tests)
+- `dependencies` - Dependency updates only (🔩 Dependency Updates)
 - `performance` - Performance improvements (🏎 Performance)
 
+Examples:
+
+- `minor` => prerelease minor
+- `minor` + `release` => stable minor release
+- no Auto semver label => prerelease patch
+- `documentation` only => no publish
+- `skip-release` => no publish
+
 See `.autorc` for the complete configuration.