Provide a SARIF v2.2 Seed Prose by Transcribing the v2.1.0 Errata 01 Prose to Markdown - Githubissues

oasis-tcs / sarif-spec

OASIS SARIF TC: Repository for development of the draft standard, where requests for modification should be made via Github Issues

https://github.com/oasis-tcs/sarif-spec

Other

167 stars 47 forks source link

Provide a SARIF v2.2 Seed Prose by Transcribing the v2.1.0 Errata 01 Prose to Markdown #581

Open sthagen opened 1 year ago

sthagen commented 1 year ago

Work in progress at https://github.com/sthagen/oasis-tcs-sarif-spec/blob/versioned-spec-folders/sarif-2.2/prose/sarif-v2.2-editor-draft.md (in fork)

Using some fresh markdown boilerplate to fill in a best effort transcription of the SARIF v2.1.0-os-errata-01 candidate prose.

We may want to refactor or change some "things" of the 2.1 era to ease future work (and reading):

reduce the linkage (there are approx. 1400 §#.#.# links for a tad more than 200 pages which makes on the average 7 such opaque links per page) and make more links have a "speaking" link text
externalize the JSON examples as example files (inside the /sarif-2.2/example/ folder)
explicitly name all artifacts on file level
rewrite tables with two columns as definition lists
migrate to two slot versioning (2.2) for the spec
...

schlaman-ms commented 1 year ago

Document location for issue:

Generic issue - no specific location.