Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include date and/or version in Bylaws #36

Open
hlapp opened this issue Oct 5, 2016 · 6 comments
Open

Include date and/or version in Bylaws #36

hlapp opened this issue Oct 5, 2016 · 6 comments

Comments

@hlapp
Copy link
Member

hlapp commented Oct 5, 2016

It would be useful, I think, to be able to identify documents floating around somewhere as to which version of the Bylaws they represent. Right now, the only way to identify that is by comparison of the text.

Or perhaps we can start with publishing MD5 checksums?

@peterjc
Copy link
Member

peterjc commented Oct 5, 2016

Version numbers make sense, plus a changes section (at the end of the file?) which ideally we'd back date for the recent revisions (joining SPI and the minor changes at the October 2016 board meeting).

Were you suggesting MD5 (and/or SHA256) checksum of the MarkDown files? That ought to be stable while the HTML/PDF/etc would not be.

@hlapp
Copy link
Member Author

hlapp commented Oct 5, 2016

Were you suggesting MD5 (and/or SHA256) checksum of the MarkDown files? That ought to be stable while the HTML/PDF/etc would not be.

What I had in mind was for each of them. Why would HTML and PDF be less stable than the MD (for the purposes of verifying whether one has the exact same file as is posted in the repo)?

@peterjc
Copy link
Member

peterjc commented Oct 5, 2016

Because rebuilding the document is likely to give different output (e.g. version of pandoc changed), but if you mean recording the checksum as committed that could work.

I think versioning is more important than checksums and should be prioritised.

@nlharris
Copy link
Member

Did this ever get done? Can we just add "Last updated" dates to these docs as a simple solution?

@peterjc
Copy link
Member

peterjc commented Jan 27, 2023

+1 on last date stamp of latest content change (i.e. would not need to be changed for things like rebuilding the HTML/PDF).

I'd be fine with adding that to the current version as a footnote without formal membership approval (just a PR with board approval seems enough).

@hlapp
Copy link
Member Author

hlapp commented Jan 28, 2023

I'd be fine with adding that to the current version as a footnote without formal membership approval (just a PR with board approval seems enough).

I agree, this wouldn't be changing the text of the bylaws themselves.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants