Add registry-compliant YAML files for v0.2.1#5
Merged
Conversation
- Added registry-yaml/ directory with official GEDCOM registry format - Includes all 9 required files (5 structures, 3 enumerations, 1 enumeration-set) - These files were submitted to GEDCOM registry via PR #173 - Validated using official GEDCOM registry validator - Added CHANGELOG.md to track version history - Updated README with registry submission status - Bumped version to 0.2.1 The original yaml/ directory is preserved for backward compatibility, but registry-yaml/ contains the authoritative definitions. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
Reviewer's GuideThis PR prepares the v0.2.1 release by introducing a new registry-yaml directory containing nine GEDCOM registry-compliant definitions (five structures, three enumerations, one enumeration-set), adding a changelog and version bump, and updating documentation to reflect published status and registry submission. Entity relationship diagram for new registry-compliant GEDCOM structures and enumerationserDiagram
_OCUR {
string uri
string label
}
_PART {
string uri
string label
}
_OCREF {
string uri
string label
}
_ATTR {
string uri
string label
}
_PRESENCE {
string uri
string label
}
enumset_Presence {
string uri
}
enum_Present {
string uri
}
enum_Absent {
string uri
}
enum_Unknown {
string uri
}
_OCUR ||--o{ _PART : "has participants"
_PART }o--|| _OCUR : "belongs to occurrence"
_OCREF ||--o{ _ATTR : "has attributes"
_OCREF ||--|{ _PRESENCE : "has presence status"
_OCREF }o--|| _PART : "references participant"
_OCREF }o--|| _OCUR : "references occurrence"
_PRESENCE }o--|| enumset_Presence : "uses enumset"
enumset_Presence ||--|{ enum_Present : "includes"
enumset_Presence ||--|{ enum_Absent : "includes"
enumset_Presence ||--|{ enum_Unknown : "includes"
_ATTR }o--|| _OCREF : "belongs to occurrence reference"
Class diagram for registry-compliant GEDCOM YAML structuresclassDiagram
class _OCUR {
+string uri
+string label
+list<_PART> participants
+list<string> substructures
}
class _PART {
+string uri
+string label
+string pointerToParticipant
}
class _OCREF {
+string uri
+string label
+string payload
+list<_ATTR> attributes
+_PRESENCE presence
+list<string> substructures
}
class _ATTR {
+string uri
+string label
+string type
+string text
}
class _PRESENCE {
+string uri
+string label
+enumset_Presence status
}
class enumset_Presence {
+string uri
+list<enum> values
}
class enum_Present {
+string uri
+string label
}
class enum_Absent {
+string uri
+string label
}
class enum_Unknown {
+string uri
+string label
}
_OCUR --> _PART : contains
_PART --> _OCUR : belongs to
_OCREF --> _ATTR : has
_OCREF --> _PRESENCE : has
_OCREF --> _OCUR : references
_PRESENCE --> enumset_Presence : uses
enumset_Presence --> enum_Present : includes
enumset_Presence --> enum_Absent : includes
enumset_Presence --> enum_Unknown : includes
_ATTR --> _OCREF : belongs to
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @glamberson - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `registry-yaml/structure/_ATTR.yaml:17` </location>
<code_context>
+
+ enumeration district, or other structured data from historical records.'
+substructures:
+ https://gedcom.io/terms/v7/TEXT: '{1:1}'
+ https://gedcom.io/terms/v7/TYPE: '{1:1}'
+superstructures:
+ https://github.com/glamberson/gedcom-occurrences/_OCREF: '{0:M}'
</code_context>
<issue_to_address>
Required substructure cardinality is strict.
If omitting either field is valid, adjust the cardinality. Otherwise, confirm all data sources provide both fields.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment on lines
+17
to
+18
| https://gedcom.io/terms/v7/TEXT: '{1:1}' | ||
| https://gedcom.io/terms/v7/TYPE: '{1:1}' |
There was a problem hiding this comment.
question: Required substructure cardinality is strict.
If omitting either field is valid, adjust the cardinality. Otherwise, confirm all data sources provide both fields.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds the GEDCOM registry-compliant YAML files and prepares for the v0.2.1 release.
Changes
registry-yaml/directory with official GEDCOM registry formatContext
These YAML files were submitted to the official GEDCOM registry via PR #173 and have been validated using the official GEDCOM registry validator.
The original
yaml/directory is preserved for backward compatibility, butregistry-yaml/contains the authoritative definitions going forward.Registry Compliance
The key differences from our original YAML files:
type: record→type: structure🤖 Generated with Claude Code
Summary by Sourcery
Add registry-compliant GEDCOM YAML definitions for the gedcom-occurrences extension in preparation for the v0.2.1 release, update documentation, and bump project version.
New Features:
Enhancements:
Documentation: