docs: create CITATION.cff #905
Conversation
|
LGTM but I'm not much familiar with that data, @semver/maintainers could someone double-check it? |
|
A couple of thoughts:
|
|
@steveklabnik thank you for sharing. how can your second point be verified? |
|
Oopse, didn't see this merge request... Merging this fixes #912 |
This can get pretty hairy as there's some work going back in time and appropriately crediting folks who contributed to the work. I think ideally creating a 1.0 branch and adding These extra commits wouldn't need to be pushed to the site as no real change in the spec was created. Maybe the new branches would exist such that no significant change would be made to the spec document just supporting informational files can be updated or added? |
|
Maybe, there's some answers in the meta conversation. How does semantic versioning apply to the content of this repository? |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
|
Hi semver team, Looking for an update- is there anything preventing this PR from being merged? |
|
You'll find links to specific versions of the spec at the top of the https://semver.org/ page. https://semver.org/spec/v2.0.0.html is the current version. All of the clauses in the spec have flyover links just to the left of the clause number. Unfortunately, the maintainers are in the habit of updating version 2 without adding any version bumps. There are tags in both of the repos: But their content hashes are different, so there's no way at this time to provide any good references to the spec beyond using full quotes of the text, plus a reference to whatever repo content hash you took the quote from. In other words, the content published at https://semver.org/ does not have any stable reference available and will not have any without making publication process changes. I recommend you pull the repo, spelunk to whatever version of the text you're interested in, and reference that content hash. |
There have been some threads regarding the fact that the published spec does not hone to the SemVer versioning scheme. There have also been some comments in PR threads pondering whether to bump the version. I think it did followed its own advice back in the 1.y.z days, but after 2.0.0 was moved over from mojombo's repo, that practice stopped. There have been considerable added features and textual fixes ever since then, mostly in the FAQ, intro and I think a few of the examples, but some clarifications to the text clauses themselves IIRC. I am pretty sure that the site is published from the https://semver/semver.org repo, or at least it used to be. #407 http://semver.org/ differ from semver.md, but both are 2.0.0 |
|
I don't know much about the citation file but could we add the group to the authors section like "The SemVer maintainers and contributors"? If so, I think it resolves some of the concerns @steveklabnik raised. |
Closes #912
Hello! 馃憢
I'm a university student and I recently composed a written report & verbal presentation that directly referenced the Semantic Versioning Specification. As is customary in academia, I was expected to cite my sources in a way that conformed with a particular English formatting and style guide. I looked through both https://github.com/semver/semver and https://github.com/semver/semver.org, but could find no written documentation indicating how to properly cite the SemVer spec in my paper. The closest I came was to discovering issue #357 from 2017, which references a Google Scholar link that has since been removed.
GitHub directly supports repository citation files that conform to the Citation File Format standard. Adding a
CITATION.cfffile to the root of a repository will cause a "Cite this repository" link to appear under the repo description:Clicking on the text will render a dropdown with a brief message about repository citations, and different formatting options that the viewer can use to cite the repo:
My PR creates a
CITATION.cffwith information about the original SemVer author, along with the recorded release date of v2.0.0 (according to https://github.com/semver/semver/releases/tag/v2.0.0). Please let me know if any changes should be made to the citation metadata, such as the addition of other authors.