search

oss-generic / process

The OSS-Generic Reference Process
https://oss-generic.github.io/process/
MIT License
6 stars 19 forks source link

File names convention: use camel case #88

Open damithc opened 7 years ago

damithc commented 7 years ago

The current convention is to use PascalCase for files and camelCase for folders. After using that convention for a while, I realized may be it is better to use camelCase for both. The reason is some 'default' files expected by other conventions (e.g. index.html) has a better chance of not conflicting with camelCase. Furthermore, I think it is more common for people to use all lower case letters for file names when the name has only one word (too lazy to press Shift key? :-p)

yamgent commented 7 years ago

The current convention is to use PascalCase for files and camelCase for folders.

I didn't realize that this is the current convention. :p

I agree that we should use camalCase for files. Right now our .md files, .xml files and .fxml files in addressbook have a mixture of PascalCase and camelCase, which is quite inconsistent.

The only exceptions I can think of right now would be:

  1. Java files where the filename has to match the class name.
  2. Standard expected filenames such as README.md.