Remove project field - #68
Conversation
🦋 Changeset detectedLatest commit: 8d336b6 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
📝 WalkthroughWalkthroughThis PR introduces a changeset that removes the Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
Important Pre-merge checks failedPlease resolve all errors before merging. Addressing warnings is optional. ❌ Failed checks (1 error)
✅ Passed checks (3 passed)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
lexicons/org/hypercerts/claim/evidence.json (1)
10-25: Define the new requiredhypercertproperty.Line 11 requires
hypercert, but it is not defined inproperties, which makes the lexicon invalid and breaks client validation. Please add the property (or remove it fromrequiredif it’s not intended).🐛 Proposed fix (adjust ref/type as appropriate)
"properties": { + "hypercert": { + "type": "ref", + "ref": "com.atproto.repo.strongRef", + "description": "A strong reference to the hypercert record this evidence is associated with." + }, "subject": { "type": "ref", "ref": "com.atproto.repo.strongRef", "description": "A strong reference to the record this evidence relates to (e.g. an activity, project, claim, or evaluation)." },lexicons/org/hypercerts/claim/activity.json (1)
18-80: Update README.md and ERD.puml to remove the project field from the activity record.The
projectfield has been removed from the activity lexicon, but README.md (line 188) and ERD.puml still reference it. Remove the project row from the activity properties table in README.md and remove theproject?field andactivity::project --> projectrelationship from the activity entity in ERD.puml to maintain documentation-implementation consistency.
🤖 Fix all issues with AI agents
In @.changeset/wild-rivers-flow.md:
- Around line 5-10: Update the changeset to also document the new required
hypercert field on the evidence schema: add a short sentence to the existing
changeset note stating that the evidence claim now requires a hypercert field
(and that this is a public API change) so release notes cover it; reference the
"evidence" schema and the "hypercert" field in the text and keep the note
concise and aligned with the existing reasoning about removal of project from
activity.
| Remove `project` field from `activity` claim schema. | ||
|
|
||
| Reasoning: | ||
| - **Separation of Concerns & Flexibility**: We decided to remove the `project` field to keep the activity claim as small as possible and free of redundant information. | ||
| - **Lexicon Strategy**: Instead of a direct field, we will use a `collection` lexicon that can encompass project-related data. This allows for collections of collections, enabling more complex structures. | ||
| - **Developer Control**: This approach allows app developers to decide whether to enforce a 1-1 or 1-many relationship between projects and activities, rather than enforcing it at the schema level. |
There was a problem hiding this comment.
Add the evidence schema change to the changeset.
The changeset omits the new required hypercert field in the evidence schema. Please add a brief note so release notes cover all public API changes.
✍️ Suggested update
Remove `project` field from `activity` claim schema.
+Require `hypercert` on `evidence` records.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| Remove `project` field from `activity` claim schema. | |
| Reasoning: | |
| - **Separation of Concerns & Flexibility**: We decided to remove the `project` field to keep the activity claim as small as possible and free of redundant information. | |
| - **Lexicon Strategy**: Instead of a direct field, we will use a `collection` lexicon that can encompass project-related data. This allows for collections of collections, enabling more complex structures. | |
| - **Developer Control**: This approach allows app developers to decide whether to enforce a 1-1 or 1-many relationship between projects and activities, rather than enforcing it at the schema level. | |
| Remove `project` field from `activity` claim schema. | |
| Require `hypercert` on `evidence` records. | |
| Reasoning: | |
| - **Separation of Concerns & Flexibility**: We decided to remove the `project` field to keep the activity claim as small as possible and free of redundant information. | |
| - **Lexicon Strategy**: Instead of a direct field, we will use a `collection` lexicon that can encompass project-related data. This allows for collections of collections, enabling more complex structures. | |
| - **Developer Control**: This approach allows app developers to decide whether to enforce a 1-1 or 1-many relationship between projects and activities, rather than enforcing it at the schema level. |
🤖 Prompt for AI Agents
In @.changeset/wild-rivers-flow.md around lines 5 - 10, Update the changeset to
also document the new required hypercert field on the evidence schema: add a
short sentence to the existing changeset note stating that the evidence claim
now requires a hypercert field (and that this is a public API change) so release
notes cover it; reference the "evidence" schema and the "hypercert" field in the
text and keep the note concise and aligned with the existing reasoning about
removal of project from activity.
|
duplicate PR |
|
Yep duplicate of #67 as discussed just now |
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.