GenomicsStandardsConsortium / mixs

Minimum Information about any (X) Sequence” (MIxS) specification
https://w3id.org/mixs
Creative Commons Zero v1.0 Universal
36 stars 21 forks source link

work in progress: YAML linting and auto-formatting super-issue #823

Open turbomam opened 1 month ago

turbomam commented 1 month ago

or add a documentation file to the repo?

turbomam commented 1 month ago

@sujaypatil96 just merged

That is intended to illustrate a pattern we should all be working on together

  1. removing blocks in .yamllint that allow for non-standard-ish YAML file formats
  2. ensuring that mixs.yaml will pass the YAML linting process even after removing the block that had tolerated something non-standard-ish

Hopefully we will work together to continue removing the exceptions blocks in .yamllint, so that eventually it is an empty file. We should also make the necessary changes to mixs.yaml so that is passes linting. That may involve using a tool like Google's yamlfmt, which is not bundled with the repo yet. Human review of yamlfmt may be required, too.

turbomam commented 1 month ago

So if we write a super-issue, I wouldn't recommend writing out all of the strictest YAML format specifications (becase we can link to that), but rater a workflow of the repairs process.

mslarae13 commented 2 weeks ago

Going to capture some weird documentation formatting I find here