Improve file naming with advice from R4DS #243
Conversation
This file contains 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
DavisVaughan
approved these changes
Feb 19, 2025
Comment on lines
+34
to
+35
| figure-01.png | ||
| figure-02.png |
There was a problem hiding this comment.
start file names with numbers so that alphabetical sorting puts them in the order they get used
quoted from below, goes against this good example
Comment on lines
+58
to
60
| If you later realise that you've missed some steps, it's tempting to use `02a`, | ||
| `02b`, etc. However, I think it's generally better to bite the bullet and | ||
| rename all files. |
There was a problem hiding this comment.
is indentation messed up here? not sure if it affects the final result
| Microsoft Windows or OS X) which can lead to problems with (case-sensitive) | ||
| revision control systems. Prefer file names that are all lower case, and never | ||
| have names that differ only in their capitalization. | ||
| 4. Don't [tempt fate](https://phdcomics.com/comics.php?f=1531) by using "final" or similar words in file names. Instead either rely on Git to track changes over time, opr failing that put the date, formatted as year-month-day, in the file name. |
There was a problem hiding this comment.
Suggested change
| 4. Don't [tempt fate](https://phdcomics.com/comics.php?f=1531) by using "final" or similar words in file names. Instead either rely on Git to track changes over time, opr failing that put the date, formatted as year-month-day, in the file name. | |
| 4. Don't [tempt fate](https://phdcomics.com/comics.php?f=1531) by using "final" or similar words in file names. Instead either rely on Git to track changes over time, or failing that put the date, formatted as year-month-day, in the file name. |
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.
https://r4ds.hadley.nz/workflow-scripts.html#saving-and-naming