renaming fields to contributorIdentity and contributionWeight in activity claim - #114
Conversation
|
📝 WalkthroughWalkthroughRefactors activity contributors: Changes
Sequence Diagram(s)(omitted — schema/data-model changes only) Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 1
🤖 Fix all issues with AI agents
In `@lexicons/org/hypercerts/claim/activity.json`:
- Around line 86-90: Update the description for the contributorIdentity property
to reference the current lexicon name instead of the old
org.hypercerts.claim.contributorInformation#main; locate the contributorIdentity
object (type: "union", refs: ["#contributorIdentity",
"com.atproto.repo.strongRef"]) and change the description text to mention the
new contributorIdentity identifier (e.g.,
org.hypercerts.claim.contributorIdentity#main) or otherwise remove the outdated
lexicon name so the description matches the refs and current property name.
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
SCHEMAS.md (1)
27-27: Correct the type specification for thecontributorsproperty in SCHEMAS.md.The
contributorsproperty is incorrectly documented as typerefon line 27. According to the lexicon definition inlexicons/org/hypercerts/claim/activity.json,contributorsis actually an array type with items that reference the contributor definition. Update line 27 to document the type asarrayto match the actual schema structure.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@SCHEMAS.md`:
- Line 29: Update README.md to document the activity record's locations field
now being an array: explain that "locations" is an array of strongRef objects
pointing to records conforming to app.certified.location, show the strongRef
shape used elsewhere in the repo (key fields and example), and describe the
sidecar pattern for embedding location metadata similar to the existing location
and collection sidecar examples; include a short example activity JSON with a
locations array referencing two app.certified.location records and a brief note
on validation/expectations.
2cc43c6 to
d0a03bb
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In @.changeset/refactor-contributions-structure.md:
- Around line 25-40: The migration example uses a fenced block labeled "json"
but contains inline comments ("// Before"/"// After") which makes it invalid
JSON; update the fenced block language to "jsonc" or remove the inline comment
lines so the example is valid JSON, and ensure the example shows the original
"contributions" array and the new "contributors" array with fields like
"contributorIdentity", "contributionWeight", and "contributionDetails" exactly
as in the diff so readers can copy/paste without syntax errors.
| ```json | ||
| // Before | ||
| "contributions": [strongRef1, strongRef2] | ||
|
|
||
| // After | ||
| "contributors": [ | ||
| { | ||
| "contributorIdentity": "did:example:123", | ||
| "contributionWeight": "1.5", | ||
| "contributionDetails": "Lead developer" | ||
| }, | ||
| { | ||
| "contributorIdentity": strongRefToContributorInfo, | ||
| "contributionDetails": strongRefToContributionDetails | ||
| } | ||
| ] |
There was a problem hiding this comment.
Use valid JSON (or label as JSONC) in the migration example.
The // Before/// After comments make the json block invalid to copy/paste. Consider switching to jsonc or removing the inline comments.
💡 Suggested tweak
-```json
+```jsonc🤖 Prompt for AI Agents
In @.changeset/refactor-contributions-structure.md around lines 25 - 40, The
migration example uses a fenced block labeled "json" but contains inline
comments ("// Before"/"// After") which makes it invalid JSON; update the fenced
block language to "jsonc" or remove the inline comment lines so the example is
valid JSON, and ensure the example shows the original "contributions" array and
the new "contributors" array with fields like "contributorIdentity",
"contributionWeight", and "contributionDetails" exactly as in the diff so
readers can copy/paste without syntax errors.
2 participants
Summary by CodeRabbit
New Features
Breaking Changes
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.