Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 2.69 KB

CONTRIBUTING.md

File metadata and controls

52 lines (37 loc) · 2.69 KB
Raw

Contributing

Introduction

This manual is a living document that improves with the contribution of others. In order to be exhaustive, data modalities need to be added as they are identified. There are many ventures, projects, and data streams that are valuable to ETI and deserve to be included. Readers are encouraged to add missing information if they believe something should be added.

Please note that development of this manual occurs on a private copy of the repository. In order to contribute to manual changes, access must be requested and granted to the private repository. This is because review of changes are required before being publicly disseminated. Since this manual exists on GitHub, there are several methods for contribution. This repository can be forked, edited, and contributors can send pull requests for review. Alternatively, issues can be raised for identifying errors. For more information on collaborating with GitHub, please refer to the GitHub help page.

How to contribute

The following instructions provide details on how to add content to the manual:

  1. Request access to edit the private repository. Development occurs here to allow for programmatic review of information before public dissemination. Access is granted by first filling out the form here.

  2. Make a fork of the private repository.

  3. Create a branch off main, which should be up-to-date with the currently published version of the manual.

  4. Make your contributions to the branch:

    • Make sure to add a row to the data table, where each modality is marked with an x.

    • If the data source introduces a new modality, add that column to the data table. Then, add a section in Data Modes briefly describing the type of data.

    • Add a section to Data Streams describing the data source. This should include links to documentation for the source, how the source was collected, and any expectations for data use.

    • If the addition is a multi-modal data set. Make a separate markdown page detailing the project or venture as a whole. See MINOS.md for an example.

  5. Commit and push your changes.

  6. Create a pull request for your changes and it will be reviewed!