ioos / ioos/bio_data_guide

GHA for Darwin Core quick check?

Open
#85 13 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

iooscodesprint question
Dominant language
Jupyter Notebook
Stars
55
Forks
24
PR merge metrics
No merged PRs in 30d

Description

Would folks find it useful if we set up a GitHub Action that does a preliminary review of Darwin Core files?
For example, a data manager sends in a PR with an event, occurrence, and/or emof file in a directory called data/processed . Then, the Action would pull in those files and do some initial checks (headers are valid, gives some summary statistics, other basic checks...) and do something with the results (save a summary file, throw an error...).

Just trying to make the IPT managers lives a little easier as some of the issues I've seen could have been resolved earlier in the process with a simple checker.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the proposed data/processed directory and the event, occurrence, and emof file types described in the issue. Define which header checks, summary statistics, and failure or summary-file behavior are required for the GitHub Action. Done means the desired checks and result handling are agreed and documented well enough to implement.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, data-engineering
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.