Skip to content

docs: add proposer field to README Before/After example#11

Merged
renasami merged 1 commit intomainfrom
fix/readme-proposer-field
Apr 18, 2026
Merged

docs: add proposer field to README Before/After example#11
renasami merged 1 commit intomainfrom
fix/readme-proposer-field

Conversation

@renasami
Copy link
Copy Markdown
Owner

@renasami renasami commented Apr 18, 2026

Summary

  • ADR-002 で Proposal.proposer を必須化したが、README Before/After の例に proposer が無くコンパイルが通らなかった
  • 最小差分で proposer: "cleanup-bot" を追加

ADR-002 の Action Items に記載されていたまま残っていた小さな負債の解消です。

Test plan

  • pnpm run typecheck pass
  • コードブロックを手元で型チェック — 通る

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated example code in README to demonstrate how to specify a proposer identifier when submitting a proposal, providing clearer guidance on the proposal API usage.

ADR-002 made `Proposal.proposer` required, but the README's
Before/After example still omitted it, so the snippet no longer
compiled against the current API. Add `proposer: "cleanup-bot"`
to keep the example runnable.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 18, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: def721e4-222c-4c62-8258-30a526fe6165

📥 Commits

Reviewing files that changed from the base of the PR and between 12a1f98 and 8fb6915.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

The README's "After" example for tegata.propose(...) now includes a new proposer: "cleanup-bot" field in the proposal payload to demonstrate explicit agent identification within proposal submissions.

Changes

Cohort / File(s) Summary
Documentation Examples
README.md
Added proposer: "cleanup-bot" field to the tegata.propose(...) example in the "After" section to show explicit proposing agent identification.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 A proposer now signs their name,
In cleanup-bot's well-earned fame,
The example shines so bright and clear,
Identity now does appear! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add proposer field to README Before/After example' accurately and clearly describes the main change: adding a proposer field to a code example in the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-proposer-field

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the example code in the README.md file to include a 'proposer' field in the 'tegata.propose' method call. I have no feedback to provide as there are no review comments to evaluate.

@renasami renasami merged commit 5e34343 into main Apr 18, 2026
1 of 2 checks passed
renasami added a commit that referenced this pull request Apr 19, 2026
Code examples already include proposer (PR #11), but the README didn't
explain what it represents or why it's required. Add a short paragraph
after Quick Start that defines proposer, notes it must be non-anonymous,
and links to ADR-002 for the audit-trail attribution rationale.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
renasami added a commit that referenced this pull request Apr 19, 2026
…14)

Code examples already include proposer (PR #11), but the README didn't
explain what it represents or why it's required. Add a short paragraph
after Quick Start that defines proposer, notes it must be non-anonymous,
and links to ADR-002 for the audit-trail attribution rationale.

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
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.

1 participant