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
166 stars 47 forks source link

Reset and Simplify the Revision History #637

Closed sthagen closed 3 months ago

sthagen commented 4 months ago

The revision history in the specification has become an elaborated document in itself.

Also, because of the long sequence of minimal changes, the value for the reader seams to not match the volume of the content.

In addition, we changed the format of the specification source to be easily comparable across commits / revisions for everyone (as compared to the large word file we used before).

Last, but not least, we should cut the revision history to start with the changes following the v2.1.0 Errata 01 status.

Proposal

Simplify the revision history and remove all entries that point to v2.1.0 Errata 01 or earlier revisions.

sthagen commented 4 months ago

Rewrite the revision history appendix as:

<!--
---
toc:
  auto: false
  label: (Informative) Revision History
  enumerate: Appendix L.
---
-->
# (Informative) Revision History

| Revision                  | Date       | Editors                                      | Description                                                                      |
|:--------------------------|:-----------|:---------------------------------------------|:---------------------------------------------------------------------------------|
| sarif-v2.2-wd20240502-dev | 2024-05-02 | Craig Schlaman, Stacy Wray, and Stefan Hagen | Initial version 2.2.0, transcribed from v2.1.0 Errata 01 with minor corrections. |
| sarif-v2.2-wd20240605-dev | 2024-06-05 | Stacy Wray and Stefan Hagen.                 | Monthly editor revision including issues 471 and 637.                            |

Rendered similar to:

Appendix L. (Informative) Revision History

Revision Date Editors Description
sarif-v2.2-wd20240502-dev 2024-05-02 Craig Schlaman, Stacy Wray, and Stefan Hagen Initial version 2.2.0, transcribed from v2.1.0 Errata 01 with minor corrections.
sarif-v2.2-wd20240605-dev 2024-06-05 Stacy Wray and Stefan Hagen. Monthly editor revision including issues 471 and 637.
stacywray commented 4 months ago

@sthagen Hello! My name is spelled Stacy (no e). Thanks!

sthagen commented 4 months ago

@stacywray sure, sorry for that.

sthagen commented 3 months ago

Implemented per #638.