From 8cd60f8b60dc5e7d6c21e918e474dd6a43ca119e Mon Sep 17 00:00:00 2001
From: Jon Langevin <codingsloth@pm.me>
Date: Tue, 19 May 2026 14:34:50 -0400
Subject: [PATCH] docs(editor): add README + CHANGELOG + CONTRIBUTING (QoL
 sweep follow-up)

workflow-editor lacked all three. Closes workflow-editor#13.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---
 CHANGELOG.md    | 14 +++++++++++++
 CONTRIBUTING.md | 28 +++++++++++++++++++++++++
 README.md       | 55 +++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 97 insertions(+)
 create mode 100644 CHANGELOG.md
 create mode 100644 CONTRIBUTING.md
 create mode 100644 README.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
new file mode 100644
index 0000000..df768c1
--- /dev/null
+++ b/CHANGELOG.md
@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+- Initial README + CHANGELOG + CONTRIBUTING (QoL sweep follow-up).
+
+## [0.60.3]
+
+Initial CHANGELOG entry tracking the current release. See git tags for prior versions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..c529b10
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,28 @@
+# Contributing to workflow-editor
+
+This project is part of the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) ecosystem.
+
+## Before contributing
+
+Read the [upstream CONTRIBUTING.md](https://github.com/GoCodeAlone/workflow/blob/main/CONTRIBUTING.md) for general conventions, signing, and review expectations.
+
+## Local development
+
+```sh
+git clone https://github.com/GoCodeAlone/workflow-editor.git
+cd workflow-editor
+npm install
+npm run dev
+npm test
+```
+
+## Pull requests
+
+- One feature or bugfix per PR.
+- Update CHANGELOG.md with a Keep-a-Changelog entry.
+- Add vitest tests for new components or store logic.
+- Add Playwright E2E tests where appropriate.
+
+## Reporting issues
+
+See the issue templates under `.github/ISSUE_TEMPLATE/`.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..602e23f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,55 @@
+# workflow-editor
+
+> 🎨 Visual editor for the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) engine.
+
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
+[![npm](https://img.shields.io/npm/v/@gocodealone/workflow-editor.svg)](https://github.com/orgs/GoCodeAlone/packages?repo_name=workflow-editor)
+
+Standalone npm package providing a visual workflow editor: 14 node types, 9 edge types, a ReactFlow canvas, property panel, node palette, toolbar, serialization, and auto-layout. Used by `workflow-vscode`, `workflow-jetbrains`, and embeddable in any TypeScript/React host.
+
+## What it provides
+
+- **WorkflowCanvas** — ReactFlow-based visual canvas
+- **PropertyPanel** — type-specific node configuration
+- **NodePalette** — drag-and-drop palette across all 90+ module types
+- **Toolbar** — load, save, validate, deploy
+- **Serialization** — YAML ↔ graph round-trip
+- **autoLayout** — automatic graph layout
+- **Zustand stores** — `loadSchemas()` / `loadPluginSchemas()` for host injection
+
+## Install
+
+```sh
+npm install @gocodealone/workflow-editor
+```
+
+```ts
+import { WorkflowCanvas, useWorkflowStore } from '@gocodealone/workflow-editor';
+```
+
+## Local development
+
+```sh
+git clone https://github.com/GoCodeAlone/workflow-editor.git
+cd workflow-editor
+npm install
+npm run dev
+npm test
+```
+
+Build: `npm run build` (Vite library mode).
+
+## Documentation
+
+- [workflow engine upstream](https://github.com/GoCodeAlone/workflow)
+- [Design plan](https://github.com/GoCodeAlone/workflow/blob/main/docs/plans/2026-03-12-workflow-editor-design.md)
+- [Host integrations](https://github.com/GoCodeAlone/workflow-vscode), [JetBrains](https://github.com/GoCodeAlone/workflow-jetbrains)
+
+## CI
+
+- `publish.yml` — tag → build → publish → dispatch editor-release
+- `sync-schema.yml` — workflow-release → update types
+
+## License
+
+MIT. See [LICENSE](LICENSE).