Skip to content
 
 

Latest commit

 

History

10 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CEDS Elements Logo

CEDS Elements

The Common Education Data Standards (CEDS) are an education data management initiative whose purpose is to streamline the understanding of data within and across P-20W institutions and sectors. CEDS includes a common vocabulary complete with standard element names, definitions, and option sets. This repository contains all the CEDS elements, definitions, option sets and their definitions, and entities and definitions. Its purpose is to expand that vocabulary to meet the needs of every education stakeholder. The expanded vocabulary is then added to the CEDS Integrated Data Store and CEDS Data Warehouse as appropriate.

Getting Started

In this repository, there are seven things that can occur:

  1. A new element with definition and possibly option sets is proposed.
  2. A new option set to be added to an existing element is proposed.
  3. A change to an element name is proposed.
  4. A change to an element definition is proposed.
  5. A change to an option set code is proposed.
  6. A change to an option set description is proposed.
  7. A change to an option set definition is proposed.

To propose any of these changes, the Use Case Template must be completed. Note that changes to element names and option set codes result in a breaking change to the standard and require solid reasoning for the change. Changes to definitions and descriptions, as long as they don’t change the existing meaning, are not considered breaking changes. New elements and option sets are also not considered breaking changes.

Prerequisites

Adding New Elements – before proposing new elements, the following steps should take place:

  1. Verify the element does not exist in CEDS under a different name. This can be done by going to the Domain Entity Schema and searching for elements by various domains and entities. This can also be done by going to the Elements search and trying different variations of the element name and possible words that may appear in a definition about the element.
  2. Check with existing education standards to see if the element exists in their standard. CEDS is committed to using already existing standard elements and definitions when adding to the CEDS standard. If the element you need exists in one or more of those standards, indicate that information in the Use Case. Here are some standards to review:

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use a customized version of Explicit Versioning for versioning. To keep the various CEDS Open Source projects in alignment with the CEDS Elements, we are replacing the concept of "disruptive" releases with "alignment" releases. These releases ensure that the data models are in sync with the official, community approved list of CEDS Elements. For the versions available, see the tags on this repository.

About

The Common Education Data Standards (CEDS) are an education data management initiative whose purpose is to streamline the understanding of data within and across P-20W institutions and sectors. CEDS includes a common vocabulary complete with standard elements names, definitions, and option sets. This repository contains all the CEDS elements, defi…

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors