Skip to content

Conversation

@jnrbsn
Copy link
Contributor

@jnrbsn jnrbsn commented Apr 15, 2014

I was going to make this part of #17, but I realized later that it should probably be separate.

@lizlux @justnpT @garthwebb @kenkouot

@lizlux
Copy link
Contributor

lizlux commented Apr 15, 2014

👍

@kenkouot
Copy link
Contributor

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.

@jnrbsn
Copy link
Contributor Author

jnrbsn commented Apr 16, 2014

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)?

@garthwebb
Copy link
Contributor

I'm down down with the MW URL convention for file naming.

👍

@kenkouot
Copy link
Contributor

👎 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 snake_case or keep it as it is. For the sake of ubiquity and less gotchas, I strongly encourage not using the MW URL convention for our filenames.

The MW pattern is also double the keystrokes for delimiting word breaks.

@jnrbsn
Copy link
Contributor Author

jnrbsn commented Apr 16, 2014

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.

@kenkouot
Copy link
Contributor

"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..,

@jnrbsn
Copy link
Contributor Author

jnrbsn commented Apr 17, 2014

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.

@lizlux
Copy link
Contributor

lizlux commented Apr 17, 2014

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.

@jnrbsn
Copy link
Contributor Author

jnrbsn commented Apr 18, 2014

I talked to @kenkouot offline. I'm going to merge this as is.

jnrbsn added a commit that referenced this pull request Apr 18, 2014
Reorganize files into subdirectories
@jnrbsn jnrbsn merged commit 69c305d into master Apr 18, 2014
@jnrbsn jnrbsn deleted the jrobson-reorg branch April 18, 2014 17:33
@garthwebb
Copy link
Contributor

@jnrbsn did you arm wrestle?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants