-
Notifications
You must be signed in to change notification settings - Fork 10
Reorganize files into subdirectories #18
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
Conversation
|
👍 |
|
Hey @jnrbsn. Thanks a ton for doing this. How do you feel about lowerCamelCasing file names, or dash-casing or even snake_case. I mentally reserve UpperCamelCase for things like classes and don't tend to use them for folder names/non-class files. |
|
How about we follow the same style that MediaWiki uses in URLs, like "My_Totally_Awesome_File.md" (i.e. title case with underscores in place of spaces)? |
|
I'm down down with the MW URL convention for file naming. 👍 |
|
👎 I'm not a huge fan of that, it makes autocompletion files more difficult in the CLI and generally feels like I'm combining two case styles. I'd rather The MW pattern is also double the keystrokes for delimiting word breaks. |
|
I think reading this stuff in the CLI is not going to be common for most people. And about the extra keystrokes, boohoo. This is not a repository of code. This is a repository of documents that will likely be read right here on GitHub. Keeping the file names of the files as close as possible to nice human-readable English titles is the reason for my suggestion. |
|
"And about the extra keystrokes, boohoo." Rude 👅 Human readable is highly subjective. This is also potentially a repository of config files, which might follow mixed conventions and which might actually be cloned onto peoples machines. I know I'd clone this so I have one place to propagate changes to config files and cp to new projects etc.., |
|
I'd like to get more opinions, because I don't think this conversation is going anywhere. I'm totally willing to concede if I'm outvoted, but I don't you and I should decide for everybody. |
|
I like UpperCamelCase. It reduces the number of underscores, which are unsightly. Also, I'm not looking at these file names as variables, or even as program files in an application repo. Capitalizing the first letter is also nice because it's a title of a document, i.e. Coding Conventions, not coding Conventions. Coding_Conventions and Coding-Conventions are fine too I suppose. |
|
I talked to @kenkouot offline. I'm going to merge this as is. |
Reorganize files into subdirectories
|
@jnrbsn did you arm wrestle? |
I was going to make this part of #17, but I realized later that it should probably be separate.
@lizlux @justnpT @garthwebb @kenkouot