Updated example of file naming version control#30
Open
kbriney wants to merge 1 commit intodatacarpentry:gh-pagesfrom
Open
Updated example of file naming version control#30kbriney wants to merge 1 commit intodatacarpentry:gh-pagesfrom
kbriney wants to merge 1 commit intodatacarpentry:gh-pagesfrom
Conversation
Updated example of version control via file naming so that the file names have the same root in common ("manuscriptFish") with the date afterward, showing that the files are the related version of the same content but from different dates.
hlapp
reviewed
Sep 14, 2024
| 2014-03-14_manuscriptFish_PLOSpublished.doc | ||
| manuscriptFish_2013-10-14.doc | ||
| manuscriptFish_2013-10-30.doc | ||
| manuscriptFish_2013-11-05_intitialRyanEdits.doc |
Contributor
There was a problem hiding this comment.
Perhaps worth using the opportunity to fix the typo:
Suggested change
| manuscriptFish_2013-11-05_intitialRyanEdits.doc | |
| manuscriptFish_2013-11-05_initialRyanEdits.doc |
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
2 participants
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.
Hi!
I'm proposing a change to improve the version control example that uses file naming so that the example file names all have the same root ("manuscriptFish"). Having the same root/beginning of the file name shows that the files are related, with the appended date information showing what the major difference is between the versions. When you put date first in the file name, it makes it seem like the date is the most important thing about this set of files and then that they all happen to be on the same topic. Basically, content information should go first with version information second so that the files sort properly if mixed in with other files.
That said, I love the use of ISO 8601 on the date formatting in these file names. What a great example of how using YYYY-MM-DD makes your files sort chronologically!
Thanks,
Kristin