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

Why don't you capitalize the readme filename in your repositories? #197

Closed
ghost opened this Issue Jul 29, 2015 · 3 comments

Comments

2 participants
@ghost

ghost commented Jul 29, 2015

No description provided.

@sindresorhus

This comment has been minimized.

Owner

sindresorhus commented Jul 29, 2015

Aesthetics. It looks better lowercased. And there's no longer any practical reason to uppercase it.

@fvgs

This comment has been minimized.

fvgs commented May 2, 2017

And there's no longer any practical reason to uppercase it

I arrived at the same conclusion regarding aesthetics when considering the presentational merits of all-uppercase vs. first-letter-uppercase vs. all-lowercase. However, I find the practical reason for uppercasing at least the first letter of meta files (e.g. readme, license, contributing) is so when the files are listed in a terminal or GitHub, the meta files will be listed before non-meta files (package.json, yarn.lock, other config files, etc.). Thus, they end up partitioned, which imo enhances the presentation and ease with which one can scan the contents of the repo. That's why I uppercase mine.

I pose the following question dialectically: Do you not consider the above reason to have sufficient practical merit, or is there instead a nuance I'm not considering?

@sindresorhus

This comment has been minimized.

Owner

sindresorhus commented May 2, 2017

Sure, you get them listed first on GitHub, but they also steal all the attention because of being all uppercase, when most of them are not important. This also only solves the problem for your own repos. Instead, I just made a Chrome extension that hides unimportant files. (It says it's for dotfiles, but I use it for many other files too). Here's the regex I use: ^\.|^license|^appveyor\.yml$|^yarn\.lock$|^screenshot(?:-\w)*\.png$|^circle\.yml$|^codecov\.yml$|^contributing\.md$|\.sublime-project$|^lerna\.json$|^gulpfile\.js$|^makefile$

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment