@noobsociety/nsds 0.2.0 → 0.2.1

package/CHANGELOG.md

@@ -2,14 +2,35 @@
 
 All notable changes to NSDS are documented here.
 
-## 0.2.0 - 2026-06-20
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.2.1] - 2026-06-20
+
+### Added
+
+- Project README structure for install, usage, package exports, development, release, and license guidance.
+- Changesets configuration and release scripts for version intent and publishing.
+- Storybook configuration and component stories for the public React package surface.
+- Release workflow for Changesets version pull requests and npm publishing.
+
+### Changed
+
+- Contribution guidance now documents SemVer, changelog, release, component documentation, and license expectations.
+- Public documentation now describes only the package source and published package surface.
+
+### Removed
+
+- Design-source and prototype artifacts from the public repository tree.
+
+## [0.2.0] - 2026-06-20
 
 ### Added
 
 - Tailwind preset export for mapping `--ns-*` design tokens into utility classes.
 - HUD token file and HUD React primitives for game-layer UI.
-- RPG icon React component and icon reference card.
-- Lab homepage and game HUD reference surfaces for internal design work.
+- RPG icon React component and icon catalog support.
 
 ### Changed
 
@@ -24,7 +45,7 @@ All notable changes to NSDS are documented here.
 - Duplicate compiled component runtime source files.
 - Superseded `ui-kits/` homepage path.
 
-## 0.1.2 - 2026-06-18
+## [0.1.2] - 2026-06-18
 
 ### Added
 
@@ -35,22 +56,29 @@ All notable changes to NSDS are documented here.
 - React smoke tests for the public component entry points.
 - TypeScript smoke validation for consumer-facing package imports.
 - Tailwind preset export for token-mapped utility classes.
-- Prioritized README roadmap and reference standards for documentation, changelog, versioning, release, and component documentation workflows.
+- Prioritized README roadmap and documentation, changelog, versioning, release, and component documentation workflows.
 
 ### Changed
 
 - Updated README language for the public npm package and repository.
 - Documented the TypeScript and testing roadmap.
 
-## 0.1.1 - 2026-06-18
+## [0.1.1] - 2026-06-18
 
 ### Changed
 
 - Published the package as `@noobsociety/nsds`.
 - Updated repository metadata for the public NSDS package.
 
-## 0.1.0 - 2026-06-18
+## [0.1.0] - 2026-06-18
 
 ### Added
 
-- Initial NSDS package with tokens, CSS primitives, React components, assets, guidelines, references, and UI kits.
+- Initial NSDS package with tokens, CSS primitives, React components, and Tailwind support.
+
+[Unreleased]: https://github.com/noobsociety/nsds/compare/v0.2.1...HEAD
+[0.2.1]: https://github.com/noobsociety/nsds/compare/v0.2.0...v0.2.1
+[0.2.0]: https://github.com/noobsociety/nsds/compare/v0.1.2...v0.2.0
+[0.1.2]: https://github.com/noobsociety/nsds/compare/v0.1.1...v0.1.2
+[0.1.1]: https://github.com/noobsociety/nsds/compare/v0.1.0...v0.1.1
+[0.1.0]: https://github.com/noobsociety/nsds/releases/tag/v0.1.0

package/CONTRIBUTING.md

@@ -1,34 +1,113 @@
 # Contributing
 
-NSDS is the NoobSociety Design System. Changes should keep the package small, reusable, and direct.
+NSDS is the NoobSociety Design System. Changes should keep the package small, reusable, direct, and Tailwind-first.
 
-## Local Setup
+## Local setup
+
+Use Node.js 22 or newer.
 
 ```bash
 npm install
 npm run check
 ```
 
-## Change Guidelines
+Run Storybook while changing components:
+
+```bash
+npm run storybook
+```
+
+## Change guidelines
 
 - Keep package exports stable unless the release is intentionally breaking.
 - Prefer CSS tokens and shared primitives over one-off styles.
 - Keep React components small and framework-light.
-- Add or update smoke coverage when changing component behavior.
-- Use patch versions for metadata, docs, small fixes, and compatibility work.
-- Use minor versions for new components, tokens, or larger additive behavior.
+- Add or update Storybook stories when changing public component behavior or props.
+- Add or update smoke coverage when changing import behavior, package exports, or runtime behavior.
+- Keep third-party code and assets license-compatible with MIT.
+
+## Versioning
+
+NSDS follows [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+- Patch versions are for docs, metadata, dependency compatibility, bug fixes, and non-breaking visual corrections.
+- Minor versions are for new components, tokens, exports, or additive behavior.
+- Major versions are for breaking public API changes, removed exports, incompatible CSS token changes, or required consumer migration.
+
+The package is still pre-1.0, but release intent should still be explicit. If a `0.x` minor release contains a breaking package-boundary change, document the migration clearly in the changelog.
+
+## Changelog
+
+`CHANGELOG.md` follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
-## Release Checks
+Use these categories when applicable:
 
-Before publishing:
+- `Added`
+- `Changed`
+- `Deprecated`
+- `Removed`
+- `Fixed`
+- `Security`
+
+Keep user-facing changes in the changelog. Internal maintenance can stay in the pull request when it has no package or contributor impact.
+
+Add unreleased package notes under `## [Unreleased]`. During release, `npm run changeset:version` moves those notes into a dated version section and updates the compare links.
+
+## Changesets
+
+Every package-impacting pull request should include a changeset:
+
+```bash
+npm run changeset
+```
+
+Choose the SemVer bump that matches the public impact. Documentation-only changes may skip a changeset when they do not affect the published package behavior.
+
+Maintainers prepare release commits with:
+
+```bash
+npm run changeset:version
+```
+
+This command applies the Changesets version plan and updates `CHANGELOG.md` from the `[Unreleased]` section. Open the result as a release pull request.
+
+Publishing is handled by the release workflow after the release pull request is merged to `main`, when `NPM_TOKEN` is configured:
+
+```bash
+npm run changeset:publish
+```
+
+## Component documentation
+
+Public React components must have Storybook coverage.
+
+```bash
+npm run storybook
+npm run build:storybook
+```
+
+Stories should show the stable public props, common variants, disabled or edge states when relevant, and realistic token-backed styling. Avoid documenting private implementation details as API.
+
+## Release checks
+
+Before merging a package-impacting change:
 
 ```bash
 npm run check
+npm run build:storybook
 npm run release:dry-run
 ```
 
-Publish with an npm one-time password when required:
+Before publishing manually:
 
 ```bash
-npm publish --otp=123456
+npm run check
+npm run release:dry-run
+npm run changeset:publish
 ```
+
+## License guidance
+
+NSDS uses the [MIT License](./LICENSE), selected from [Choose a License](https://choosealicense.com/licenses/mit/).
+
+New code, images, fonts, and documentation must be original, owned by NoobSociety, or compatible with MIT redistribution. When adding third-party material, document its source and license in the pull request.