Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

64 lines (50 loc) · 3.13 KB
Raw

Guidelines for contributing

HED (Hierarchical Event Descriptors) is an open community and contributions to all aspects of HED are welcome. All HED repositories are housed in the hed-standard GitHub organization. The HED Working Group meets regularly to oversee the development of HED and its ecosystem. If you would like to join the HED Working Group or wish to contact them directly please email mailto:[email protected].

Most contributions to HED are initiated through the GitHub issue mechanism. Here are suggested approaches for contributions in various categories.

New term to existing schema

To propose a new term for a HED schema, post issue to hed-schemas listing (as much as possible):

  • the schema,
  • term
  • potential parent
  • background and reasons
  • links to existing similar terms in other ontologies or vocabularies
  • examples of usage

Corrections to existing term

To propose corrections/changes to description, attributes, units allowed, value classes for an existing term post an issue to hed-schemas. List:

  • the schema,
  • term
  • change details
  • background and reasons

Deprecation of a term is a more major change and requires much additional consideration.

Propose a new HED library schema

To propose a new HED vocabulary for a subfield, post an issue to hed-schemas indicating your interest. List:

  • the proposed name of the schema
  • the subfield
  • the need for the vocabulary
  • how it relates to the standard schema and other library schemas
  • proposer group members
  • email mailto:[email protected] with contact information.

You should also read over the HED schema developer's guide. The HED Working Group will arrange a meeting to discuss the development of the library schema.

Corrections to documentation and bug reports

Corrections and documentation can be posted to hed-schemas, and they will be forwarded to the correct repository.

However, here is a list of the issue trackers for various items:

Problem source Issue tracker
General hed-schemas
Homepage https://github.com/hed-standard/hed-standard.github.io/issues
Python tools https://github.com/hed-standard/hed-python/issues
Documentation https://github.com/hed-standard/hed-examples/issues
Matlab tools https://github.com/hed-standard/hed-matlab/issues
HED/BIDS validator https://github.com/hed-standard/hed-javascript/issues