Skip to content

Add registry-compliant YAML files for v0.1.1 - #1

Merged
glamberson merged 1 commit into
masterfrom
add-registry-yaml
Jul 28, 2025
Merged

Add registry-compliant YAML files for v0.1.1#1
glamberson merged 1 commit into
masterfrom
add-registry-yaml

Conversation

@glamberson

@glamberson glamberson commented Jul 28, 2025

Copy link
Copy Markdown
Owner

Summary

This PR adds the GEDCOM registry-compliant YAML files and prepares for the v0.1.1 release.

Changes

  • Added registry-yaml/ directory with official GEDCOM registry format
  • Includes all 12 required files:
    • 7 structure definitions (_EVID, _ID, _FIND, _RDOC, _RACT, _CONC, _CONF)
    • 4 enumeration definitions (High, Medium, Low, Hypothesis)
    • 1 enumeration-set definition (Confidence)
  • Added VERSION file (0.1.1)
  • Added CHANGELOG.md to track version history
  • Updated README with registry submission status and documentation links

Context

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, but registry-yaml/ contains the authoritative definitions going forward.

Registry Compliance

The key differences from our original YAML files:

  • Fixed type: recordtype: structure
  • Added proper enumeration definitions
  • Fixed enumeration values to uppercase (_HIGH, _MEDIUM, etc.)
  • All files validated with the official registry validator

🤖 Generated with Claude Code

Summary by Sourcery

Add registry-compliant YAML definitions for gedcom-evidence and prepare v0.1.1 release.

New Features:

  • Introduce registry-yaml directory with 12 GEDCOM registry–compliant YAML files covering 7 structure definitions, 4 enumeration values, and 1 enumeration-set definition
  • Add VERSION file for v0.1.1 and CHANGELOG.md to track project history

Enhancements:

  • Update README to include registry submission status, link to registry-yaml directory, and adjust documentation links

Documentation:

  • Add registry-yaml README explaining official registry format, key differences, and usage

- Added registry-yaml/ directory with official GEDCOM registry format
- Includes all 12 required files (7 structures, 4 enumerations, 1 enumeration-set)
- These files were submitted to GEDCOM registry via PR #173
- Validated using official GEDCOM registry validator
- Added VERSION file (0.1.1)
- Added CHANGELOG.md to track version history
- Updated README with registry submission status and documentation links

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>
@sourcery-ai

sourcery-ai Bot commented Jul 28, 2025

Copy link
Copy Markdown

Reviewer's Guide

This PR prepares the v0.1.1 release by incorporating official GEDCOM registry-compliant YAML definitions under a new registry-yaml directory, adding release metadata files, and updating documentation to reference the registry submission and new authoritative definitions.

Entity relationship diagram for new registry-compliant GEDCOM YAML structures

erDiagram
    _EVID {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _FIND {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _ID {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _CONC {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _CONF {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _RDOC {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }
    _RACT {
      string contact
      string label
      string lang
      string payload
      string specification
      string type
      string uri
    }

    _EVID ||--o{ _FIND : contains
    _EVID ||--o{ _ID : contains
    _EVID ||--o| _CONF : contains
    _FIND ||--o{ _ID : contains
    _ID ||--o{ _RDOC : contains
    _CONC ||--o{ _RDOC : contains
    _RACT ||--o{ _RDOC : contains
    _EVID ||--o| _CONF : has
    _CONF }o--|| enumset_Confidence : uses
    enumset_Confidence {
      string uri
    }
    enumset_Confidence ||--o{ enum_High : includes
    enumset_Confidence ||--o{ enum_Medium : includes
    enumset_Confidence ||--o{ enum_Low : includes
    enumset_Confidence ||--o{ enum_Hypothesis : includes
    enum_High {
      string uri
    }
    enum_Medium {
      string uri
    }
    enum_Low {
      string uri
    }
    enum_Hypothesis {
      string uri
    }
Loading

Class diagram for registry-compliant GEDCOM YAML structure types

classDiagram
    class _EVID {
      +contact: string
      +label: string
      +lang: string
      +payload: null
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _FIND {
      +contact: string
      +label: string
      +lang: string
      +payload: null
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _ID {
      +contact: string
      +label: string
      +lang: string
      +payload: string
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _CONC {
      +contact: string
      +label: string
      +lang: string
      +payload: string
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _CONF {
      +contact: string
      +label: string
      +lang: string
      +payload: string
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _RDOC {
      +contact: string
      +label: string
      +lang: string
      +payload: string
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    class _RACT {
      +contact: string
      +label: string
      +lang: string
      +payload: null
      +specification: string[]
      +substructures: map
      +superstructures: map
      +type: structure
      +uri: string
    }
    _EVID --> _FIND : contains
    _EVID --> _ID : contains
    _EVID --> _CONF : contains
    _FIND --> _ID : contains
    _ID --> _RDOC : contains
    _CONC --> _RDOC : contains
    _RACT --> _RDOC : contains
    _CONF --> enumset_Confidence : uses
    class enumset_Confidence {
      +uri: string
      +enumeration_values: string[]
    }
    enumset_Confidence --> enum_High : includes
    enumset_Confidence --> enum_Medium : includes
    enumset_Confidence --> enum_Low : includes
    enumset_Confidence --> enum_Hypothesis : includes
    class enum_High {
      +uri: string
    }
    class enum_Medium {
      +uri: string
    }
    class enum_Low {
      +uri: string
    }
    class enum_Hypothesis {
      +uri: string
    }
Loading

File-Level Changes

Change Details Files
Introduce registry-compliant YAML definitions for gedcom-evidence extension
  • Created registry-yaml directory with structure, enumeration, and enumeration-set subfolders
  • Added 7 structure definitions with updated type and tags
  • Added 4 enumeration definitions for confidence levels
  • Added 1 enumeration-set definition consolidating confidence values
registry-yaml/structure/_EVID.yaml
registry-yaml/structure/_FIND.yaml
registry-yaml/structure/_RACT.yaml
registry-yaml/structure/_RDOC.yaml
registry-yaml/structure/_CONC.yaml
registry-yaml/structure/_ID.yaml
registry-yaml/structure/_CONF.yaml
registry-yaml/enumeration/enum-High.yaml
registry-yaml/enumeration/enum-Medium.yaml
registry-yaml/enumeration/enum-Low.yaml
registry-yaml/enumeration/enum-Hypothesis.yaml
registry-yaml/enumeration-set/enumset-Confidence.yaml
Add release versioning and changelog
  • Created VERSION file set to 0.1.1
  • Added CHANGELOG.md following Keep a Changelog format
  • Documented new 0.1.1 entries
VERSION
CHANGELOG.md
Update documentation to reference registry submission and new definitions
  • Modified root README.md to add Registry-Compliant YAML link, status section, and adjust navigation
  • Added registry-yaml/README.md explaining usage and key differences
README.md
registry-yaml/README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@glamberson
glamberson merged commit 2dd358b into master Jul 28, 2025
@glamberson
glamberson deleted the add-registry-yaml branch July 28, 2025 10:45

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey @glamberson - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

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