docs(editor): add README + CHANGELOG + CONTRIBUTING (QoL sweep follow-up)#14
Merged
Conversation
…-up) workflow-editor lacked all three. Closes workflow-editor#13. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Adds baseline OSS-facing documentation for workflow-editor as a follow-up to the QoL sweep (Issue #13), aiming to improve project onboarding and release hygiene.
Changes:
- Added a new
README.mdwith high-level feature overview, install instructions, and local dev commands. - Added
CONTRIBUTING.mdwith contribution and testing expectations. - Added
CHANGELOG.mdfollowing Keep-a-Changelog structure and seeded with current version.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| README.md | Project overview + install/local-dev docs + links to upstream docs/CI workflows. |
| CONTRIBUTING.md | Contribution guidelines and local dev/test expectations. |
| CHANGELOG.md | Initial changelog scaffold with Unreleased + current version section. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+30
to
+38
| ## Local development | ||
|
|
||
| ```sh | ||
| git clone https://github.com/GoCodeAlone/workflow-editor.git | ||
| cd workflow-editor | ||
| npm install | ||
| npm run dev | ||
| npm test | ||
| ``` |
Comment on lines
+5
to
+6
| [](LICENSE) | ||
| [](https://github.com/orgs/GoCodeAlone/packages?repo_name=workflow-editor) |
| [](LICENSE) | ||
| [](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. |
Comment on lines
+20
to
+24
| ## Install | ||
|
|
||
| ```sh | ||
| npm install @gocodealone/workflow-editor | ||
| ``` |
Comment on lines
+9
to
+17
| ## Local development | ||
|
|
||
| ```sh | ||
| git clone https://github.com/GoCodeAlone/workflow-editor.git | ||
| cd workflow-editor | ||
| npm install | ||
| npm run dev | ||
| npm test | ||
| ``` |
|
|
||
| ## Reporting issues | ||
|
|
||
| See the issue templates under `.github/ISSUE_TEMPLATE/`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #13.