Skip to content

GenX Data Model - fill out data schema sheet #11

Description

@github-actions

Tool

Tool / Schema Name: GenX Data Model
YAML file: data_schemas/genx_data_model.yaml
Assigned to:


Instructions for the Tool Owner

Your tool already has a placeholder YAML file in data_schemas/. Please fill
it out and submit a Pull Request. Pick the option below that fits your access
level.

Option A — Fork & Pull Request (external contributors)

  1. Fork this repository (click Fork at the top-right of the page).
  2. In your fork, open the file listed above (e.g.,
    data_schemas/sienna_data_model.yaml).
  3. Replace every <...> placeholder with real information.
    Use ~ (YAML null) for fields that don't apply.
  4. Commit your changes and push them to your fork.
  5. Open a Pull Request from your fork back to the main branch of this
    repository. Title it: Fill out data schema sheet: GenX Data Model.
  6. Link this issue in your PR description (paste the issue URL).

Option B — Branch & Pull Request (contributors with write access)

  1. Create a new branch from main:
    git checkout main && git pull
    git checkout -b fill-schema/genx-data-model
  2. Edit the placeholder file:
    # e.g., open data_schemas/sienna_data_model.yaml in your editor
  3. Replace every <...> placeholder, then commit and push:
    git add data_schemas/genx_data_model.yaml
    git commit -m "Fill out data schema sheet: GenX Data Model"
    git push origin fill-schema/genx-data-model
  4. Open a Pull Request on GitHub targeting main.
    Link this issue in your PR description.

After Opening the PR

  • A maintainer will review your sheet and may leave questions as PR comments.
  • Address comments by pushing additional commits to the same branch/fork.
  • Once approved the sheet is merged and this issue is closed.

YAML Linting

CI will lint your file automatically. To check locally before pushing:

pip install yamllint
yamllint -c .yamllint.yaml data_schemas/genx_data_model.yaml

Questions? Comment on this issue.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    fill-out-schemaFill out existing tool data schema sheet

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions