Skip to content

docs(eventbus): verified banner + CONTRIBUTING + examples + CHANGELOG (QoL sweep) - #17

Merged
intel352 merged 2 commits into
mainfrom
docs/qol-sweep-eventbus
May 19, 2026
Merged

intel352 merged 2 commits into
mainfrom
docs/qol-sweep-eventbus

Conversation

@intel352

Copy link
Copy Markdown
Contributor

Summary

  • Add verified banner to README (used in production at buymywishlist)
  • Add CONTRIBUTING.md with local dev instructions and PR checklist
  • Add examples/minimal/config.yaml with step.eventbus.publish using pgchannel (no external broker needed)

Test plan

  • README renders verified banner correctly on GitHub
  • CONTRIBUTING.md links resolve correctly
  • examples/minimal/config.yaml YAML is valid
  • CHANGELOG entry is under Unreleased section

Cross-ref: workflow#714

🤖 Generated with Claude Code

… (QoL sweep)

Add verified badge (used-in buymywishlist), CONTRIBUTING.md, and
examples/minimal/config.yaml. Cross-ref workflow#714.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 19, 2026 16:40

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documentation-only QoL sweep adding a "verified in production" banner to the README, a new CONTRIBUTING guide, a minimal runnable pgchannel example, and a matching CHANGELOG entry under Unreleased.

Changes:

  • README banner advertising production validation at buymywishlist.
  • New CONTRIBUTING.md with local dev + PR checklist.
  • New examples/minimal/config.yaml showing step.eventbus.publish over pgchannel.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
README.md Adds a verified-in-production banner near the top.
CONTRIBUTING.md New contributor guide with clone/build/test steps and PR rules.
examples/minimal/config.yaml New minimal example using eventbus.broker (pgchannel) and a publish step.
CHANGELOG.md Adds an Unreleased section listing the three docs additions.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Fix banner hyperlink → bold. Fix CHANGELOG bracket syntax. Add
.github/ISSUE_TEMPLATE/{bug_report,feature_request}.md and
.github/PULL_REQUEST_TEMPLATE.md per spec.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@intel352
intel352 merged commit bb24e27 into main May 19, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants