CONTRIBUTING.md

Contributing to submission-schema

👍 First of all: Thank you for taking the time to contribute!

The following is a set of guidelines for contributing to submission-schema. These guidelines are not strict rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

• Code of Conduct
• Guidelines for Contributions and Requests
  • Reporting problems with the data model
• Development
  • Building the schema YAML file
  • Building the project artifacts
  • Automated testing
  • Interactive testing

Code of Conduct

The submission-schema team strives to create a welcoming environment for editors, users and other contributors. Please carefully read our Code of Conduct.

Guidelines for Contributions and Requests

Reporting problems with the data model

Please use our Issue Tracker for reporting problems with the ontology.

Development

Building the schema YAML file

TODO

Building the project artifacts

TODO

Automated testing

TODO

Interactive testing

An interactive DataHarmonizer-based interface is provided in the data_harmonzier directory. To start the interface locally run:

make dh-dev

This interface relies on the project/json/nmdc_submission_schema.json artifact. Therefore this file will be rebuilt if needed, and then a local development server will be started. Once startup is complete you should see a message indicating that the interface is ready on http://127.0.0.1:5173.

Let this command continue to run in the background while you're developing and testing. The interface will automatically reload when changes to project/json/nmdc_submission_schema.json are detected, for example as a result of running

make project/json/nmdc_submission_schema.json

This interface is automatically built and deployed along with the docs with every commit to main.