Implement versioning of DCAS

[korenmiklos]

No description provided.

[larsvilhuber]

This is not just for journals. It's just good practice ;)

[larsvilhuber]

Suggestion:

• adopt Semantic versioning https://semver.org/
• each major version is its own "category", which generates a "subdirectory", e.g, datacodestandard.org/v1
• creating a new version means creating a new category, and copying all files there.
• minor versions should be hard-coded (a decision made), and configured in _data/v1.yml or something like that.
• patches are automatically generated by the converting the date into a string

[larsvilhuber]

Note: we need to separately define what's get versioned. There will be additional endorsers. The endorsement page should likely be included in the archived version, get a patch number - but should it also be archived on Zenodo with a new DOI?

One thought is that endorsements are collected on a quarterly basis, and then archived, but a V1.0 is referenced on Zenodo by the same "master" DOI. Minor versions create a new "master" DOI at Zenodo.

Thoughts?

[korenmiklos]

I agree on SemVer. Decide

1. what gets versioned
2. what are major, minor, patch revisions
3. what user see.

Implementation can follow. My suggestions:

1. Only text of standard: rules.csv. Not journal list, not explainers. So that versions change infrequently and many journals can join 1.0.
2. Major revision: if you comply with 1.x, you may not comply with 2.x. Basically, where severals journals could say "I did not sign up for this." Minor revision: Changes in rule numbering, clarification etc, but without breaking compliance. Like changing where we talk about omissions or adding a rule that only clarifies existing criteria. 1.0 -> 1.1 may create some small confusion for authors checking the site ("wasn't this rule 16?") but nothing that endangers compliance. Patch: language edits, fixing typos, but holding the structure of rules.csv constant.
3. The URL https://datacodestandard.org resolves to the lates version. https://datacodestandard.org/v1 or https://datacodestandard.org/v1.0 point to specific versions. Only the most recent patches are not displayed, with maybe a list of version history. Zenodo is updated with minor revisions, not with patches.

[larsvilhuber]

Sounds fine to me. (This is not something for Release 1.0). Patch version should be displayed, can correspond to the commit (short version). Needs a document/page to describe this. Also needs implementation (preferably code) to do the versioning to URL/v1 = v1.0 in the displayed HTML, preferably linked to Github versions. The plumbing can get complicated there.

…

-- Lars Vilhuber, Economist Cornell University p: +1.607-330-5743 https://calendly.com/larsvilhuber My working day may not be your working day. Please respond during your working day.

________________________________ From: Miklós Koren ***@***.***> Sent: Thursday, December 15, 2022 05:07 To: social-science-data-editors/DCAS ***@***.***> Cc: Lars Vilhuber ***@***.***>; Comment ***@***.***> Subject: Re: [social-science-data-editors/DCAS] Implement versioning of DCAS (Issue #5) I agree on SemVer. Decide 1. what gets versioned 2. what are major, minor, patch revisions 3. what user see. Implementation can follow. My suggestions: 1. Only text of standard: rules.csv. Not journal list, not explainers. So that versions change infrequently and many journals can join 1.0. 2. Major revision: if you comply with 1.x, you may not comply with 2.x. Basically, where severals journals could say "I did not sign up for this." Minor revision: Changes in rule numbering, clarification etc, but without breaking compliance. Like changing where we talk about omissions or adding a rule that only clarifies existing criteria. 1.0 -> 1.1 may create some small confusion for authors checking the site ("wasn't this rule 16?") but nothing that endangers compliance. Patch: language edits, fixing typos, but holding the structure of rules.csv constant. 3. The URL https://datacodestandard.org resolves to the lates version. https://datacodestandard.org/v1 or https://datacodestandard.org/v1.0 point to specific versions. Only the most recent patches are not displayed, with maybe a list of version history. Zenodo is updated with minor revisions, not with patches. — Reply to this email directly, view it on GitHub<#5 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/ABVSQ6HZJSCBSVUHLURNOK3WNLUUVANCNFSM6AAAAAASUO4534>. You are receiving this because you commented.Message ID: ***@***.***>

[korenmiklos]

I am happy to work on the plumbing!