CamelCase in filenames in doc/

[nikitadanilov]

For some reason, the style of file names in doc/ has been changed. E.g., coding-style.md became CodingStyle.md. Is there any reason for this? If not, please revert to the old style and use it for both existing and new files.

[johnbent]

Where is it documented the way that it should be?

---

From: Nikita Danilov notifications@github.com Sent: Sunday, May 10, 2020 7:33:39 AM To: Seagate/cortx cortx@noreply.github.com Cc: Subscribed subscribed@noreply.github.com Subject: [Seagate/cortx] CamelCase in filenames in doc/ (#7)

For some reason, the style of file names in doc/ has been changed. E.g., coding-style.md became CodingStyle.md. Is there any reason for this? If not, please revert to the old style and use it for both existing and new files.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHubhttps://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_Seagate_cortx_issues_7&d=DwMCaQ&c=IGDlg0lD0b-nebmJJ0Kp8A&r=9OKz58FWoBqvzbfOfhblug_f1x6fCy6IXlMMGcjo22s&m=Ys9enzCGIAytDUqTavJaO7gGa9dFVprApURQ8LOJceY&s=cjMwNas1KdYUmvs1A9YlnPWIPTcPtRdldaNlIEY-3-Q&e=, or unsubscribehttps://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_AAPT2PV4KQ7JMQWM7SRI3A3RQ2ULHANCNFSM4M5H3PIQ&d=DwMCaQ&c=IGDlg0lD0b-nebmJJ0Kp8A&r=9OKz58FWoBqvzbfOfhblug_f1x6fCy6IXlMMGcjo22s&m=Ys9enzCGIAytDUqTavJaO7gGa9dFVprApURQ8LOJceY&s=JbCS1gXcEVJQt9YcbbxDklVzDjDIEzcScLXcs4ThnRw&e=.

[johnbent]

Hey @nikitadanilov, we have this document: https://github.com/Seagate/cortx/blob/master/doc/CodeStyle.md But it does not say anything about how files should be named. Should we add something in there about how files should be all lower-case with '-' between words? And then do the renaming in this repository to follow accordingly?

[suykerbuyk]

On a side note, I'm pressing to have this be the "one" standard coding convention for the open-source releases projects I'm involved in. I've already connected Max and Muhammad Ahmed (CTO's office).

It would be nice if we disallowed camel case/snake case for most projects.

[johnbent]

So are we recommending kebab-case for our file names? https://medium.com/better-programming/string-case-styles-camel-pascal-snake-and-kebab-case-981407998841

[suykerbuyk]

I'd like to hear @max-seagate chime in.

[max-seagate]

As long as it's not in Mero master it shouldn't be an issue.

@nikitadanilov: Review before landing to master would catch this issue. Thanks for bringing this up.

[nikitadanilov]

doc/coding-style.md includes Linux kernel coding style by reference, and Linux kernel documentation is mostly in lower-case-with-dashes format (which is, by the way, the oldest naming style out there, going back to Lisp, early 60s). I think making it explicit is a good idea.

[max-seagate]

If we want style of all our documents to be uniform then I agree with @nikitadanilov, this should be fixed.

[johnbent]

@nikitadanilov and @max-seagate , please put any necessary requirements into doc/coding-style.md as I currently see nothing in it, nor in the Linux kernel coding style, about capitalization in file names.

[huanghua78]

I agree to use lower-case-with-dashes format. One of the benefits is that, on some file systems which are not case-sensitive, this will avoid name conflicts in a dir. For example, on MacOS, the default file system is not case-sensitive. Once I got a problem while checkout code from Esiwace project, because one directory has 'makefile' and 'Makefile' at the same time.

[justinzw]

Closing this as this is described in our coding style file.