docs(aws): add README + examples + experimental banner (QoL sweep)#23
Merged
Conversation
- Authors README.md from scratch with experimental status banner, module/step/backend capabilities, install instructions, and env var table - Adds examples/minimal/config.yaml (wfctl validate --skip-unknown-types ✅) - Adds CONTRIBUTING.md from shared plugin template - Adds .github/ issue templates and PR template Part of 2026-05-19 multi-repo OSS-readiness QoL sweep. See: GoCodeAlone/workflow#714 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Documentation and OSS-readiness sweep: adds README with experimental banner and capability overview, a minimal validated example config, contributing guide, and standard GitHub issue/PR templates.
Changes:
- New
README.mdcovering capabilities, install, env vars, and links - New minimal example config and
CONTRIBUTING.md - New
.github/PR and issue templates
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Project README with experimental banner, capabilities, install, env vars |
| examples/minimal/config.yaml | Minimal validating example config |
| CONTRIBUTING.md | Contributor quickstart referencing upstream |
| .github/PULL_REQUEST_TEMPLATE.md | PR template |
| .github/ISSUE_TEMPLATE/feature_request.md | Feature request template |
| .github/ISSUE_TEMPLATE/bug_report.md | Bug report template |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…eep) Use v-prefixed tag format in install snippet (v2.0.0). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…eep) Correct install snippet version to v1.2.1 (latest stable tag from repo root). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
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.
Summary
README.mdfrom scratch with experimental status banner, module/step/backend capabilities, install instructions, and required env var tableexamples/minimal/config.yaml— validated withwfctl validate --skip-unknown-types✅CONTRIBUTING.mdfrom shared plugin template.github/issue templates (bug report, feature request) and PR templateTest plan
GOWORK=off go build ./...passesGOWORK=off go vet ./...passeswfctl validate --skip-unknown-types examples/minimal/config.yamlpassesRelated
Part of the 2026-05-19 multi-repo OSS-readiness QoL sweep.
See: GoCodeAlone/workflow#714
🤖 Generated with Claude Code