Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Explain how to update existing YAML files for extensions #50

Closed
wants to merge 2 commits into from
Closed

Explain how to update existing YAML files for extensions #50

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
afe781c
Explain how to update existing YAML files for extensions
dthaler2 May 23, 2024
537b2a4
Update README.md
dthaler May 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,19 @@ In either case, once an extension meets the
[Valuable, Absent, and Used criteria](https://github.com/FamilySearch/GEDCOM/tree/main/attribute-event-requests#proposing-new-family-and-individual-attributes-and-events)
then a standard tag/URI can be added into the 'v7.1' branch of the
[FamilySearch/GEDCOM repository](https://github.com/FamilySearch/GEDCOM) for inclusion into a future release.

## Updating extensions

When an implementation has an extension and makes changes that affect its use in GEDCOM files,
the YAML file should be updated. The appropriate changes to the YAML file depend on the nature
of the changes in the implementation.

If the implementation merely starts using a documented extension with another GEDCOM version,
no changes to the YAML file are needed.

If the implementation updates its use (e.g., to add a new substructure) for all GEDCOM versions
that the structure can appear in, and it is the only implementation using the extension then
it can simply update the existing YAML file.

If the implementation updates its use but only for some versions of GEDCOM, or is not the only
implementation using the extension, then it should create and register a new YAML file with a new URI.
Loading