Conversation
|
Caution Review failedPull request was closed or merged during review 📝 WalkthroughWalkthroughThis PR reorganizes documentation: it removes a large design doc, adds three ADRs (local-first TUI/CLI, bundled core dictionary lifecycle, release/update policy), adds README badges, records a new runtime dependency, and adds task/spec tracking files. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (3)
docs/adr/0003-release-and-update-policy.md (1)
1-47: Consider using adr-manager skill for ADR creation.The ADR content is technically accurate (verified against code snippets showing DefaultTTL=24h, DefaultTimeout=1.5s, EITANGO_DISABLE_UPDATE_CHECK env var, first-run suppression logic, and silent error handling). However, the repository guideline states to use the
adr-managerskill when editing ADRs.While this guideline specifically mentions "editing" (編集), and these are new ADRs being created rather than edited, consider whether the
adr-managerskill should also be used for ADR creation to maintain consistency in ADR management practices.Based on learnings: 設計判断やトレードオフは
docs/adr/に、現行の内部仕様や制約はdocs/specs/に移すこと / ADR を編集する場合はadr-managerskill を使うこと🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/adr/0003-release-and-update-policy.md` around lines 1 - 47, The ADR was created without using the repository's adr-manager workflow; update docs/adr/0003-release-and-update-policy.md to follow the repo guideline by either recreating or registering this ADR via the adr-manager skill (or add a brief note in the ADR header indicating an approved exception), referencing the adr-manager process so the ADR is tracked consistently; ensure the ADR metadata/header includes the adr-manager identifier or exception note to match other ADRs.docs/adr/0002-bundled-core-dictionary-lifecycle.md (1)
1-52: Consider using adr-manager skill for ADR creation.The ADR content is technically accurate (verified against code snippets showing ValidateCoreEntries validation, CoreWordsVersion constant, source separation via WordSourceCore/"import:" constants, and selective reset behavior). However, the repository guideline states to use the
adr-managerskill when editing ADRs.While this guideline specifically mentions "editing" (編集), and these are new ADRs being created rather than edited, consider whether the
adr-managerskill should also be used for ADR creation to maintain consistency in ADR management practices.Based on learnings: 設計判断やトレードオフは
docs/adr/に、現行の内部仕様や制約はdocs/specs/に移すこと / ADR を編集する場合はadr-managerskill を使うこと🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/adr/0002-bundled-core-dictionary-lifecycle.md` around lines 1 - 52, The ADR was created directly but repository guidelines require using the adr-manager tool for ADR edits (and likely for creation to keep consistency); update the process for this ADR by reauthoring or registering it through the adr-manager workflow and/or CLI so metadata, changelog, and management records are consistent with other ADRs (ensure docs/adr/0002-bundled-core-dictionary-lifecycle.md is generated/registered via adr-manager and reference the adr-manager usage in the ADR header or repo CONTRIBUTING notes so future ADRs and edits use adr-manager).docs/adr/0001-local-first-tui-cli-architecture.md (1)
1-49: Consider using adr-manager skill for ADR creation.The ADR appropriately documents architectural design decisions about the local-first TUI/CLI runtime structure. However, the repository guideline states to use the
adr-managerskill when editing ADRs.While this guideline specifically mentions "editing" (編集), and these are new ADRs being created rather than edited, consider whether the
adr-managerskill should also be used for ADR creation to maintain consistency in ADR management practices.Based on learnings: 設計判断やトレードオフは
docs/adr/に、現行の内部仕様や制約はdocs/specs/に移すこと / ADR を編集する場合はadr-managerskill を使うこと🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/adr/0001-local-first-tui-cli-architecture.md` around lines 1 - 49, The ADR (ADR-0001 in docs/adr/0001-local-first-tui-cli-architecture.md) was added directly but repository conventions require using the adr-manager skill for ADR lifecycle actions; update this change by recreating or moving ADR-0001 using the adr-manager workflow (use the adr-manager tool/skill to create the ADR entry instead of hand-editing the file), ensure the ADR metadata and status fields match the current content, and remove the manual file edit so the adr-manager becomes the authoritative source for this ADR going forward.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.en.md`:
- Around line 9-14: The Go module version badge URL uses inconsistent lowercase
repository casing ("harumiweb/eitango") while the other badges use
"harumiWeb/eitango"; update the Go module badge URL string to match the exact
"harumiWeb/eitango" casing so all badge URLs are uniform (change the segment in
the Go module version badge URL that currently reads harumiweb/eitango to
harumiWeb/eitango).
In `@README.md`:
- Around line 9-14: Update the badge URLs so the repository name casing is
consistent by replacing the lowercase occurrence "harumiweb/eitango" in the Go
module version badge URL with "harumiWeb/eitango" to match the other badges
(look for the markdown image/link that contains
"https://img.shields.io/github/go-mod/go-version/harumiweb/eitango" and change
it to use "harumiWeb/eitango"); ensure all other badge URLs (e.g., the GitHub
Release badge and any other shields) use the exact same "harumiWeb/eitango"
casing.
---
Nitpick comments:
In `@docs/adr/0001-local-first-tui-cli-architecture.md`:
- Around line 1-49: The ADR (ADR-0001 in
docs/adr/0001-local-first-tui-cli-architecture.md) was added directly but
repository conventions require using the adr-manager skill for ADR lifecycle
actions; update this change by recreating or moving ADR-0001 using the
adr-manager workflow (use the adr-manager tool/skill to create the ADR entry
instead of hand-editing the file), ensure the ADR metadata and status fields
match the current content, and remove the manual file edit so the adr-manager
becomes the authoritative source for this ADR going forward.
In `@docs/adr/0002-bundled-core-dictionary-lifecycle.md`:
- Around line 1-52: The ADR was created directly but repository guidelines
require using the adr-manager tool for ADR edits (and likely for creation to
keep consistency); update the process for this ADR by reauthoring or registering
it through the adr-manager workflow and/or CLI so metadata, changelog, and
management records are consistent with other ADRs (ensure
docs/adr/0002-bundled-core-dictionary-lifecycle.md is generated/registered via
adr-manager and reference the adr-manager usage in the ADR header or repo
CONTRIBUTING notes so future ADRs and edits use adr-manager).
In `@docs/adr/0003-release-and-update-policy.md`:
- Around line 1-47: The ADR was created without using the repository's
adr-manager workflow; update docs/adr/0003-release-and-update-policy.md to
follow the repo guideline by either recreating or registering this ADR via the
adr-manager skill (or add a brief note in the ADR header indicating an approved
exception), referencing the adr-manager process so the ADR is tracked
consistently; ensure the ADR metadata/header includes the adr-manager identifier
or exception note to match other ADRs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 803b0892-3418-4c80-aebc-3ad3754244ab
📒 Files selected for processing (9)
README.en.mdREADME.mdTHIRD_PARTY_NOTICES.mddocs/adr/0001-local-first-tui-cli-architecture.mddocs/adr/0002-bundled-core-dictionary-lifecycle.mddocs/adr/0003-release-and-update-policy.mddocs/design.mdtasks/feature_spec.mdtasks/todo.md
💤 Files with no reviewable changes (1)
- docs/design.md
1 participant
Summary
Verification
Summary by CodeRabbit