Skip to content

docs: clarify expected lexicon types in contributorIdentity and contributionDetails descriptions - #157

Merged
aspiers merged 1 commit into
developfrom
fix/contributor-identity-description
Mar 2, 2026
Merged

docs: clarify expected lexicon types in contributorIdentity and contributionDetails descriptions#157
aspiers merged 1 commit into
developfrom
fix/contributor-identity-description

Conversation

@aspiers

@aspiers aspiers commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

Summary

  • contributorIdentity strongRef description now explicitly states the referenced record must conform with org.hypercerts.claim.contributorInformation
  • contributionDetails strongRef description now explicitly states the referenced record must conform with org.hypercerts.claim.contribution

Consistent with the pattern used by other strongRef fields in this repo (e.g. locations, rights).

Summary by CodeRabbit

  • Documentation
    • Strengthened contributor activity schema with explicit conformity requirements linking contributor identity and contribution details to their respective definitions.
    • Clarified contributor identity and contribution role fields to require specific identity and role strings.
    • Added public definitions for contributor identity, contributor role, and work scope with required properties.
    • Refined contribution weight description to emphasize positive numeric values and remove outdated normalization notes.

Copilot AI review requested due to automatic review settings March 2, 2026 14:54
@changeset-bot

changeset-bot Bot commented Mar 2, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 4752420

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Mar 2, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 04ba78c and 4752420.

📒 Files selected for processing (2)
  • SCHEMAS.md
  • lexicons/org/hypercerts/claim/activity.json

📝 Walkthrough

Walkthrough

Updated activity schema descriptions to embed explicit inline contributor identity/role objects, add conformity requirements referencing contributorInformation and contribution lexicons, refine contributionWeight text, and add new defs: contributorIdentity, contributorRole, and workScopeString.

Changes

Cohort / File(s) Summary
Schema Docs & Activity Lexicon
SCHEMAS.md, lexicons/org/hypercerts/claim/activity.json
Rewrote contributor-related descriptions to use inline contributorIdentity and contributorRole objects; added conformity requirements that referenced records conform to org.hypercerts.claim.contributorInformation and org.hypercerts.claim.contribution; added new defs contributorIdentity, contributorRole, and workScopeString; tightened contributionWeight wording (positive numeric requirement, removed normalization/storage note).

Sequence Diagram(s)

(omitted — changes are documentation/definition refinements without new multi-component control flow)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Suggested reviewers

  • s-adamantine
  • bitbeckers

Poem

🐰 I hopped through schema lines tonight,
I nudged the defs to make them right,
Identities and roles now clear,
Conformance whispers in my ear,
Hooray — the lexicon is bright! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: clarifying lexicon type requirements in documentation for contributorIdentity and contributionDetails fields.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Lexicon Documentation Sync ✅ Passed JSON lexicon (activity.json) was modified with documentation updates, and SCHEMAS.md was updated accordingly. README.md does not document the activity lexicon, so updates are not required. ERD.puml requires no changes as modifications are documentation-only.
Lexicons Styleguide Compliance ✅ Passed Changes to lexicons/org/hypercerts/claim/activity.json fully comply with ATProto lexicon styleguide by documenting strongRef usage with expected lexicon types.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/contributor-identity-description

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.

❤️ Share

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

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Updates schema documentation to explicitly state the expected lexicon types for strongRef variants of contributorIdentity and contributionDetails in org.hypercerts.claim.activity, aligning with existing strongRef description patterns elsewhere in the repo.

Changes:

  • Clarifies that contributorIdentity strongRef targets must conform to org.hypercerts.claim.contributorInformation.
  • Clarifies that contributionDetails strongRef targets must conform to org.hypercerts.claim.contribution.
  • Propagates these description updates into the generated SCHEMAS.md reference.

Reviewed changes

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

File Description
lexicons/org/hypercerts/claim/activity.json Updates field descriptions to specify required lexicon conformance for strongRef targets.
SCHEMAS.md Updates generated schema reference text to match the updated lexicon descriptions.

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

Comment thread lexicons/org/hypercerts/claim/activity.json
Comment thread lexicons/org/hypercerts/claim/activity.json
@aspiers
aspiers force-pushed the fix/contributor-identity-description branch from 04ba78c to 4752420 Compare March 2, 2026 17:18
@aspiers
aspiers merged commit f947b1c into develop Mar 2, 2026
5 checks passed
@aspiers
aspiers deleted the fix/contributor-identity-description branch March 2, 2026 17:35
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