Consider changing the file and directory naming scheme

jbranchaud / splitting-atoms

:dizzy_face: a community-built, community-driven guide to hacking on the Atom editor

http://jbranchaud.github.io/splitting-atoms/

MIT License

354 stars 29 forks source link

Consider changing the file and directory naming scheme #44

Closed tombell closed 9 years ago

tombell commented 10 years ago

Visually it's hard for someone browsing the repository to parse the camel cased file and directory names. I would consider something using hyphens or underscores to separate the words.

For example:

CustomizingAtomWithInit.md to customising_atom_with_init.md or Customising-Atom-With-Init.md

I feel it's a lot easier to read at a glance if you're looking for something, especially with some of the longer names.

jbranchaud commented 10 years ago

Thanks for the recommendation. I agree.

I personally prefer the hyphens. I will make a note somewhere (README.md or CONTRIBUTING.md) that suggests such a naming convention going forward.