Conversation
- Updates the `update-version.sh` script to also update the citation file with the correct version number
Member
|
Does the version number really need to be in the citation file? Chances are, someone is just citing Browsertrix in general, not a specific release.. |
Contributor
Author
|
Generally yes! It's best practice to cite a specific release when you are citing software because software changes over multiple releases. Ultimately this is up to the academic & referencing style, but including it here in the citation information means that it can be propagated to the desired reference format, whatever that may be. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
GitHub has a cool feature that lets people more easily cite your project! This is especially relevant for reference managers like Zotero which will pull this data automatically. Occasionally researchers and academics will use Browsertrix (or Browsertrix Crawler) — it would be nice for them to cite the correct tool! This (hopefully) helps them do that :)
Changes
update-version.shscript to also update the citation file with the correct version numberFuture
Could add this for Webrecorder's other repos to encourage proper software citations for Webrecorder's other work, though they don't have update scripts like Browsertrix does so this introduces extra complexity in the version number update process unless those scripts are created.