OBO Foundry

<!doctype html> <html lang="en"> <head> <title>OBO Foundry</title> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/css/bootstrap.min.css">  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.css" />  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.9.1/font/bootstrap-icons.css">  <link rel="stylesheet" href="/assets/css/style.css"> <link type="application/atom+xml" rel="alternate" href="http://obofoundry.org/feed.xml" title="The OBO Foundry" /> <style> html, body { height: 100%; } body { display: flex; flex-flow: column; } .footer { margin-top: auto; padding-top: 1em; background-color: #f5f5f5; } </style> </head> <body><nav class="navbar navbar-expand-lg navbar-light bg-light"> <div class="container-fluid"> <a class="navbar-brand" href="/"> <img src="/images/foundrylogo.png" alt="" style="max-height: 24px" class="d-inline-block align-text-top"> OBO Foundry </a> <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarSupportedContent" aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation"> <span class="navbar-toggler-icon"></span> </button> <div class="collapse navbar-collapse" id="navbarSupportedContent"> <ul class="navbar-nav me-auto mb-2 mb-lg-0"> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarAboutDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> About </a> <ul class="dropdown-menu" aria-labelledby="navbarAboutDropdown"> <li><a class="dropdown-item" href="/about-OBO-Foundry.html">About</a></li> <li><a class="dropdown-item" href="/docs/COC.html">Code of Conduct</a></li> <li><a class="dropdown-item" href="/resources">Resources</a></li> <li> <hr class="dropdown-divider"> </li> <li><a class="dropdown-item" href="/docs/OperationsCommittee.html">Operations Committee</a></li> <li><a class="dropdown-item" href="/docs/SOP.html" style="padding-left: 2em">Standard Operating Procedures</a></li> <li><a class="dropdown-item" href="/docs/EditorialWG.html" style="padding-left: 2em">Editorial Working Group</a></li> <li><a class="dropdown-item" href="/docs/TechnicalWG.html" style="padding-left: 2em">Technical Working Group</a></li> <li><a class="dropdown-item" href="/docs/OutreachWG.html" style="padding-left: 2em">Outreach Working Group</a></li> <li><a class="dropdown-item" href="/roles/">OBO Foundry Organizational Roles</a></li> <li> <hr class="dropdown-divider"> </li> <li><a class="dropdown-item" href="https://github.com/OBOFoundry/OBOFoundry.github.io">GitHub Project</a></li> <li><a class="dropdown-item" href="https://github.com/OBOFoundry">GitHub Organization</a></li> </ul> </li> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarPrinciplesDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Principles </a> <ul class="dropdown-menu" aria-labelledby="navbarPrinciplesDropdown"> <li><a class="dropdown-item" href="/principles/fp-000-summary.html">Overview</a></li> <li><a class="dropdown-item" href="/principles/fp-001-open.html">Open (principle 1)</a></li> <li><a class="dropdown-item" href="/principles/fp-002-format.html">Common Format (principle 2)</a></li> <li><a class="dropdown-item" href="/principles/fp-003-uris.html">URI/Identifier Space (principle 3)</a></li> <li><a class="dropdown-item" href="/principles/fp-004-versioning.html">Versioning (principle 4)</a></li> <li><a class="dropdown-item" href="/principles/fp-005-delineated-content.html">Scope (principle 5)</a></li> <li><a class="dropdown-item" href="/principles/fp-006-textual-definitions.html">Textual Definitions (principle 6)</a></li> <li><a class="dropdown-item" href="/principles/fp-007-relations.html">Relations (principle 7)</a></li> <li><a class="dropdown-item" href="/principles/fp-008-documented.html">Documentation (principle 8)</a></li> <li><a class="dropdown-item" href="/principles/fp-009-users.html">Documented Plurality of Users (principle 9)</a></li> <li><a class="dropdown-item" href="/principles/fp-010-collaboration.html">Commitment To Collaboration (principle 10)</a></li> <li><a class="dropdown-item" href="/principles/fp-011-locus-of-authority.html">Locus of Authority (principle 11)</a></li> <li><a class="dropdown-item" href="/principles/fp-012-naming-conventions.html">Naming Conventions (principle 12)</a></li> <li><a class="dropdown-item" href="/principles/fp-013-notification.html">Notification of Changes (principle 13)</a></li> <li><a class="dropdown-item" href="/principles/fp-016-maintenance.html">Maintenance (principle 16)</a></li> <li><a class="dropdown-item" href="/principles/fp-020-responsiveness.html">Responsiveness (principle 20)</a></li> </ul> </li> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarOntologiesDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Ontologies </a> <ul class="dropdown-menu" aria-labelledby="navbarOntologiesDropdown"> <li><a class="dropdown-item" href="/">Ontology Table</a></li> <li><a class="dropdown-item" href="/id-policy.html">ID Policy</a></li> <li><a class="dropdown-item" href="http://dashboard.obofoundry.org/dashboard/index.html">OBO Dashboard</a></li> <li> <hr class="dropdown-divider"> </li> <li> <a class="dropdown-item" href="https://github.com/OBOFoundry/OBOFoundry.github.io/tree/master/ontology"> Ontologies Metadata Source </a> </li> <li> <a class="dropdown-item" href="https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/registry/"> Combined Metadata </a> </li> <li> <a class="dropdown-item" href="http://purl.obolibrary.org/meta/obo_context.jsonld"> JSON-LD 1.1 Context </a> </li> <li> <a class="dropdown-item" href="http://purl.obolibrary.org/meta/ontologies.yml"> Ontology YAML </a> </li> <li> <a class="dropdown-item" href="http://purl.obolibrary.org/meta/ontologies.jsonld"> Ontology JSON-LD </a> </li> <li> <a class="dropdown-item" href="http://purl.obolibrary.org/meta/ontologies.ttl"> Ontology RDF/Turtle </a> </li> </ul> </li> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarCitationDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Citation </a> <ul class="dropdown-menu" aria-labelledby="navbarCitationDropdown"> <li><a class="dropdown-item" href="/citation/Citation.html">Cite Ontologies</a></li> <li><a class="dropdown-item" href="/citation/RelatedPublications.html">OBO Foundry Publications</a></li> <li><a class="dropdown-item" href="/citation/KnownPublications.html">Known OBO Foundry Ontology Publications</a></li> </ul> </li> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarParticipateDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Participate </a> <ul class="dropdown-menu" aria-labelledby="navbarParticipateDropdown"> <li> <a class="dropdown-item" href="https://github.com/OBOFoundry/OBOFoundry.github.io/issues">OBO Foundry Issue Tracker</a></li> <li> <a class="dropdown-item" href="https://groups.google.com/forum/#!forum/obo-discuss">OBO-Discuss Mail List</a> </li> <li> <a class="dropdown-item" href="https://groups.google.com/forum/#!members/obo-tools">OBO-Tools Mail List</a> </li> <li> <a class="dropdown-item" href="https://join.slack.com/t/obo-communitygroup/shared_invite/zt-1oq48ttk7-kKo0i6TwntYtAq~Jcjjg4g">OBO Community Slack channel</a> </li> <li> <a class="dropdown-item" href="/docs/NewOBOFC.html">Join the OBO Operations Committee</a> </li> <li> <a class="dropdown-item" href="/faq/how-do-i-register-my-ontology.html">Submit your ontology</a> </li> </ul> </li> <li class="nav-item dropdown"> <a class="nav-link dropdown-toggle" href="#" id="navbarNewsletterDropdown" role="button" data-bs-toggle="dropdown" aria-expanded="false"> Newsletter </a> <ul class="dropdown-menu" aria-labelledby="navbarNewsletterDropdown"> <li><a class="dropdown-item" href="/newsletter/2024/10/14/6th-issue-newsletter.html">OBO Foundry Newsletter Issue 6</a></li> <li><a class="dropdown-item" href="/newsletter/2024/06/27/5th-issue-newsletter.html">OBO Foundry Newsletter Issue 5</a></li> <li><a class="dropdown-item" href="/newsletter/2024/03/18/4th-issue-newsletter.html">OBO Foundry Newsletter Issue 4</a></li> <li><a class="dropdown-item" href="/newsletter/2023/12/18/3rd-issue-newsletter.html">OBO Foundry Newsletter Issue 3</a></li> <li><a class="dropdown-item" href="/newsletter/2023/09/15/second-issue-newsletter.html">OBO Foundry Newsletter issue 2</a></li> <li><a class="dropdown-item" href="/newsletter/2023/06/16/inaugural-newsletter.html">Inaugural OBO Foundry Newsletter</a></li> </ul> </li> <li class="nav-item"> <a class="nav-link" href="/faq/index.html">FAQ</a> </li> </ul> </div> </div> </nav> <div class="container" style="margin-top: 2em; margin-bottom: 2em;"> <div class="content"> <div> <div class="page-header"> <h1> Principle: Notification of Changes (principle 13) </h1> <p></p> </div> </div> <div class="col-md-12"> <div class="row"> <div class="col-md-3"> <ul> <li> <a href="fp-000-summary.html">Overview</a> </li> <li> <a href="fp-001-open.html">Open (principle 1)</a> </li> <li> <a href="fp-002-format.html">Common Format (principle 2)</a> </li> <li> <a href="fp-003-uris.html">URI/Identifier Space (principle 3)</a> </li> <li> <a href="fp-004-versioning.html">Versioning (principle 4)</a> </li> <li> <a href="fp-005-delineated-content.html">Scope (principle 5)</a> </li> <li> <a href="fp-006-textual-definitions.html">Textual Definitions (principle 6)</a> </li> <li> <a href="fp-007-relations.html">Relations (principle 7)</a> </li> <li> <a href="fp-008-documented.html">Documentation (principle 8)</a> </li> <li> <a href="fp-009-users.html">Documented Plurality of Users (principle 9)</a> </li> <li> <a href="fp-010-collaboration.html">Commitment To Collaboration (principle 10)</a> </li> <li> <a href="fp-011-locus-of-authority.html">Locus of Authority (principle 11)</a> </li> <li> <a href="fp-012-naming-conventions.html">Naming Conventions (principle 12)</a> </li> <li> <a href="fp-013-notification.html">Notification of Changes (principle 13)</a> </li> <li> <a href="fp-016-maintenance.html">Maintenance (principle 16)</a> </li> <li> <a href="fp-020-responsiveness.html">Responsiveness (principle 20)</a> </li> </ul> <div class="btn-group" role="group" aria-label="Source"> <a href="https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/principles/fp-013-notification.md" > <button type="button" data-toggle="tooltip" title="See FAQ entry: How I do propose edits to principles?" html="true" class="btn btn-outline-primary" > View </button> </a> <a href="https://github.com/OBOFoundry/OBOFoundry.github.io/edit/master/principles/fp-013-notification.md" > <button type="button" data-toggle="tooltip" title="See FAQ entry: How I do propose edits to principles?" html="true" class="btn btn-outline-primary" > Edit </button> </a>  </div> <div> This page is generated via <a href="https://github.com/OBOFoundry/OBOFoundry.github.io/blob/master/_layouts/principle.html" >_layouts/principle.html</a >. See <a href="/faq/how-do-i-edit-content.html">edit guide</a> </div> </div> <div class="col-md-9"><p>GO TO: <a href="#recommendations-and-requirements">Recommendations/Requirements</a> | <a href="#implementation">Implementation</a> | <a href="#examples">Examples/Counter鈥慐xamples</a> | <a href="#criteria-for-review">Criteria聽for聽Review</a> | <a href="#feedback-and-discussion">Feedback/Discussion</a></p> <h2 id="summary">Summary</h2> <p>Ontologies SHOULD announce major changes to relevant stakeholders and collaborators ahead of release.</p> <h2 id="purpose">Purpose</h2> <p>To maintain the reliability of an ontology for stakeholders, advance announcement of upcoming changes鈥揳s opposed to giving after-the-fact notice (or none at all)鈥搃s crucial. Such announcement will provide stakeholders an opportunity for input on upcoming changes, and will allow updates to any dependencies (e.g., terms, annotations, ontologies) affected by those changes.</p> <h2 id="recommendations-and-requirements">Recommendations and Requirements</h2> <p>Ontology owners SHOULD, in accordance with this principle, pre-announce changes to a primary group of users who actively monitor the ontology and its changes, for example, via a mailing list (ontology-specific or more general, as deemed suitable), a social media group (relevant to the ontology), or via announcements on a home page or elsewhere. The lead time for announcements can be determined according to release lifecycles of major ontology applications and is expected to vary by domain.</p> <p>The kinds of changes that might warrant a pre-announcement include (but are not limited to):</p> <ul> <li><i><b>Planned obsoletions.</b></i> Terms that will be made obsolete. Such announcements can provide users the opportunity to intervene if necessary.</li> <li><i><b>Major hierarchy rearrangements.</b></i> Moving branches from one point in the hierarchy to another, especially large branches affecting many terms or those close to the top of the hierarchy.</li> </ul> <p>Term additions and small hierarchy changes are not expected to need pre-announcement but doing so is not prohibited.</p> <h2 id="implementation">Implementation</h2> <p>The need for notification of changes鈥揳nd the time frame in which notifications are made鈥搒hould be based on the granularity of the changes and their potential impact (for example, changes to low-level terms are likely not as impactful as those to high-level terms). Types of changes that might benefit from notification include term obsoletions, term modifications, new terms, and any others that are determined with stakeholder benefit in mind. Announcments can be concise or verbose, and SHOULD be made a minimum of 7 days in advance of the release in which the changes take effect.</p> <p>The following are possible avenues for notification:</p> <ul> <li>Submission of a GitHub ticket announcing the change</li> <li>Announcement made via social media (Twitter, Facebook, Slack, etc)</li> <li>Announcement made via general or ontology-specific mailing list</li> <li>Announcement of pending changes made as a GitHub pre-release</li> <li>Change log or release note, if published in advance</li> </ul> <p>It is expected that announcements include links to where discussions or questions can be directed.</p> <h2 id="examples">Examples</h2> <ul> <li>GitHub issue: https://github.com/geneontology/go-announcements/issues/275</li> <li>Social media (Twitter): https://twitter.com/diseaseontology/status/1301907848625033216</li> <li>Mailing list announcement (general): https://groups.google.com/g/obo-discuss/c/RrCF5f9FRC4/m/nEVwLqN5CQAJ</li> <li>Mailing list announcement (ontology-specific): https://groups.google.com/g/obi-users/c/wweskCfHbSc</li> <li>GitHub pre-release: https://github.com/obi-ontology/obi/pull/1558</li> <li>Advance release note: https://proconsortium.org/download/release_55.0/pro_release_note.txt</li> </ul> <h2 id="counter-examples">Counter-Examples</h2> <p>The following mechanisms, while useful, do not fulfill the recommendations herein since they occur concurrently with the changes of interest:</p> <ul> <li>Announcement of changes in a release note when that note is for the same release as that in which the change first appears</li> <li>A change log that is not published in advance</li> </ul> <h2 id="criteria-for-review">Criteria for Review</h2> <p>Notification of changes SHOULD be published prior to a new release version of the Ontology. The period between publishing the changes and the release date must be no less than 7 days but can be longer (based upon agreement between ontology developers and users).</p> <h2 id="feedback-and-discussion">Feedback and Discussion</h2> <p>To suggest revisions or begin a discussion pertaining to this principle, please <a href="https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?labels=attn%3A+Editorial+WG,principles&title=Principle+%2313+%22Notification%22+%3CENTER+ISSUE+TITLE%3E">create an issue on GitHub</a>.</p> <p>To suggest revisions or begin a discussion pertaining to the automated validation of this principle, please <a href="https://github.com/OBOFoundry/OBOFoundry.github.io/issues/new?labels=attn%3A+Technical+WG,automated+validation+of+principles&title=Principle+%2313+%22Notification%22+-+automated+validation+%3CENTER+ISSUE+TITLE%3E">create an issue on GitHub</a>.</p> </div> </div> </div> </div> </div><footer class="footer"> <p class="small text-center text-muted"> 漏 2024 OBO Technical WG </p> </footer> <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.2/dist/js/bootstrap.bundle.min.js"></script>  <script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/prism.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/prismjs@1.29.0/plugins/autoloader/prism-autoloader.min.js"></script> </body> </html>

CINXE.COM

OBO Foundry