docs(ci-generator): add README + examples + experimental banner (QoL sweep)#9
Merged
Conversation
…sweep) - Authors README.md from scratch with experimental status banner, step capabilities (step.ci_generate), supported platforms table, and install instructions - 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/scaffolding-only PR adding a README with an experimental banner, a minimal example config, contributor docs, and GitHub issue/PR templates. No source code is touched. The example config's step.ci_generate keys (platform, output_dir, project_name) match the protobuf contract in internal/contracts/ci_generator.pb.go.
Changes:
- New
README.mddescribing the plugin, install steps, supported CI platforms, and experimental status. - New
examples/minimal/config.yamldemonstrating astep.ci_generatestep. - New
CONTRIBUTING.md, PR template, 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 | Authoritative entry-point doc with status banner, install snippet, and platform table. |
| examples/minimal/config.yaml | Minimal workflow YAML exercising step.ci_generate with valid config keys. |
| CONTRIBUTING.md | Contributor guide pointing to the upstream workflow repo. |
| .github/PULL_REQUEST_TEMPLATE.md | PR checklist template. |
| .github/ISSUE_TEMPLATE/feature_request.md | Feature request issue template. |
| .github/ISSUE_TEMPLATE/bug_report.md | Bug report issue template. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…r (QoL sweep) - Pin install snippet to v0.1.3 (latest stable release per plugin.json) - Add CHANGELOG.md (Keep-a-Changelog format) 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, step capabilities (step.ci_generate), supported CI platforms table, and install instructionsexamples/minimal/config.yaml— validated withwfctl validate --skip-unknown-types✅CONTRIBUTING.mdfrom shared plugin template.github/issue templates 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